Download the PHP package chibex/ozioma-php without Composer
On this page you can find all versions of the php package chibex/ozioma-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chibex/ozioma-php
More information about chibex/ozioma-php
Files in chibex/ozioma-php
Package ozioma-php
Short Description Ozioma for PHP library helps to make API calls to Ozioma Cloud Messaging and Communications Platform for birthday contact and sms newsletter subscription.
License MIT
Homepage https://ozioma.net
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ozioma-php
ozioma-php
A PHP API wrapper for Ozioma.
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
Via Composer
Via download
Download a release version from the releases page. Extract, then:
IMPORTANT
This is the first implementation of Ozioma API version 2.
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
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
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.
send method parameters
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
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.
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)
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
4. Add Subscribers to your Newsletter list
This is same as adding single subscriber but in this case you add multiple subscribers at once
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
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
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) for the methods supported. To specify parameters, send as an array.
Check SAMPLES for more sample calls
MetadataBuilder
This class helps you build valid json metadata strings to be sent when making transaction requests.
Add metadata
To turn off automatic snake-casing of Key names, do:
before you start adding metadata to the $builder.
Build JSON
Finally call build() to get your JSON metadata string.
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see todo list for features already intended.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Chibex Technologies
- Chibuike Mba
- Yabaconn - followed the style he employed in creating the Paystack PHP Wrapper
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
