AXaxilioai
messages

List messages

Changed on

Returns one page of every text message your dedicated phones have received and sent, across conversations, newest first, each with its full body and its conversation_id; direction tells them apart. Filter by phone_id, direction and when the platform stored the message (created_after, created_before), for example to collect everything since your last read. To read a conversation, use GET /conversations/{conversation_id}/messages. Only dedicated phones with a current rental receive messages; texts arriving on shared phones, or after a rental lapses, are never stored.

get/messages

Request

Query parameters

limitinteger

max items per page

offsetinteger

pagination offset

phone_idstring

only messages on this phone

created_afterstring date-time

only messages stored at or after this time (RFC 3339)

created_beforestring date-time

only messages stored at or before this time (RFC 3339)

direction'inbound' | 'outbound'

only received (inbound) or sent (outbound) messages

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc. field is created_at (when the platform stored the message), sent_at (when it was sent) or received_at (when the phone received it); messages without that time come last.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total messages matching the query.

Example response

{
  "$schema": "/api/v1/PhoneMessageListResponse.json",
  "messages": [
    {
      "$schema": "/api/v1/PhoneMessage.json"
    }
  ]
}

Changes