A Laminas PHP framework/Zend Framework 3 module for Ozioma API.
- Curl 7.34.0 or more recent (Unless using Guzzle)
- PHP 5.4.0 or more recent
- OpenSSL v1.0.1 or more recent
Installation of OziomaLaminas uses composer. For composer documentation, please refer to getcomposer.org.
$ composer require chibex/ozioma-laminasThen add Chibex\Ozioma to your config/modules.config.php
Installation without composer is not officially supported, and requires you to install and autoload
the dependencies specified in the composer.json.
This Laminas PHP framework/Zend Framework 3 module is a wrapper for Ozioma PHP Library
Create config/autoload/ozioma.global.php then copy and paste below code into the file, replace your access key. See guide on how to generate project's access key and fund it click here
return [
'ozioma' => [
'third-party' => [
'access-key' => 'YOUR ACCESS KEY HERE',
],
],
];Confirm that your server can conclude a TLSv1.2 connection to Ozioma's servers. Most up-to-date software have this capability. Contact your service provider for guidance if you have any SSL errors.
This module has oziomaClient controller plugin which can be access like this $this->oziomaClient() in your controllers. This controller plugin will return instance of Chibex\Ozioma\Service\OziomaClientManager service which implements all methods for invoking Ozioma API resources.
Note that you can fund each of your projects with units separately and when project units exhausted it will not eat into your main balance. This method returns units balance for project access key suplied.
try {
$response = $this->oziomaClient()->getBalance();
var_dump($response);
} catch(\Chibex\Ozioma\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}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.
try {
$response = $this->oziomaClient()->send(['sender' => 'php lib',
'message' => 'it is awesome',
'recipients' => '23470xxxxxxxx',
'use_corporate_route' => true, // [true or false]
'callback_url' => 'http://your-website/your-callback-url',
]);
var_dump($response);
} catch(\Chibex\Ozioma\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_routecant 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
When you submit message for sending an id is returned, you can use the returned id to pull the message details.
try {
$response = $this->oziomaClient()->fetchSentMessage($id);
var_dump($response);
} catch(\Chibex\Ozioma\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}To get the recipients, units charged and delivery status of send a sent message, use this method the sent message id.
try {
$response = $this->oziomaClient()->fetchSentMessageExtras($id);
var_dump($response);
} catch(\Chibex\Ozioma\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}Most of the parameter are the same with send method above. Before scheduling message you need to include time_zone_id, call $this->oziomaClient()->listTimeZones() for the list of time zones and their ids.
try {
$response = $this->oziomaClient()->schedule(['sender' => 'php lib',
'message' => 'it is awesome',
'recipients' => '23470xxxxxxxx',
'use_corporate_route' => true,
'callback_url' => 'http://your-website/your-callback-url',
'extras' => [[
'deliver_at' => '2019-07-23 10:10',
'time_zone_id' => 2,
]]]);
var_dump($response);
} catch(\Chibex\Ozioma\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 Ozioma dashboard and create the newsletter list. Next call Newsletter $this->oziomaClient()->newsletterList(); to pull your list with their ids
try {
$response = $this->oziomaClient()->addSubscriber([
'id' => 2, //sms newsletter id
'name' => 'Chibuike Mba',
'phone_no' => '23470xxxxxxxx']);
var_dump($response);
} catch(\Chibex\Ozioma\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
try {
$response = $this->oziomaClient()->addBulkSubscribers([
'id' => 2, //sms newsletter id
'subscribers' => [[
'name' => 'Izuchukwugeme Okafor',
'phone_no' => '23470xxxxxxxx'
],[
'name' => 'Franklin Nnakwe',
'phone_no' => '23480xxxxxxxx'
]]]);
var_dump($response);
} catch(\Chibex\Ozioma\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 Ozioma dashboard and create the birthday group. Next call Birthday $this->oziomaClient()->birthdayGroupList(); to pull your groups with their ids
try {
$response = $this->oziomaClient()->addBirthdayContactToGroup([
'group_id' => 7, //birthday group id
'name' => 'Dennis Okonnachi',
'phone_no' => '23470xxxxxxxx',
'day' => 9,
'month_id' => 1,
]);
var_dump($response);
} catch(\Chibex\Ozioma\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
try {
$response = $this->oziomaClient()->addBulkBirthdayContactsToGroup([
'group_id' => 7, //birthday group id
'contacts' => [[
'name' => 'Caleb',
'phone_no' => '23470xxxxxxxx',
'day' => 9,
'month_id' => 1,
]]]);
var_dump($response);
} catch(\Chibex\Ozioma\Exception\ApiException $e){
print_r($e->getResponseObject());
die($e->getMessage());
}Currently, we support: 'message', 'newsletter', 'birthday', 'month', 'balance' and 'timezones'. Check our API reference(link-ozioma-api-reference) for the methods supported. To specify parameters, send as an array.
Please see CHANGELOG for more information what has changed recently.
Please 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.
The MIT License (MIT). Please see License File for more information.