API

Приём обращений по API — тикеты из вашей системы

Приём по API превращает обращения из вашей системы в тикеты Дескуса™, а ответ оператора возвращает вашим вебхуком с подписью.

Что принимает
POST-запрос с JSON: externalChatId диалога, текст до 8 000 знаков, контакт клиента — имя, почта, телефон — и ссылки на файлы. Запросы с одним externalChatId складываются в один тикет.
Защита
Подпись HMAC-SHA256 от сырого тела на секрете подключения — в заголовке X-Deskus-Signature. Запрос без верной подписи Дескус™ отклоняет.
Ответ оператора
POST на ваш «Адрес для ответов» в том же формате и с той же подписью. Файлы из ответа — ссылками на 30 дней.
Статус ответа
«Доставлено» — когда ваш адрес ответил кодом 2xx, «Не доставлено» — с кодом и текстом ошибки. Ответа Дескус™ ждёт 15 секунд.
HTML-форма
Форма на любом сайте отправляется прямо в Дескус™, без кода на сервере: поля name, email и phone попадают в карточку клиента.

Как подключить

  1. 1

    Откройте «Приём по API»

    В Дескусе™ откройте «Настройки → Каналы → Формы и API», карточку «Приём по API».

  2. 2

    Укажите адрес для ответов

    Сюда Дескус™ будет отправлять ответы операторов. Поле необязательное: без адреса канал работает только на приём.

  3. 3

    Сохраните, проверьте и активируйте

    Нажмите «Сохранить», затем «Проверить» — Дескус™ убедится, что адрес начинается с http:// или https://, — и «Активировать».

  4. 4

    Скопируйте адрес приёма и секрет подписи

    Они появятся на вкладке «Подключение». Там же — готовый пример запроса на curl с подставленными адресом и секретом.

  5. 5

    Отправьте первое обращение

    Подписанный POST-запрос создаст тикет в канале «Приём по API». Ответьте из тикета — ответ придёт на ваш адрес.

Свой канал — в общей ленте, а не в отдельной таблице

Обращения из личного кабинета, приложения или бота часто живут в своей таблице, и операторы прыгают между ней и хелпдеском. Приём по API кладёт их в ту же ленту, что почту и мессенджеры: с ответственным, статусом и историей в карточке клиента.

Если в контакте есть почта или телефон, Дескус™ найдёт карточку этого клиента — и переписка из вашей системы окажется рядом с его письмами и звонками.

Формат запроса

Тело — JSON: обязательный externalChatId до 190 знаков, text, contact с полями name, email, phone и username, необязательные externalMessageId, occurredAt и attachments — файлы с полями url, filename, mime и kind. Подпись — HMAC-SHA256 от сырого тела на секрете подписи, в заголовке X-Deskus-Signature в виде sha256=<hex>.

Ответ оператора приходит на ваш адрес POST-запросом с полями externalChatId, text и attachments и подписан тем же способом. Проверку подписи достаточно написать один раз — для обоих направлений.

  • Повтор с тем же externalMessageId не создаст дубль тикета
  • occurredAt — не старше 10 минут: более старые события Дескус™ отбрасывает как повторную отправку
  • До 600 запросов в минуту на одно подключение
  • Файлы из attachments Дескус™ скачает по публичной ссылке и сохранит в тикете — до 10 в сообщении, до 12 МБ каждый

Видно, дошёл ли ответ

Если ваш адрес вернул ошибку или не ответил за 15 секунд, у ответа появится «Не доставлено» с кодом и текстом ошибки, а в тикете — запись с причиной. Когда адрес заработает, ответ можно отправить повторно из журнала подключения: дважды он не уйдёт.

ИИ-ассистент Нейтрон Про умеет отвечать клиентам и в этом канале, если вы это разрешите, — его ответ уйдёт на тот же адрес.

Простая HTML-форма без кода на сервере

Для формы на сайте подключите карточку «HTML-форма» в «Настройки → Каналы → Формы и API» и поставьте адрес приёма в атрибут action формы. Поля name, email и phone попадут в карточку клиента, остальные — в текст заявки.

После отправки посетитель увидит страницу «Спасибо» Дескуса™ или вернётся на ваш адрес из поля «Куда вернуть посетителя». Файлы форма не передаёт — в заявке останется имя файла. Ответить в форму нельзя: ответ из тикета уйдёт письмом, если посетитель оставил почту.

Это открытый API хелпдеска?

Нет. Это канал приёма: ваша система передаёт обращения, а Дескус™ возвращает ответы операторов. Читать и менять тикеты через этот адрес нельзя.

Как проверить подпись ответа на нашей стороне?

Посчитайте HMAC-SHA256 от сырого тела запроса на секрете подписи из карточки подключения и сравните с заголовком X-Deskus-Signature без префикса sha256=. Считайте по байтам тела до разбора JSON — иначе подпись не сойдётся.

Что будет, если наш сервер не ответит?

Дескус™ ждёт 15 секунд. Если адрес не ответил или вернул ошибку, ответ в тикете помечается «Не доставлено» с причиной. Его можно отправить повторно из журнала подключения — клиенту он придёт один раз.

Можно ли подключить две наши системы?

Приём по API подключается к компании один раз. Обращения из разных систем можно слать на один адрес — различайте их по externalChatId, например по префиксу системы.

Сколько стоит приём по API?

Канал входит в подписку Дескуса™: 4 990 ₽ в месяц за трёх сотрудников, каждый следующий — 990 ₽. Отдельной платы за запросы нет.

Ваш бизнес. Наш Дескус™. Их лояльность.

Перейдите на хелпдеск, который не подводит

Подключите почту, виджет и мессенджеры, пригласите команду и настройте правила под свои процессы — отвечайте клиентам уже сегодня.

Начать бесплатно
14 дней бесплатно — все продукты и Нейтрон на пробном уровне

Серверы в РоссииРабота по 152‑ФЗИИ в российском облаке

Войти в кабинет