Категории

Создать чат

POST https://api.usedesk.ru/chat/addMessage

Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.

Метод предназначен для создания чата или отправки сообщений в уже существующий чат от лица клиента.

Создать чат можно только в чатовых каналах, иначе система вернет ошибку "status": false.

* — обязательные поля

Параметр Значение
api_token* Токен API канала

company_id*

ID вашей компании

Его можно найти тут

channel_id*

ID канала, в который будет отправлено сообщение

О том, как настроить канал для чата, читайте тут

chat_id

ID чата

Если не указан, то система создаст новый чат
message*
text* Текст сообщения
from*
client_id id клиента, к которому будет привязан чат

Если не указан, система создаст нового клиента
name Имя клиента
email Почта клиента
Пример запроса 
{
    "api_token": "e1cbe1c1c9d910ef2ae975215644cb53dd555de4",
    "company_id": "153561",
    "channel_id": "860",
    "message": 
    {
        "text": "TEST MESSAGE",
        "from": 
        {
            "name": "API",
            "client_id": "32917577"
        }
    }
}

При успешном запросе сервер вернёт сообщение об успешном создании сообщения:

Пример ответа от сервера 
{
    "chat_id": 1,
    "company_id": 153561,
    "ticket_id": 3409849,
    "channel_id": 860,
    "client_id": 11115637,
}

Если при этом произошло создание нового чата, система в ответ пришлёт данные нового чата:

Пример ответа от сервера 
{
    "chat_id": 5603949,
    "company_id": 153561,
    "ticket_id": 3409858,
    "channel_id": 860,
    "client_id": 11115637,
}

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

Параметр Описание
chat_id ID чата
company_id ID компании
ticket_id ID запроса
channel_id ID канала
client_id ID клиента