List SMS messages

org.intentschema.communication.sms.message.list.v1

JSON: bare · @sha256:c6ba542097b0…
Hash: sha256:c6ba542097b03a3222fac015be879a8c642c8bdfd757b230a1e4069a8d4660b7

List inbound and outbound SMS messages, optionally filtered by phone number or date range.

Payload

FieldTypeDescription
target *Target
objectobject
object
FieldTypeDescription
querystring
filterobject
limitinteger (minimum 1; maximum 500; default 50)
cursorstring
filter
FieldTypeDescription
fromstring
tostring
afterstring (date-time)
beforestring (date-time)
directionenum: inbound | outbound

Result

FieldTypeDescription
items *object[]
next_cursorstring
items[]
FieldTypeDescription
external_idstring
fromstring
tostring
textstring
directionenum: inbound | outbound
sent_atstring (date-time)
statusstring

Examples

recent inbound

{
  "target": {
    "system": "twilio"
  },
  "object": {
    "filter": {
      "to": "+15551234567",
      "direction": "inbound"
    }
  }
}