Giving You Actionable Analytics
Start building for free

Delivery Log

The Messaging API allows businesses send text messages to their customers. The API accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes. A single channel represent an individual messaging channel eg. sms, email, etc. This API allows businesses send text messages to their customers across any of these single channels.


API URL V1:

https://api.helliomessaging.com/v1/delivery-logs?


Request Method: MATCH (Either POST or GET)


Content-Type: application/json

Request Parameters

Attribute Type Description Required
username String Your Hellio username Required
password String Your Hellio password Required
startDate Integer e.g. 01-01-2012 Required
endDate Integer e.g. 01-01-2020 Required
senderId String The senderId used for that particular campaign you wish to query Optional
deliveryStatus String Kindly use any of these statuses [ ACK/, DELIVRD, UNDELIV, FAILED, EXPIRED ] Optional

PHP Sample Code Overview


        $baseUrl = 'https://api.helliomessaging.com/v1/delivery-logs?';


        $username = 'YOUR-HELLIO-MESSAGING-USERNAME';
        $password = 'YOUR-HELLIO-MESSAGING-PASSWORD';
        $startDate = 'e.g. 01-01-2012';
        $endDate = 'e.g. 01-01-2020';
        $senderId = 'HellioSMS';
        $deliveryStatus = 'UNDELIV'; //The status could be any of these: ACK/, DELIVRD, UNDELIV, FAILED, EXPIRED

        $params = array(
        'username' => $username,
        'password' => $password,
        'startDate' => $startDate,
        'endDate' => $endDate,
        'senderId' => $senderId,
        'deliveryStatus' => $deliveryStatus,
        );

        // Send through CURL
        $ch = curl_init($baseUrl);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        // Process your response here
        $result = curl_exec($ch);
        echo var_export($result, true);
        curl_close($ch);

Response Object


        {
        "responseCode": 200,
        "message": [
        {
        "msgid": "88e3bae1-bc3c-46e0-88cd-9dfb3d899a7f",
        "submit_date": "2020-08-26 15:06:15",
        "msisdn": "233244623889",
        "sender": "HellioSMS",
        "network": "MTN",
        "sms_count": 3,
        "sms_price": 0.0.348,
        "message":"Thank God! Its been hot in here... Thanks for letting me out of this code.",
        "status": "DELIVRD",
        "delivery_date": "2020-08-26 15:06:27"
        }
        ],
        "status": "success"
        }