Sign in
User
Messages

Get messages

Retrieves a list of messages with filtering and pagination

get/3rdparty/v1/messages

Query parameters

fromstring date-time

Start date in RFC3339 format

tostring date-time

End date in RFC3339 format

state'Pending' | 'Cancelling' | 'Cancelled' | 'Processed' | 'Sent' | 'Delivered' | 'Failed'

Filter messages by processing state

deviceIdstring

Filter by device ID

limitinteger

Pagination limit

offsetinteger

Pagination offset

includeContentboolean

Include textMessage/dataMessage content for each message. Default is false

sort'created_at' | '-created_at'

Sort order per JSON:API spec. Use created_at (ascending) or -created_at (descending)

Response

A list of messages

deviceIdstring required

Device ID

idstring required

Message ID

isEncryptedboolean

Encrypted

isHashedboolean

Hashed

state'Pending' | 'Cancelling' | 'Cancelled' | 'Processed' | 'Sent' | 'Delivered' | 'Failed' required
statesobject

History of states

Example response

[
  {
    "dataMessage": {
      "data": "SGVsbG8gV29ybGQh",
      "port": 53739
    },
    "deviceId": "PyDmBQZZXYmyxMwED8Fzy",
    "hashedMessage": {
      "hash": "1d4b6e3b1b6e3b1b6e3b1b6e3b1b6e3b1b6e3b1b"
    },
    "id": "PyDmBQZZXYmyxMwED8Fzy",
    "recipients": [
      {
        "error": "timeout",
        "phoneNumber": "79990001234"
      }
    ],
    "textMessage": {
      "text": "Hello World!"
    }
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.