Search contact
Base URL:
GET: https://api.smsgatewayapi.com/v1/contact/search/{keyword}
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Advanced' - 'API authentication' 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/contact/search/{keyword}";
$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 success response:
{
"total": 10,
"shown": 10,
"page": 1,
"limit": 1000,
"contacts": [
{
"ID": "{ID}",
"phone": "{nr}",
"firstname": "John",
"lastname": "Doe",
"extra1": "Marketing",
"extra2": "",
"extra3": "",
"extra4": "",
"extra5": "",
"extra6": "",
"extra7": "",
"extra8": "",
"unsubscribed": false,
"birthday": "1997-03-23"
},
{
"ID": "{ID}",
"phone": "{nr}",
"firstname": "Jane",
"lastname": "Doe",
"extra1": "Marketing",
"extra2": "Building 2B",
"extra3": "",
"extra4": "",
"extra5": "",
"extra6": "",
"extra7": "",
"extra8": "",
"unsubscribed": false,
"birthday": null
}, ...
]
}
