PHPackages chibex/ozioma-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Queues & Workers](/categories/queues) 4. / 5. chibex/ozioma-php ActiveLibrary[Queues & Workers](/categories/queues) chibex/ozioma-php ================= Ozioma for PHP library helps to make API calls to Ozioma Cloud Messaging and Communications Platform for birthday contact and sms newsletter subscription. v1.0.1(6y ago)010411MITPHPCI failing Since Aug 30Pushed 6y ago1 watchersCompare [ Source](https://github.com/chibex-tech/ozioma-php)[ Packagist](https://packagist.org/packages/chibex/ozioma-php)[ Docs](https://ozioma.net)[ RSS](/packages/chibex-ozioma-php/feed)WikiDiscussions master Synced 2d ago READMEChangelog (2)Dependencies (5)Versions (3)Used By (1) ozioma-php ========== [](#ozioma-php) [![Latest Version on Packagist](https://camo.githubusercontent.com/34b6e7913ffa72119b0a068e759563c31ca300daa5cef221955dbf16c0fc2c36/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6368696265782f6f7a696f6d612d7068702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/chibex/ozioma-php)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/e6d63960f8f817c34eed091e1af8e890de93b3715ff5d577d1450d73b8d60d90/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6368696265782f6f7a696f6d612d7068702e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/chibex/ozioma-php) A PHP API wrapper for [Ozioma](https://ozioma.net/). [![Ozioma](img/ozioma.png?raw=true "Ozioma")](https://ozioma.net/) Requirements ------------ [](#requirements) - Curl 7.34.0 or more recent (Unless using Guzzle) - PHP 5.4.0 or more recent - OpenSSL v1.0.1 or more recent Install ------- [](#install) ### Via Composer [](#via-composer) ``` $ composer require chibex/ozioma-php ``` ### Via download [](#via-download) Download a release version from the [releases page](https://github.com/chibex-tech/ozioma-php/releases). Extract, then: ``` require 'path/to/src/autoload.php'; ``` IMPORTANT --------- [](#important) This is the first implementation of Ozioma API version 2. Usage ----- [](#usage) Instantiate Ozioma class and pass you ACCESS-KEY as an argument to the construct. Then you can can start calling resource methods to fulfill your requests ### 0. Prerequisites [](#0-prerequisites) 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. ### 1. Initiate sending message [](#1-initiate-sending-message) 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. ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->message->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()); } ``` #### send method parameters [](#send-method-parameters) - `sender` is your custom name/title for your message and is should not exceed 11 characters (space is also counted as character) - `recipients` is the phone number(s) you are sending message to - `message` is the content you want to send to your recipient(s) - `use_corporate_route` cant 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 policy - `callback_url` 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. 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 ### 2. Scheduling message [](#2-scheduling-message) Most of the parameter are the same with `send` method above. Before scheduling message you need to include `time_zone_id`, call `$ozioma->timezone->list();` for the list of time zones and their ids. ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->message->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()); } ``` - `extras` accepts arrays of delivery times, in case you want your scheduled message to deliver at different times. - `time_zone_id` You 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) ### 3. Add Subscriber to your Newsletter list [](#3-add-subscriber-to-your-newsletter-list) 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 `$ozioma->newsletter->list();` to pull your list with their ids ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->newsletter->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()); } ``` ### 4. Add Subscribers to your Newsletter list [](#4-add-subscribers-to-your-newsletter-list) This is same as adding single subscriber but in this case you add multiple subscribers at once ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->newsletter->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()); } ``` ### 5. Add Birthday Contact to your Birthday group [](#5-add-birthday-contact-to-your-birthday-group) 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 `$ozioma->birthday->getGroupList();` to pull your groups with their ids and `$ozioma->month->list();` for months ids ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->birthday->addContactToGroup([ 'group_id' => 7, '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()); } ``` ### 6. Add Birthday Contacts to your Birthday group [](#6-add-birthday-contacts-to-your-birthday-group) This is same as adding single contact but in this case you add multiple contacts at once ``` $ozioma = new Chibex\Ozioma(ACCESS-KEY); try { $response = $ozioma->birthday->addBulkContactsToGroup([ 'group_id' => 7, '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()); } ``` 7. Closing Notes ---------------- [](#7-closing-notes) Generally, to make an API request after constructing a ozioma object, Make a call to the resource/method thus: `$ozioma->{resource}->{method}()`; for gets, use `$ozioma->{resource}(id)` and to list resources: `$ozioma->{resource}s()`. Currently, we support: 'message', 'newsletter', 'birthday', 'month', 'balance' and 'timezones'. Check our API reference([link-ozioma-api-reference](https://ozioma.net/api/docs)) for the methods supported. To specify parameters, send as an array. Check [SAMPLES](SAMPLES.md) for more sample calls ### MetadataBuilder [](#metadatabuilder) This class helps you build valid json metadata strings to be sent when making transaction requests. ``` $builder = new MetadataBuilder(); ``` #### Add metadata [](#add-metadata) To turn off automatic snake-casing of Key names, do: ``` MetadataBuilder::$auto_snake_case = false; ``` before you start adding metadata to the `$builder`. #### Build JSON [](#build-json) Finally call `build()` to get your JSON metadata string. Change log ---------- [](#change-log) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Testing ------- [](#testing) ``` $ composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CONDUCT](.github/CONDUCT.md) for details. Check our [todo list](TODO.md) for features already intended. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Chibex Technologies](https://github.com/chibex-tech) - [Chibuike Mba](https://github.com/chibexme) - [Yabaconn](https://github.com/yabacon/paystack-php) - followed the style he employed in creating the [Paystack PHP Wrapper](https://github.com/yabacon/paystack-php) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 28 — LowBetter than 52% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community10 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~193 days Total 2 Last Release 2302d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/30c48b198a9b411cca10709abb49082ef89c473765b2de4304d310fa1f1f5ccb?d=identicon)[chibexme](/maintainers/chibexme) --- Top Contributors [![chibexme](https://avatars.githubusercontent.com/u/5671057?v=4)](https://github.com/chibexme "chibexme (6 commits)") --- Tags birthdaybirthday-contactbirthday-messagebirthday-smsbulksmschibexcontactmessagemessagingnewsletteroziomaozioma-phpsmssms-apisms-gatewai-apisms-messagessms-newslettersmscsubscribermessageapismsmessagingcontactsubscribernewsletterbulk-smsbirthdaychibexozioma-phpoziomabirthday contactbirthday smsbirthday messagesms newsletter ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/chibex-ozioma-php/health.svg) ``` [![Health](https://phpackages.com/badges/chibex-ozioma-php/health.svg)](https://phpackages.com/packages/chibex-ozioma-php) ``` ### Alternatives [traderinteractive/mongo-queue Message queue using MongoDB as a backend 4618.5k](/packages/traderinteractive-mongo-queue) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)