get https://{subdomain}.kommo.com/api/v4/talks/
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.
Field | Data Type | Description |
---|---|---|
talk_id | int | Conversation ID |
created_at | int | Conversation creation date in Unix Timestamp format |
updated_at | int | Conversation update date in Unix Timestamp format |
rate | int | Client conversation rating (result of processing by NPS bot) |
contact_id | int | ID of a contact the conversation belongs to |
chat_id | string | ID of a chat the conversation belongs to |
entity_id | int/null | ID of an entity the conversation belongs to |
entity_type | string/null | Type of an entity the conversation belongs to (lead) |
is_in_work | bool | It shows whether the conversation has been closed or not |
is_read | bool | It shows whether the conversation has been read |
origin | string | Type of a source the conversation was created for (Telegram, Viber, etc.) |
missed_at | int/null | Date, when conversation was missed (no response in the time bounds set in the account settings) in Unix Timestamp format |
account_id | int | Account ID |
_embedded | obj | Embedded entities data |
_embedded[contacts] | array | Data of contacts the conversation belongs to (no more than one) |
_embedded[contacts][0] | obj | Model of a contact the conversation belongs to |
_embedded[contacts][0][id] | int | ID of a contact the conversation belongs to |
_embedded[leads] | array | Data of deals the conversation is about (no more than one) |
_embedded[leads][0] | obj | Model of a deal the conversation is about |
_embedded[leads][0][id] | int | ID of a deal the conversation is about |