Use this endpoint to retrieve a list of Message Detail Records (MDRs) within a specified date range. Date and time is based on Coordinated Universal Time (UTC).

Endpoint

GET /messages

Request Parameters

All parameters are optional except where noted.

  • start_date
    datetime required

    The beginning date and time, in UTC, on which to perform an MDR search. The DateTime can be formatted as YYYY-MM-DDor YYYY-MM-DDTHH:mm:ss.SSZ.

  • end_date
    datetime

    The ending date and time, in UTC, on which to perform an MDR search. The DateTime can be formatted as YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSZ.

  • limit
    integer

    The number of MDRs to retrieve at one time. You can set as high of a number as you want, but the number cannot be negative and must be greater than 0 (zero).

  • offset
    integer

    The number of MDRs to skip when performing a query. The number must be 0 (zero) or greater, but cannot be negative.

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of message objects in JSON format. On error, the header status code is an error code and the response body contains an error object.
  • data
    array of objects

    An array of message objects that satisfy your query individually composed of:

Formatting

DateTime Format

The start_date and end_date parameters accept UTC DateTime strings formatted in accordance with ISO 8601. These parameters can be as general as YYYY-MM-DD—for example, 2016-12-30; or, as specific as YYYY-MM-DDTHH:mm:ss.SSZ—for example, 2016-12-30T14:34:01.321Z.


HTML URL Encoding

ISO 8601 utilizes two characters that must be HTML URL encoded. These characters, and their related URL-encoded formats, are:

  • : (colon), encoded as %3A
  • + (plus), encoded as %2B