patrickmaken/avlytext-client

There is no license information available for the latest version (v1.0.3) of this package.

PHP library for sending SMS using AvlyText API (https://avlytext.com)

v1.0.3 2021-08-16 07:19 UTC

This package is not auto-updated.

Last update: 2025-07-01 13:35:06 UTC


README

PHP library for sending SMS in any country using AvlyText API. Visit https://avlytext.com to create your account.

Requirement

You need php version >=5.5 to use this library

Installation

composer require patrickmaken/avlytext-client

Usage

Before any operation, you must get your api_key. This value are available in the "Developpers" menu of your customer panel on the platform: https://www.avlytext.com/en/webapp/developers.

Send SMS

use Patrickmaken\AvlyText\Client as AVTClient;

$api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';

$telephone = '+237699887766';
$text = 'This is a test message';
$senderID = 'MyApp';

$response = AVTClient::sendSMS($telephone, $text, $senderID, $api_key);
var_dump($response);

Output:

array(6) {
  ["id"]=>
  string(36) "0a069c28-1e75-4ad5-a352-ab02db2be1df"
  ["from"]=>
  string(5) "MyApp"
  ["to"]=>
  string(13) "+237699887766"
  ["cost"]=>
  float(0.022)
  ["parts"]=>
  int(1)
  ["status"]=>
  string(7) "pending"
}

Get SMS Status

use Patrickmaken\AvlyText\Client as AVTClient;

$api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';

$message_id = '0a069c28-1e75-4ad5-a352-ab02db2be1df';

$response = AVTClient::getMessageStatus($message_id, $api_key);
var_dump($response);

Output:

array(6) {
  ["id"]=>
  string(36) "0a069c28-1e75-4ad5-a352-ab02db2be1df"
  ["from"]=>
  string(5) "MyApp"
  ["to"]=>
  string(13) "+237699887766"
  ["cost"]=>
  float(0.022)
  ["parts"]=>
  int(1)
  ["status"]=>
  string(9) "delivered"
}

contacts