A PHP API wrapper for Zigatext. This library helps to easily integrate Zigatext Messaging Platform into your PHP project.
- Curl 7.34.0 or latest (Unless using Guzzle)
- PHP 5.4.0 or latest
- OpenSSL v1.0.1 or latest
$ composer require kemonai/zigatext-phpDownload a release version from the releases page. Extract, then:
require 'path/to/src/autoload.php';This is the first implementation of Zigatext API version 1.
Instantiate Zigatext class and pass you ACCESS-KEY as an argument to the construct. Then you can can start calling resource methods to fulfill your requests
Confirm that your server can conclude a TLSv1.2 connection to Zigatext's servers. Most up-to-date software have this capability. Contact your service provider for guidance if you have any SSL errors.
When you submit message for sending our server queue's the message for delivery and after delivery your callback url is called to notify your system/website that your message has been sent.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->message->send(['sender' => 'php lib',
'message' => 'it is awesome',
'recipients' => '23470xxxxxxxx',
'use_corporate_route' => true, // [true or false]
'callback_url' => 'https://your-website/your-callback-url',
]);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}senderis your custom name/title for your message and is should not exceed 11 characters (space is also counted as character)recipientsis the phone number(s) you are sending message tomessageis the content you want to send to your recipient(s)use_corporate_routecan either be true or false. Value 'true' means that you want your message delivers to Do-Not-disturb (DND) numbers for countries that has dnd policycallback_urlWhen you submit message for sending our server queue's the message for delivery and after delivery your callback url is called to notify your system/website that your message has been sent. Then you can use the message id passed as query string to retrieve delivery details. This parameter is optional in case you don't want to receive callback.
Most of the parameter are the same with send method above. Before scheduling message you need to include time_zone_id, call $zigatext->timezone->list(); for the list of time zones and their ids.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->message->schedule(['sender' => 'php lib',
'message' => 'it is awesome',
'recipients' => '23470xxxxxxxx',
'use_corporate_route' => true,
'callback_url' => 'https://your-website/your-callback-url',
'extras' => [[
'deliver_at' => '2019-07-23 10:10',
'time_zone_id' => 2,
]]]);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}extrasaccepts arrays of delivery times, in case you want your scheduled message to deliver at different times.time_zone_idYou can call our time zone endpoint to get list of timezones and their ids. It's used to set at what timezone you want your scheduled message to delivery to your recipient(s).
To add subscriber from your system/website to your Newsletter list, first login to your Zigatext dashboard and create the newsletter list. Next call Newsletter $zigatext->newsletter->list(); to pull your list with their ids.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->newsletter->addSubscriber([
'id' => 2, //sms newsletter id
'name' => 'Chibuike Mba',
'phone_no' => '23470xxxxxxxx']);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}This is same as adding single subscriber but in this case you add multiple subscribers at once.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->newsletter->addBulkSubscribers([
'id' => 2, //sms newsletter id
'subscribers' => [
[
'name' => 'Benjamin Akawu',
'phone_no' => '23470xxxxxxxx'
],
[
'name' => 'Franklin Nnakwe',
'phone_no' => '23480xxxxxxxx'
]
]
]);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}To add contact from your system/website to your birthday group, first login to your Zigatext dashboard and create the birthday group. Next call Birthday $zigatext->birthday->getGroupList(); to pull your groups with their ids and $zigatext->month->list(); for months ids.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->birthday->addContactToGroup([
'group_id' => 7,
'name' => 'Dennis Okonnachi',
'phone_no' => '23470xxxxxxxx',
'day' => 9,
'month_id' => 1,
]);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}This is same as adding single contact but in this case you add multiple contacts at once.
$zigatext = new Kemonai\Zigatext(ACCESS-KEY);
try
{
$response = $zigatext->birthday->addBulkContactsToGroup([
'group_id' => 7,
'contacts' => [
[
'name' => 'Caleb Uche',
'phone_no' => '23470xxxxxxxx',
'day' => 9,
'month_id' => 1,
],
[
'name' => 'Bernard Inyang',
'phone_no' => '23480xxxxxxxx',
'day' => 19,
'month_id' => 3,
]
]
]);
var_dump($response);
} catch(\Kemonai\Zigatext\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}Generally, to make an API request after constructing a Zigatext object, Make a call
to the resource/method thus: $zigatext->{resource}->{method}(); for gets,
use $zigatext->{resource}(id) and to list resources: $zigatext->{resource}s().
Currently, we support: 'message', 'newsletter', 'birthday', 'month', 'balance' and 'timezones'. Check our API reference([link-zigatext-api-reference][link-zigatext-api-reference]) for the methods supported. To specify parameters, send as an array.
Check SAMPLES for more sample calls.
This class helps you build valid json metadata strings to be sent when making transaction requests.
$builder = new MetadataBuilder();To turn off automatic snake-casing of Key names, do:
MetadataBuilder::$auto_snake_case = false;before you start adding metadata to the $builder.
Finally call build() to get your JSON metadata string.
Please see CHANGELOG for more information what has changed recently.
$ composer testPlease see CONTRIBUTING and CONDUCT for details. Check our todo list for features already intended.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
- Kemonai Technologies
- Chibuike Mba
- Caleb Uche
- Yabaconn - followed the style he employed in creating the Paystack PHP Wrapper
- All Contributors
The MIT License (MIT). Please see License File for more information.