Беседы

В данном разделе описываются доступные методы для работы с сущностью бесед

Оглавление

Получение беседы по ID

Метод

GET /api/v4/talks/{id}

Описание

Метод позволяет получить данные конкретной беседы по ID.

Ограничения

Метод доступен всем пользователям аккаунта. Возвращаемые данные зависят от прав на контакт, к которому принадлежит беседа.

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Код ответа Условие
200 Запрос выполнен успешно
401 Пользователь не авторизован
402 Аккаунт не оплачен
403 Недостаточно прав
404 Беседа не найдена

Параметры ответа

Метод возвращает модель беседы, рассмотрим ниже свойства беседы.

Параметр Тип данных Описание
talk_id int ID беседы
created_at int Дата создания беседы, передается в Unix Timestamp
updated_at int Дата изменения беседы, передается в Unix Timestamp
rate int Оценка беседы клиентом, выставляется в результате работы NPS-бота
contact_id int ID контакта, к которому принадлежит беседа
chat_id string ID чата, к которому принадлежит беседа
entity_id int
null		 ID сущности, по которой ведется беседа
entity_type string
null		 Тип сущности, по которой ведется беседа (lead, customer)
is_in_work bool В работе ли беседа (не закрыта)
is_read bool Прочитана ли беседа
origin string Тип источника, по которому была создана беседа (telegram, viber, и т.д.)
missed_at int
null		 Дата когда беседа была пропущена (не отвечена за время, установленное в настройках аккаунта), передается в Unix Timestamp
account_id int ID аккаунта
_embedded object Данные вложенных сущностей
_embedded[contacts] array Данные контактов, к которым принадлежит беседа (не больше одного)
_embedded[contacts][0] object Модель контакта, к которому принадлежит беседа
_embedded[contacts][0][id] int ID контакта, к которому принадлежит беседа
_embedded[leads] array Данные сделок, по которым ведется беседа (не больше одной)
_embedded[leads][0] object Модель сделки, по которой ведется беседа
_embedded[leads][0][id] int ID сделки, по которой ведется беседа
_embedded[customers] array Данные покупателей, по которым ведется беседа (не больше одного)
_embedded[customers][0] object Модель покупателя, по которому ведется беседа
_embedded[customers][0][id] int ID покупателя, по которому ведется беседа

Пример ответа

{
    "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.amocrm.ru/api/v4/talks/117"
        }
    },
    "_embedded": {
        "contacts": [
            {
                "id": 3372695,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/contacts/3372695"
                    }
                }
            }
        ],
        "leads": [
            {
                "id": 667999637,
                "_links": {
                    "self": {
                        "href": "https://example.amocrm.ru/api/v4/leads/667999637"
                    }
                }
            }
        ],
        "customers": []
    }
}

Закрытие беседы по ID

Метод

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

Описание

Метод позволяет запустить NPS-бота или закрыть беседу по ID.
NPS-бот будет запущен только если он включен в настройках аккаунта, доступ в тарифном плане и не передан параметр force_close.

Ограничения

Метод доступен в соответствии с правами пользователя на контакт, к которому принадлежит беседа.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Для закрытия беседы без запуска NPS-бота необходимо передать свойство force_close со значением true.

Параметр Тип данных Описание
force_close bool Принудительно закрыть беседу, необязательный параметр, по-умолчанию – false

Пример запроса

В данном примере мы принудительно закроем беседу.

{
    "force_close": true
}

HTTP коды ответа

Код ответа Условие
202 Запрос выполнен успешно
401 Пользователь не авторизован
402 Аккаунт не оплачен
403 Недостаточно прав
404 Беседа не найдена
422 Беседа уже закрыта или находится в процессе закрытия

Параметры ответа

Метод не возвращает тело