Get message by ID
Look up a single message with the messageid that was returned when sending.
This works for single sends and for group sends. Public IDs are accepted as well:
lid_... for a single message, cnv_... for a grouped send.
Base URL:
GET: https://api.smsgatewayapi.com/v1/message/{messageID}Example:
GET: https://api.smsgatewayapi.com/v1/message/h2md1ewkyzjkuyn9ak7pryw1evtyw3x
| 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 |
| messageID | message ID | The messageid returned when sending, or a public ID (lid_... / cnv_...) | Required |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/message/{messageID}";
$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 (single message):
{
"message": {
"ID": 19951477,
"public_ID": "lid_46f4c0e37652d4149352e1cb54fed50b",
"message_ID": "dhnwkj8adbz646o5b4y3ureut1l6eq",
"message": "Hello World",
"to": "{nr}",
"sender": "YourName",
"customer_reference": null,
"date": "2026-08-01 11:24:02",
"date_iso8601": "2026-08-01T11:24:02+02:00",
"date_utc": "2026-08-01 09:24:02",
"date_utc_iso8601": "2026-08-01T09:24:02+00:00",
"type": "single",
"message_length": 1,
"message_cost": 1,
"message_cost_currency": "credits",
"memo": null,
"unicode": 0,
"status": "DELIVERED",
"status_date": "2026-08-01 11:24:05",
"status_date_iso8601": "2026-08-01T11:24:05+02:00",
"status_date_utc": "2026-08-01 09:24:05",
"status_date_utc_iso8601": "2026-08-01T09:24:05+00:00",
"response": {
"read": true,
"read_date": "2026-08-01 11:27:37",
"response": "Example response"
}
}
}
Example success response (group send):
{
"message": {
"ID": 1234567,
"public_ID": "cnv_3520a1ec234dbabe1232def67e858855",
"message_ID": "h2md1ewkyzjkuyn9ak7pryw1evtyw3x",
"message": "Hello [FIRSTNAME]",
"to": "marketing",
"sender": "YourName",
"customer_reference": null,
"date": "2026-08-01 11:24:02",
"date_iso8601": "2026-08-01T11:24:02+02:00",
"date_utc": "2026-08-01 09:24:02",
"date_utc_iso8601": "2026-08-01T09:24:02+00:00",
"amount": 250,
"type": "group",
"message_length": 1,
"message_cost": 250,
"message_cost_currency": "credits",
"memo": null,
"unicode": 0,
"status": "MIXED",
"status_date": "2026-08-01 11:26:11",
"status_date_iso8601": "2026-08-01T11:26:11+02:00",
"status_date_utc": "2026-08-01 09:26:11",
"status_date_utc_iso8601": "2026-08-01T09:26:11+00:00",
"response": {},
"delivery_summary": {
"total": 250,
"delivered": 248,
"failed": 2,
"pending": 0,
"unknown": 0,
"statuses": {
"DELIVERED": 248,
"UNDELIVERED": 2
},
"message_length": 1,
"message_cost": 250,
"message_cost_currency": "credits",
"last_status_date": "2026-08-01 11:26:11"
}
}
}
Response when the message ID doesn’t exist: http status code 404 (Not Found).
