Conversations

Current section covers methods, provided in order to work with conversation entities.

Contents

• Obtain a conversation by ID
• Close a conversation by ID

Obtain a conversation by ID

Method

GET /api/v4/talks/{id}

Description

Method allows to obtain data for a specific conversation by its ID.

Limitations

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

HTTP response codes

Response fields

Method returns a conversation model, fields of which are listed below.

Response example

        
{
    "talk_id": 117,
    "created_at": 1631018291,
    "updated_at": 1631035929,
    "rate": 0,
    "contact_id": 3372695,
    "chat_id": "88278e98-2b8d-4ae2-a5f0-bfab511cd621",
    "entity_id": 667999637,
    "entity_type": "lead",
    "is_in_work": true,
    "is_read": true,
    "origin": "telegram",
    "missed_at": null,
    "account_id": 17029541,
    "_links": {
        "self": {
            "href": "https://example.kommo.ru/api/v4/talks/117"
        }
    },
    "_embedded": {
        "contacts": [
            {
                "id": 3372695,
                "_links": {
                    "self": {
                        "href": "https://example.kommo.ru/api/v4/contacts/3372695"
                    }
                }
            }
        ],
        "leads": [
            {
                "id": 667999637,
                "_links": {
                    "self": {
                        "href": "https://example.kommo.ru/api/v4/leads/667999637"
                    }
                }
            }
        ],
        "customers": []
    }
}
        
    

Close a conversation by ID

Method

POST /api/v4/talks/{id}/close

Description

Method allows to launch a NPS bot or close a conversation by its ID.
NPS bot is being launched only when, then it is enabled in the account settings, is available in a tariff plan and no force_close parameter is supplied.

Limitations

Method availability depends on user permissions for contact the conversation belongs to.

Request header

Content-Type: application/json

Request fields

In order to close a conversation without a NPS bot launch it is required to pass a force_close parameter with value of true.

Request example

In the following example we’ll forcefully close a conversation.

        
{
    "force_close": true
}
        
    

HTTP response codes

Response fields

Method has no response fields.