Get a conversation
Get a conversation with a number.
Base URL:
GET: https://api.smsgatewayapi.com/v1/conversation/{phone}Example:
GET: https://api.smsgatewayapi.com/v1/conversation/32470123456
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Developer › API & Webhooks › API credentials | Required |
| client_secret | API client secret | A cs_ credential, shown once when you create it under Developer › API & Webhooks › API credentials | Required |
| phone | The telephone number | 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/conversation/{phone}";
$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": 2,
"shown": 2,
"page": 1,
"limit": 1000,
"conversation": [
{
"messageId": "{messageId}",
"publicMessageId": "lid_46f4c0e37652d4149352e1cb54fed50b",
"direction": "outbound",
"sender": "Sender",
"receiver": "{receiver}",
"message": "Outbound message",
"file": null,
"datetime": "05 jun 2025, 08:44:46",
"unixDatetime": 1749113086,
"deliveryStatus": "DELIVERED",
"outboxPublicId": null
},
{
"messageId": null,
"publicMessageId": "inb_7ecad8b1a486b73732b897fde12f080c",
"direction": "inbound",
"sender": "{receiver}",
"receiver": "Sender",
"message": "Inbound message",
"file": [
{
"name": "{image_name}",
"image": "{image_url}",
"mime": "image/"
}
],
"datetime": "28 may 2025, 09:26:58",
"unixDatetime": 1748424418,
"deliveryStatus": "DELIVERED",
"outboxPublicId": null
},
...
]
}
If 'mine' is true the message was send from smstools, if it's false the message was send from the specified number.
