Conversation Details

GET

/api/v1/accounts/{account_id}/conversations/{conversation_id}

Conversations

Get all details regarding a conversation with all messages in the conversation

Response Example

200 - Example 1

{
    "id": 0,
    "messages": [
        {
            "content": "string",
            "content_type": "text",
            "content_attributes": {},
            "message_type": "incoming",
            "created_at": 0,
            "private": true,
            "attachment": {},
            "sender": {},
            "conversation_id": 0
        }
    ],
    "account_id": 0,
    "inbox_id": 0,
    "status": "open",
    "timestamp": "string",
    "contact_last_seen_at": "string",
    "agent_last_seen_at": "string",
    "unread_count": 0,
    "additional_attributes": {},
    "custom_attributes": {
        "attribute_key": "attribute_value",
        "priority_conversation_number": 3
    },
    "meta": {
        "sender": {
            "id": 0,
            "name": "string",
            "thumbnail": "string",
            "channel": "string"
        },
        "assignee": {
            "id": 0,
            "uid": "string",
            "name": "string",
            "available_name": "string",
            "display_name": "string",
            "email": "string",
            "account_id": 0,
            "role": "agent",
            "confirmed": true,
            "custom_attributes": {},
            "accounts": [
                {
                    "id": 0,
                    "name": "string",
                    "role": "administrator"
                }
            ]
        }
    }
}

Request

Path Params

account_id

string

required

conversation_id

string

required

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

number

optional

ID of the conversation

messages

array[object (message) {9}]

optional

content

string

optional

The text content of the message

content_type

enum<string>

optional

The type of the template message

Allowed values:

textinput_selectcardsform

content_attributes

object

optional

The content attributes for each content_type

message_type

enum<string>

optional

The type of the message

Allowed values:

incomingoutgoingactivitytemplate

created_at

integer

optional

The time at which message was created

private

boolean

optional

The flags which shows whether the message is private or not

attachment

object

optional

The file object attached to the image

sender

object

optional

User/Agent/AgentBot object

conversation_id

number

optional

ID of the conversation

account_id

number

optional

Account Id

inbox_id

number

optional

ID of the inbox

status

enum<string>

optional

The status of the conversation

Allowed values:

openresolvedpending

timestamp

string

optional

The time at which conversation was created

contact_last_seen_at

string

optional

agent_last_seen_at

string

optional

unread_count

number

optional

The number of unread messages

additional_attributes

object

optional

The object containing additional attributes related to the conversation

custom_attributes

object

optional

The object to save custom attributes for conversation, accepts custom attributes key and value

Example:

{"attribute_key":"attribute_value","priority_conversation_number":3}