get
https://{subdomain}.kommo.com/api/v4/talks//messages
The method allows to retrieve messages from a conversation.
Limitations
- The method is available in accordance with the user’s rights
- The method is available for the Trial, Pro, Enterprise and Technical plans
- The method requires
External chat historyintegration scope
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Response parameters
| Parameter | Data type | Description |
|---|---|---|
| id | string | Message ID |
| chat_id | string | Chat ID |
| type | string | Message direction. Possible values: incoming, outgoing |
| message_type | string | Message content type. Possible values: text, contact, file, video, picture, voice, audio, sticker, location |
| author | obj | The message author object |
| author[id] | string | Author ID |
| author[type] | string | Author type. Possible values: internal (Kommo user), external (client), bot (Kommo bot) |
| author[name] | string | Author display name |
| author[avatar_url] | string | URL of the author's avatar |
| author[user_id] | int | Kommo user ID. Returned only when author[type]: internal |
| recipient | obj | The message recipient object |
| recipient[id] | string | Recipient ID |
| recipient[type] | string | null | Recipient type. Possible values: external (client) |
| recipient[name] | string | Recipient display name |
| recipient[avatar_url] | string | URL of the recipient's avatar |
| text | string | Message text. Empty for messages without text content |
| created_at | int | Message creation time as a Unix timestamp (seconds) |
| sec_created_at | int | Message creation time as a Unix timestamp (milliseconds) |
| origin | string | Chat channel of the message. |
| delivery_status | string | Message delivery status. Possible values: sent, delivered, error |
| attachment | obj | null | Attachment object |
| attachment[type] | string | Attachment type |
| attachment[link] | string | Attachment file path or URL |
| attachment[file_name] | string | Attachment file name |