Groups API Reference
Hellio Messaging's Groups API allows you to manage contact groups that are identified
by a unique
random ID. Use this ID to create, view, update or delete groups.
The Groups API uses HTTP verbs and a RESTful endpoint structure with an access key
that is used as the
API Authorization framework. Request and response payloads are formatted as
JSON—although we provide a
GET alternative for requests—using UTF-8 encoding and URL encoded values.
API URL V1:
https://api.helliomessaging.com/v1/groups/create?
Available HTTP methods: POST
Content-Type: application/json
PHP Sample Code Overview
$baseUrl = 'https://api.helliomessaging.com/v1/groups?';
$username = 'YOUR-HELLIO-MESSAGING-USERNAME';
$password = 'YOUR-HELLIO-MESSAGING-PASSWORD';
$name = 'groupname';
$params = array(
'username' => $username,
'password' => $password,
'groupName' => $name,
);
// 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/groups/61afc0531573b08ddbe36e1c85602827",
"name": "Home",
"contacts": {
"totalCount": 0,
"href": "https://api.helliomessaging.com/v1/groups/61afc0531573b08ddbe36e1c85602827/contacts"
},
"createdDatetime": "2016-04-29T09:42:26+00:00",
"updatedDatetime": "2016-04-29T09:42:26+00:00"
}