Дополнительные блоки
Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.
Дополнительные блоки делятся на два типа: статический и динамический.
Статический блок
Выводит статическую информацию. В настройках блока задаётся информация (текст) и выводится в каждом запросе. Текст поддерживает различные переменные запроса.
Динамический блок
Делает запрос на указанный в его настройках url и отрисовывает контент, который возвращается ему в ответ.
Формат ожидаемого ответа: json
Структура ожидаемого ответа:
{
"html": "Какой-то HTML"
}
Секретный ключ, если указан, добавляется в тело запроса.
По умолчанию ответ будет оформлен в соответствии со стилями UseDesk, есть поддержка bootstrap. Также ответ может содержать свои стили, добавленные в html. Стили необходимо указывать inline к каждому элементу для его форматирования, а не через передачу файла. Стили через файлы мы не можем принимать в целях безопасности.
Таймаут ответа — 60 секунд. Над каждым динамическим блоком есть кнопка «обновить», которая повторяет запрос и перезагружает данные в блок.
Описание параметров запроса:
| Параметр | Значение | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ticket_id | id запроса в UseDesk | |||||||||||||||||||||||||||||||||||||||||||||||
| subject | тема запроса | |||||||||||||||||||||||||||||||||||||||||||||||
| client_id | id клиента в UseDesk | |||||||||||||||||||||||||||||||||||||||||||||||
| channel_type |
тип канала, на который пришёл запрос. Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data |
|||||||||||||||||||||||||||||||||||||||||||||||
| channel_id | id канала в UseDesk | |||||||||||||||||||||||||||||||||||||||||||||||
| contact | контактные данные (почта, id, телефоны) | |||||||||||||||||||||||||||||||||||||||||||||||
| from_email |
если запрос пришёл из канала с типом email Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data |
|||||||||||||||||||||||||||||||||||||||||||||||
| from_id |
id, если запрос пришёл из другой системы Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data |
|||||||||||||||||||||||||||||||||||||||||||||||
| client_data |
массив с имеющимися в UseDesk данными клиента
|
|||||||||||||||||||||||||||||||||||||||||||||||
| channel_data | массив с данными о текущем канале запроса (версия 2.0) | |||||||||||||||||||||||||||||||||||||||||||||||
| Параметр | Значение | |||||||||||||||||||||||||||||||||||||||||||||||
| type |
тип канала, по которому пришёл запрос
|
|||||||||||||||||||||||||||||||||||||||||||||||
| data |
данные канала, по которому пришёл запрос
** UID — приоритетнее, если его нет, вернет вышеуказанные данные |
|||||||||||||||||||||||||||||||||||||||||||||||
| id | id учётной записи из канала, по которому пришёл запрос | |||||||||||||||||||||||||||||||||||||||||||||||
{
"ticket_id": 2252750,
"subject": "Hello!",
"secret_key" : "1secret2key!@",
"client_id": 151869,
"channel_type": "usedesk_chat",
"channel_id": 4923,
"from_email": test@gmail.ru,
"client_data": {
"name": "Иванов Иван",
"emails": [
"test@gmail.ru",
],
"phones": [
{
"type": "home",
"phone": "1 111 111-11-11 #111"
},
{
"type": "mobile",
"phone": "+2 222 222-22-22 #222"
}
],
"social_services": [
{
"type": "facebook",
"url": "https://facebook.com/123124124124124214",
"uid": null
}
],
"addresses": [
{
"country": "Россия",
"city": "Москва",
"address": "улица 3, дом 4",
"type": "home"
}
],
"messengers": [
{
"type": "telegram",
"id": "1234"
}
],
"sites": [
"http://site.ru"
],
"company": "Ритм"
},
"channel_data": {
"type": "chat",
"data": "test@gmail.ru",
"id": 1111111
}
}