Get inbox messages from a specific inbox number
Base URL:
GET: https://api.smsgatewayapi.com/v1/message/inbox/{inbox_nr}Example:
GET: https://api.smsgatewayapi.com/v1/message/inbox/32460123456
| 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 |
| type | Message type | Possbile value's are sms, whatsapp or call | Optional |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/message/inbox/{inbox_nr}";
$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": 20,
"shown": 20,
"page": 1,
"limit": 1000,
"messages": [
{
"ID": "{ID}",
"public_ID": "inb_46f4c0e37652d4149352e1cb54fed50b",
"message": "Hello sms",
"sender": "{nr}",
"type": "sms",
"date": "2024-01-01 12:00:00"
},
{
"ID": "{ID}",
"public_ID": "inb_c6dab1d038504ac910f1254f20383622",
"message": "Hello whatsapp",
"sender": "{nr}",
"type": "whatsapp",
"date": "2024-01-02 12:00:00"
},
{
"ID": "{ID}",
"public_ID": "inb_7ecad8b1a486b73732b897fde12f080c",
"message": "Incoming VOIP Call - Forwarded to {callforwarding_nr}",
"sender": "{nr}",
"type": "call",
"date": "2024-01-03 12:00:00"
},
...
]
}
