Easily Manage Your
Contacts With Us
Start building for free

Contacts API Reference

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/contacts?


Available HTTP methods: POST


Version: v1


Content-Type: application/json

Request Parameters

Parameter Type Description Required
username String Your Hellio username Required
password String Your Hellio password Required
firstName String First name Required
lastName String Last name Required
groupId Integer The ID of the group you wish to add the contact to Required

PHP Sample Code Overview


$baseUrl = 'https://api.helliomessaging.com/v1/contacts?';

$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


{
"id": "61afc0531573b08ddbe36e1c85602827",
"href": "https://api.helliomessaging.com/v1/contacts/61afc0531573b08ddbe36e1c85602827",
"msisdn": 31612345678,
"firstName": "John",
"lastName": "Doe",
"customDetails": {
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": ""
},
"groups": {
"totalCount": 0,
"href": "https://api.helliomessaging.com/v1/contacts/61afc0531573b08ddbe36e1c85602827/groups"
},
"messages": {
"totalCount": 0,
"href": "https://api.helliomessaging.com/v1/contacts/61afc0531573b08ddbe36e1c85602827/messages"
},
"createdDatetime": "2016-04-29T09:42:26+00:00",
"updatedDatetime": "2016-04-29T09:42:26+00:00"
}