Get a conversation by ID

The method allows you to obtain data for a specific conversation by its ID

Limitations
The method is available for every user of an account. Data returned varies depending on permissions set for contact the conversation belongs to.

Response header in case of a success
Content-Type: application/hal+json

Response header in case of an error
Content-Type: application/problem+json

Response parameters
Method returns a conversation object.

FieldData TypeDescription
talk_idintConversation ID
created_atintConversation creation date in Unix Timestamp format
updated_atintConversation update date in Unix Timestamp format
rateintClient conversation rating (result of processing by NPS bot)
contact_idintID of a contact the conversation belongs to
chat_idstringID of a chat the conversation belongs to
entity_idint/nullID of an entity the conversation belongs to
entity_typestring/nullType of an entity the conversation belongs to (lead)
is_in_workboolIt shows whether the conversation has been closed or not
is_readboolIt shows whether the conversation has been read
originstringType of a source the conversation was created for (Telegram, Viber, etc.)
missed_atint/nullDate, when conversation was missed (no response in the time bounds set in the account settings) in Unix Timestamp format
account_idintAccount ID
_embeddedobjEmbedded entities data
_embedded[contacts]arrayData of contacts the conversation belongs to (no more than one)
_embedded[contacts][0]objModel of a contact the conversation belongs to
_embedded[contacts][0][id]intID of a contact the conversation belongs to
_embedded[leads]arrayData of deals the conversation is about (no more than one)
_embedded[leads][0]objModel of a deal the conversation is about
_embedded[leads][0][id]intID of a deal the conversation is about
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!