Texa Desk Application API · Conversations

Conversation Details

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

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

Authorization

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The numeric ID of the account

conversation_idintegerrequired

The numeric ID of the conversation

Responses

200

Success

idnumber

ID of the conversation

messagesarray of object

messages[].idnumber

The ID of the message

messages[].contentstring

The text content of the message

messages[].account_idnumber

The ID of the account

messages[].inbox_idnumber

The ID of the inbox

messages[].conversation_idnumber

The ID of the conversation

messages[].message_typeinteger

The type of the message One of: 0, 1, 2, 3.

messages[].created_atinteger

The time at which message was created

messages[].updated_atinteger or string

The time at which message was updated

messages[].privateboolean

The flags which shows whether the message is private or not

messages[].statusstring

The status of the message One of: sent, delivered, read, failed.

messages[].source_idstring

The source ID of the message

messages[].content_typestring

The type of the template message One of: text, input_text, input_textarea, input_email, input_select, cards, form, article, incoming_email, input_csat, integrations, sticker, voice_call.

messages[].content_attributesobject

The content attributes for each content_type

messages[].sender_typestring

The type of the sender One of: Contact, User, AgentBot.

messages[].sender_idnumber

The ID of the sender

messages[].external_source_idsobject

The external source IDs of the message

messages[].additional_attributesobject

The additional attributes of the message

messages[].processed_message_contentstring

The processed message content

messages[].sentimentobject

The sentiment of the message

messages[].conversationobject

The conversation object

messages[].attachmentobject

The file object attached to the image

messages[].senderobject

User/Agent/AgentBot object

account_idnumber

Account Id

uuidstring

UUID of the conversation

additional_attributesobject

The object containing additional attributes related to the conversation

agent_last_seen_atnumber

The last activity at of the agent

assignee_last_seen_atnumber

The last activity at of the assignee

can_replyboolean

Whether the conversation can be replied to

contact_last_seen_atnumber

The last activity at of the contact

custom_attributesobject

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

inbox_idnumber

ID of the inbox

labelsarray of string

The labels of the conversation

mutedboolean

Whether the conversation is muted

snoozed_untilnumber

The time at which the conversation will be unmuted

statusstring

The status of the conversation One of: open, resolved, pending.

created_atnumber

The time at which conversation was created

updated_atnumber

The time at which conversation was updated

timestampnumber

The time at which conversation was created

first_reply_created_atnumber

The time at which the first reply was created

unread_countnumber

The number of unread messages

last_non_activity_messageobject or null

The last non activity message

last_activity_atnumber

The last activity at of the conversation

prioritystring

The priority of the conversation

waiting_sincenumber

The time at which the conversation was waiting

sla_policy_idnumber

The ID of the SLA policy

applied_slaobject

The applied SLA

sla_eventsarray of object

metaobject

meta.senderobject

meta.sender.additional_attributesobject

The additional attributes of the sender

meta.sender.availability_statusstring

The availability status of the sender

meta.sender.emailstring

The email of the sender

meta.sender.idnumber

ID fo the sender

meta.sender.namestring

The name of the sender

meta.sender.phone_numberstring

The phone number of the sender

meta.sender.blockedboolean

Whether the sender is blocked

meta.sender.identifierstring

The identifier of the sender

meta.sender.thumbnailstring

Avatar URL of the contact

meta.sender.custom_attributesobject

The custom attributes of the sender

meta.sender.last_activity_atnumber

The last activity at of the sender

meta.sender.created_atnumber

The created at of the sender

meta.channelstring

Channel Type

meta.assigneeobject

meta.assignee.idnumber

meta.assignee.access_tokenstring

meta.assignee.account_idnumber

meta.assignee.available_namestring

meta.assignee.avatar_urlstring

meta.assignee.confirmedboolean

meta.assignee.display_namestring

meta.assignee.message_signaturestring

meta.assignee.emailstring

meta.assignee.hmac_identifierstring

meta.assignee.inviter_idnumber

meta.assignee.namestring

meta.assignee.providerstring

meta.assignee.pubsub_tokenstring

meta.assignee.rolestring

One of: agent, administrator.

meta.assignee.ui_settingsobject

meta.assignee.uidstring

meta.assignee.typestring

meta.assignee.custom_attributesobject

Available for users who are created through platform APIs and has custom attributes associated.

meta.assignee.accountsarray of object

meta.hmac_verifiedboolean

Whether the hmac is verified

403

Access denied

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

Conversation not found

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

import os, requests headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]} r = requests.get("https://desk.texadesk.com/api/v1/accounts/1/conversations/1", headers=headers) r.raise_for_status() print(r.json())

{ "id": 1.0, "messages": [ { "id": 1.0, "content": "string", "account_id": 1.0, "inbox_id": 1.0, "conversation_id": 1.0, "message_type": 0, "created_at": 1, "updated_at": 1, "private": true, "status": "sent", "source_id": "string", "content_type": "text", "content_attributes": {}, "sender_type": "Contact", "sender_id": 1.0, "external_source_ids": {}, "additional_attributes": {}, "processed_message_content": "string", "sentiment": {}, "conversation": {}, "attachment": {}, "sender": {} } ], "account_id": 1.0, "uuid": "string", "additional_attributes": {}, "agent_last_seen_at": 1.0, "assignee_last_seen_at": 1.0, "can_reply": true, "contact_last_seen_at": 1.0, "custom_attributes": {}, "inbox_id": 1.0, "labels": [ "string" ], "muted": true, "snoozed_until": 1.0, "status": "open", "created_at": 1.0, "updated_at": 1.0, "timestamp": 1.0, "first_reply_created_at": 1.0, "unread_count": 1.0, "last_non_activity_message": { "id": 1.0, "content": "string", "account_id": 1.0, "inbox_id": 1.0, "conversation_id": 1.0, "message_type": 0, "created_at": 1, "updated_at": 1, "private": true, "status": "sent", "source_id": "string", "content_type": "text", "content_attributes": {}, "sender_type": "Contact", "sender_id": 1.0, "external_source_ids": {}, "additional_attributes": {}, "processed_message_content": "string", "sentiment": {}, "conversation": {}, "attachment": {}, "sender": {} }, "last_activity_at": 1.0, "priority": "string", "waiting_since": 1.0, "sla_policy_id": 1.0, "applied_sla": {}, "sla_events": [ {} ], "meta": { "sender": { "additional_attributes": {}, "availability_status": "string", "email": "string", "id": 1.0, "name": "string", "phone_number": "string", "blocked": true, "identifier": "string", "thumbnail": "string", "custom_attributes": {}, "last_activity_at": 1.0, "created_at": 1.0 }, "channel": "string", "assignee": { "id": 1.0, "access_token": "string", "account_id": 1.0, "available_name": "string", "avatar_url": "string", "confirmed": true, "display_name": "string", "message_signature": "string", "email": "string", "hmac_identifier": "string", "inviter_id": 1.0, "name": "string", "provider": "string", "pubsub_token": "string", "role": "agent", "ui_settings": {}, "uid": "string", "type": "string", "custom_attributes": {}, "accounts": [ { "id": null, "name": null, "status": null, "active_at": null, "role": "administrator", "permissions": null, "availability": null, "availability_status": null, "auto_offline": null, "custom_role_id": null, "custom_role": null } ] }, "hmac_verified": true } }