Messages
The messages resource allows you to Retrieve messages. The following action can be performed on this resource...
Retrieve All Messages
Retrieves all messages associated with your brand.
GET https://dev.slicktext.com/v1/brands/{{brand_id}}/messages
You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will return messages with a status of "delivered".
GET https://dev.slicktext.com/v1/brands/{{brand_id}}/messages?status=delivered
Query Parameters
| PARAMETER | DESCRIPTION |
|---|---|
| status | The status of the message. Some possible values are delivered, undelivered, processed, etc. |
| source | The source of the message. Some possible values are Campaign, Keyword, InboxThread, API, etc. |
| source_id | The ID of the source associated with the message. For example, if the source is a campaign, this would be the campaign ID. |
| direction | The direction of the message. Possible values are incoming or outgoing. |
Example Response:
{
"data":
[
{
"_id": "675c4b6b7ffc11b8b1044bf2",
"to": "+16155553338",
"from": "+16255553331",
"body": "This is a test message.",
"direction": "outgoing",
"channel": "sms",
"source": "Campaign",
"_source_id": 115,
"is_gsm": 1,
"message_credits": 1,
"campaign_completion_percentage": 50,
"text_number": {
"_brand_id": 16,
"text_number_id": 12,
"type": "tollFree",
"registration_status": "registered"
},
"brand": {
"brand_id": 123456789
},
"contact": {
"contact_id": 5320593
},
"user": {
"user_id": 123643
},
"status": "delivered",
"created": "2024-12-13 14:57:47",
"created_micro": 1734101867.4758,
"updated": "2024-12-13 14:57:49"
}
],
"pagingData": {
"prevPage": null,
"currentPage": null,
"nextPage": null,
"currentPageString": null,
"hasMore": false
}
}