AXaxilioai
conversations

Get a conversation

Changed on

Returns one conversation: its phone, its participants and its latest message. Another organization's conversation reads as not found.

get/conversations/{conversation_id}

Request

Path parameters

conversation_idstring uuid required

conversation identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required

When the conversation's first message was stored.

idstring required

Conversation identifier. Opaque: don't derive it, read it from a conversation or a message's conversation_id.

is_groupboolean required

True for a group conversation: more than one other person.

last_message_atstring date-time required

When the latest message was stored. Conversations list newest activity first by this time.

phone_idstring required

The dedicated phone this conversation is on.

phone_numberstring nullable required

That phone's own number in E.164: what its SIM reports, or else the number its latest received text was sent to. Null when neither is known, or when the phone is no longer one your organization rents.

Example response

{
  "$schema": "/api/v1/Conversation.json",
  "last_message": {
    "$schema": "/api/v1/PhoneMessage.json"
  }
}

Changes