Inbound Messages
List Inbound Messages
Gets the list of all Inbound Messages, optionally filtered by parameters. This method supports pagination.
AuthorizationBasic <token>
Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.
In: header
Query Parameters
From?string
Sender phone number
To?string
Recipient phone number
CreatedOnFrom?string
Date-time, that Inbound message creation should be greater or equal than.
Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)
Format
date-timeCreatedOnTo?string
Date-time, that Inbound message creation should be less than.
Must have ISO format (e.g. yyyy-MM-dd'T'HH:mm:ss)
Format
date-timePageSize?integer
Format
int32Range
1 <= value <= 10000OrderByDirection?string
Possible values:
-
Ascending
-
Descending
Value in
- "Ascending"
- "Descending"
SearchId?string
IncludeFees?boolean
If true, fees are included into the result.
IncludeConversationMetadata?boolean
If true, conversation metadata is included into the result.
Response Body
curl -X GET "https://example.com/v1/InboundMessages"{ "items": [ { "sid": "IM99d9812a055b3da13d3faa216fcf4574b64b19be32626243", "from": "+19876543210", "to": "+12145678900", "additionalRecipients": [ "+12145678900", "+12145678901" ], "text": "string", "mediaUrls": [ "string" ], "createdOn": "2023-09-09T15:00:00.000Z", "segmentCount": 0, "conversationMetadata": "string", "fees": { "platformFees": [ { "count": 0, "feePerUnit": 0, "total": 0 } ], "passThroughFees": [ { "count": 0, "feePerUnit": 0, "total": 0 } ] }, "brandSid": "string", "campaignSid": "string", "messagingConfigSid": "string" } ], "searchId": "string"}{ "errors": { "Name": [ "The Name field is required." ] }, "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "detail": "Some detailed message", "traceId": "|4ef17786-b103-420e-89c0-cc425ac14809.edfcbee9_"}