SMS Messaging

List messages

Changed on
get/messages

Request

  • Base URL: https://rest.messagebird.com/messages
  • URL: https://rest.messagebird.com/messages/messages
  • Auth: API key in header Authorization

Query parameters

originatorstring

Display messages by the specified originator.

recipientinteger

Display messages for the specified recipient.

directionstring

Display either mt (sent) or mo (received) messages.

limitinteger

Limit the amount of messages listed.

offsetinteger

Skip first n results.

searchtermstring

Display messages including the specified searchterm in recipient and originator

typestring

Display messages of type sms, binary, or flash

contact_idstring

Display messages by contact_id. See Contacts API for more info.

statusstring

Display messages with status scheduled, sent, buffered, delivered, expired, or delivery_failed.

fromstring

Display messages starting from the specified date in RFC3339 format (Y-m-d\TH:i:sP).

untilstring

Display messages until the specified date in RFC3339 format (Y-m-d\TH:i:sP).

Response

OK

object required

Changes

  • 48bb1cc832d5Revision changes
    • warning

      the optional response header Alt-Svc removed for the status 200

    • warning

      the optional response header Server removed for the status 200

    • warning

      the optional response header Via removed for the status 200

    • warning

      the optional response header X-CLOUD-TRACE-CONTEXT removed for the status 200