Get incoming messages

Retrieves incoming messages with filtering and pagination.

get/3rdparty/v1/inbox

Query parameters

type'SMS' | 'DATA_SMS' | 'MMS' | 'MMS_DOWNLOADED'

Filter incoming messages by type

limitinteger

Maximum number of messages to return

offsetinteger

Number of messages to skip

fromstring date-time

Start of date range (ISO 8601)

tostring date-time

End of date range (ISO 8601)

deviceIdstring

Device ID

Response

A list of incoming messages

contentPreviewstring required

Message body preview or metadata

createdAtstring date-time required

Message received timestamp

idstring required

Incoming message ID

recipientstring

Recipient phone number on the device

senderstring required

Incoming sender phone number

simNumberinteger

SIM slot number

type'SMS' | 'DATA_SMS' | 'MMS' | 'MMS_DOWNLOADED' required

Example response

[
  {
    "contentPreview": "Hello World!",
    "createdAt": "2020-01-01T00:00:00Z",
    "id": "PyDmBQZZXYmyxMwED8Fzy",
    "recipient": "+79990001234",
    "sender": "+79990001234",
    "simNumber": 1
  }
]

Changes

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