cecula/messaging-api

A library for consuming the Cecula Messaging API.

v1.0.2 2024-09-10 07:07 UTC

Requires

• php: >=7.4
• guzzlehttp/guzzle: ^7.9
• monolog/monolog: ^3.7

MIT

• Godwin Noah

README

Cecula API Client is a simple client for connecting your PHP application to Cecula Messaging platform to send SMS via A2P channel or your hosted sim.

Methods

• sendSms(array $data) Send an SMS to a single or multiple recipients.

Data Array Keys:

• recipients (array): An array of recipients' mobile numbers.
• text (string): Message content.
• sender (string): Pre-registered sender name.

Sample

$data = [
            'sender' => 'SENDER', // Note: this has to be pre-registered and approved
            'recipients' => ['2348XXXXXXXXX', '2348XXXXXXXXX'],
            'text' => 'Happy for another day',
        ];

Response: Status of the message delivery. sendBulkMessage(array $recipients, $message) Send SMS to multiple recipients.

Parameters: $recipients (array): List of phone numbers. $message (string): Message content. Response: Status of the bulk message delivery. getBalance() Retrieve the available balance for sending SMS.

Response: Current SMS balance on the Cecula platform.

How to Use

Import Cecula API Client to your application using composer.

composer require cecula/messaging-api

Once the library is imported to your application ensure all dependencies are installed by running

composer install

and you're ready to go.

Get Your Cecula API Key

To get your Cecula API Key, login to the Cecula Messaging Platform. If you do not already have an account you can create one right now.

Once you've logged in to your account, navigate to the Settings menu and that should be the first thing you see. Copy the Live or Sandbox API Key.

Test the Library

Having retrieved your API key, you are now ready to test run the library.

In a Procedural PHP Script

<?php

use Cecula\MessagingApi\Messaging;

require_once __DIR__.'/vendor/autoload.php';

$messagingClient = new Messaging([
    'apiKey' => 'paste-your-api-key-here'
]);

echo $messagingClient->getBalance();

$smsParams = [
    'sender' => 'SENDER', // Note: this has to be pre-registered and approved
    'recipients' => ['2348XXXXXXXXX'],
    'text' => 'Happy for another day',
];

echo $messagingClient->sendSms($smsParams);

Inside a Class File

What you'll likely be working with if using a framework like Laravel

<?php

use Cecula\MessagingApi\Messaging;

class ClassName
{
    public function doSomething()
    {
        $messagingClient = new Messaging([
            'apiKey' => 'paste-your-api-key-here'
        ]);

        echo $messagingClient->getBalance();

        $smsParams = [
            'sender' => 'SENDER', // Note: this has to be pre-registered and approved
            'recipients' => ['2348XXXXXXXXX'],
            'text' => 'Happy for another day',
        ];

        echo $messagingClient->sendSms($smsParams);
    }
}

You get it! Now adapt this and build messaging into your app.

If you get stuck, push a mail to [e-mail] - we'll get you back on dry codeland.

Cheers!!!