Get group
Base URL:
GET: https://api.smsgatewayapi.com/v1/groups/{ID}Example:
GET: https://api.smsgatewayapi.com/v1/groups/115113
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Developer' - 'API & Webhooks' - 'API-credentials' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Developer' - 'API & Webhooks' - 'API-credentials' to find the API keys | Required |
| limit | Maximum results per page | Default up to 1000, can't be bigger than 2000 | Optional |
| page | Page of results | Default up to 1 | Optional |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/groups/{ID}";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
curl_setopt($ch, CURLOPT_URL, "$url");
curl_setopt($ch, CURLOPT_POST, false);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_VERBOSE, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"X-Client-Id: $client_id",
"X-Client-Secret: $client_secret",
"Content-Type: application/json",
]);
$response = curl_exec($ch);
?>
Example response single:
{
"ID": [ {id} ],
"public_ID": [ "{public_id}" ]
}
Example response multiple:
{
"IDs": [ {id1}, {id2}, ...],
"public_IDs": [ "{public_id1}", "{public_id2}", ... ]
}
Example success response:
{
"groupinfo": {
"ID": "115165",
"public_ID": "gid_3520a1ec234dbabe1232def67e858855",
"name": "ln"
},
"total": 24,
"shown": 24,
"page": 1,
"limit": 1000,
"contacts": [
{
"ID": "{ID}",
"public_ID": "{public_ID}",
"phone": "{nr}",
"firstname": "John",
"lastname": "Doe",
"extra1": "Marketing",
"extra2": "",
"extra3": "",
"extra4": "",
"extra5": "",
"extra6": "",
"extra7": "",
"extra8": "",
"unsubscribed": false,
"birthday": "1997-03-23"
},
{
"ID": "{ID}",
"public_ID": "{public_ID}",
"phone": "{nr}",
"firstname": "Jane",
"lastname": "Doe",
"extra1": "Marketing",
"extra2": "Building 2B",
"extra3": "",
"extra4": "",
"extra5": "",
"extra6": "",
"extra7": "",
"extra8": "",
"unsubscribed": false,
"birthday": null
}, ...
]
}
