Query parameters

• from string | array[string]

  Filter based on the from msisdn, can be either an array or comma separated list

• ref string

  Filter based on the ref of the message, can be empty to filter on messages without a reference

• completed boolean

  Filter based on whether the message has finished/completed

• messageID.min integer

  Return messages whose messageID is greater than or equal to this value

• messageID.max integer

  Return messages whose messageID is less than or equal to this value

• created_at.min string(date-time)

  Return message created on or after this time; default is 24 hours ago

• created_at.max string(date-time)

  Return message created on or before this time

• limit integer

  Max number of messages to return (default 100, max 500)

• offset integer

  Number of messages to skip (for pagination use)

• sort

  Csv of sort field definitions, default is "-messageID" which means descending order of messageID, ie newest messages first

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object]
    Hide data attributes Show data attributes object

    • messageID integer

      The ID of the message

    • from string

      The msisdn the message was sent from

    • to string

      The msisdn the message was sent to

    • body string

      The message body

    • ref string

      Reference of the msisdn the message was sent to

    • received_at string(timestamp)

      The time at which the message was received

  • more_results boolean

    Are there more results which have not been included

• 400

  Invalid input

• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • status_code integer

    Status code 401

  • status_msg string

    Error message text

• 403

  Invalid input