Настройка API-канала

Чтобы создать API-канал, откройте раздел «Каналы» → «Добавить канал»:


Затем выберите пункт «API»:


После добавления канала на странице появляются четыре блока для настройки:
  • Основные (обязательные) — «API», «Отслеживание запросов», «Отслеживание чатов»;
  • Для вложений (по желанию) — «Настройки вложений».

Блок «API»

  • Название канала — введите название канала, которое будет отображаться в общем списке каналов в разделе «Каналы»;
  • Redirect URL — ваш вебхук, на который API-канал Юздеска должен отправлять запросы, когда возникают конкретные события по отслеживаемым каналам (их список вы определяете в блоках «Отслеживание запросов», «Отслеживание чатов»);
  • JSON запрос — отметьте чекбокс, если нужно преобразовывать запрос в формат JSON;
  • Отправлять в UTF-8 — отметьте чекбокс для отправки запроса именно в этом формате;
  • Следить за каналами — перенесите в правый столбец те каналы Юздеска, по которым этот API-канал должен отслеживать события, отмеченные чекбоксами в блоках «Отслеживание запросов», «Отслеживание чатов». Ненужные каналы оставьте в левом столбце. Такое разграничение позволит снизить нагрузку на API-канал и избавиться от лишних данных.

Блоки «Отслеживание запросов» и «Отслеживание чатов»
Отметьте чекбоксы тех событий, при которых канал должен отправлять запросы на ваш Redirect URL.


После внесения всех изменений нажмите «Сохранить».

После сохранения в блоке API появляются поля:

  • ID приложения,
  • Секретный ключ — это токен API-канала через который можно работать с API.


Блок «Настройка вложений»
Настройте передачу файлов, заполнив следующие поля:
  • Включить — включите/выключите передачу вложений;
  • URL — ваш вебхук, на который API-канал Юздеска отправит вложения;
  • Режим работы — ручной. Отправка вложений пока не происходит автоматически, она осуществляется только вручную агентом;
  • Формат передачи вложения — выберите формат для передачи вложения (ссылка/base64);
  • Допустимые расширения файлов — перечислите через запятую расширения файлов, которые БУДУТ приняты. Пустое поле — будут приняты все файлы, кроме перечисленных в поле «Запрещенные расширения файлов»;
  • Запрещенные расширения файлов — перечислите через запятую расширения файлов, которые НЕ БУДУТ приняты. Пустое поле — будут приняты все файлы, если иные не перечислены в поле «Допустимые расширения файлов»;
  • Запретить повторения типа вложения;
  • Базовая авторизация;
  • Логин;
  • Пароль;
  • Типы вложений — добавьте типы вложений, которым автоматически присвоится ID, чтобы в запросе передавать ID типа, а не названия вложений. При передаче необходимого типа вложений агент сможет выбрать из выпадающего списка один из типов;
  • Каналы — разрешите передачу вложений по определенному каналу. Важно! Один канал может быть выбран только в одном канале API для передачи вложений, т.е. если создано два API-канала и в одном уже выбран канал, то этот же канал не может быть выбран во втором API-канале.


Если канал, в который пришло обращение, подключен для передачи вложений к каком-либо API каналу, то рядом с кнопкой «Скачать» в режиме предпросмотра выводится кнопка «Передать в CRM».


При передаче вложения в правом верхнем углу появится уведомление:

  • «Вложение успешно передано» (зеленый цвет) — успех;
  • Текст ошибки (красный), например: «Некорректный ответ от сервера» — не успех.

Агент вручную выбирает файлы для передачи и нажимает кнопку «Передать в CRM»

Ответ возвращается в формате JSON: {success:true} или {sucess:false}. Любой другой ответ считается ошибкой.

Была ли статья полезна?

Да Нет