Get outbox
Base URL:
GET: https://api.smsgatewayapi.com/v1/outbox
| 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/outbox"; $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": 50,
"shown": 50,
"page": 1,
"limit": 1000,
"messages": [
{
"ID": "{ID}",
"public_ID": "cam_9b56720c7adc4c78a04d62521d1d3b09",
"message": "Reminder meeting 2 pm",
"to": "{nr}",
"type": "single",
"date": "11/10/2024/10/30",
"refence": null,
"messageid": "{msgid}"
},
{
"ID": "{ID}",
"public_ID": "cam_46f4c0e37652d4149352e1cb54fed50b",
"message": "Hapy birthday [FIRSTNAME]!",
"to": "{nr}",
"type": "voice",
"date": "13/03/2024/10/30",
"refence": null,
"messageid": "{msgid}"
}, ...
]
}
