Sign in
Inbounds

List incoming messages

With the list operation, you can list all inbound messages that you have received. This operation supports pagination. Inbounds are returned in reverse chronological order.

get/xms/v1/{service_plan_id}/inbounds

Query parameters

pageinteger

The page number starting from 0.

page_sizeinteger

Determines the size of a page

tostring[]

Only list messages sent to this destination. Multiple phone numbers formatted as either E.164 or short codes can be comma separated.

start_datestring date-time

Only list messages received at or after this date/time. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

Default: Now-24

end_datestring date-time
Example:2016-10-02T09:34:18.542Z

Only list messages received before this date/time. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

client_referencestring

Using a client reference in inbound messages requires additional setup on your account. Contact your account manager to enable this feature.

Only list inbound messages that are in response to messages with a previously provided client reference.

Response

OK. A successful response , or an Error.

countinteger

The total number of inbounds matching the given filters

pageinteger

The requested page.

page_sizeinteger

The number of inbounds returned in this request.

Example response

{
  "count": 2,
  "inbounds": [
    {
      "from": "+11203494390",
      "id": "01FC66621XXXXX119Z8PMV1QPA",
      "operator_id": "35000",
      "to": "11203453453"
    }
  ],
  "page_size": 2
}