Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleВнимание

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


Table of Contents

Дополнительные блоки

Дополнительные блоки делятся на два типа:

Статический блок 

Выводит статическую информацию. В настройках блока задается информация (текст) и выводится в каждом тикете. Текст поддерживает различные переменные тикета.

Динамический блок

Делает запрос на указанный в его настройках url и отрисовывает контент, который ему возвращается в ответ.

Формат ожидаемого ответа: json

Структура ожидаемого ответа:

Code Block
languagejs
{ 
"html": "Какой-то HTML"
}

Секретный ключ, если указан, добавляется в url запроса:  https://site.com/?secret_key=$key, где $key - секретный ключ

По умолчанию ответ будет оформлен в соответствии со стилями UseDesk, есть поддержка bootstrap. Так же ответ может содержать свои стили, добавленные в html. Стили необходимо указывать inline к каждому элементу для его форматирования, а не через передачу файла. Стили через файлы мы не можем принимать в целях безопасности.

Таймаут ответа — 60 секунд. Над каждым динамическим блоком есть кнопка "обновить", которая повторяет запрос и перезагружает данные в блок.


Описание параметров запроса

ПараметрЗначение
ticket_idid запроса в UseDesk
subjectтема запроса
client_idid клиента в UseDesk
channel_type

тип канала, на который пришел запрос.

Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data

channel_idid канала в UseDesk
contactконтактные данные (почта, id, телефоны)
from_email

если запрос пришел из канала с типом email

Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data

from_id

id, если запрос пришел из другой системы

Deprecated (версия 1.0): Не рекомендуем использовать. Работа с типом канала вынесена в параметр channel_data

client_data

массив, с имеющимися в UseDesk данными клиента

ПараметрЗначение
nameимя клиента
emailsмассив с электронными адресами клиента
phones

массив с телефонами клиента

ПараметрЗначение
typeтип телефона ('home','mobile','stationary','fax','other')
phoneномер телефона


social_services

список аккаунтов клиента в соц.сетях

ПараметрЗначение
typeвид соц.сети ('twitter','facebook','vk','ok','instagram','youtube','gplus','other')
urlадрес клиента в соц.сети


addresses

физические адреса клиента

ПараметрЗначение
countryстрана
cityгород
addressадрес
typeтип ('home','work','postal')


messengers

мессенджеры клиента

ПараметрЗначение
typeтип ('imessage','skype','whatsapp','gtalk','telegram','other','jivo')
id идентификатор клиента в мессенджере


sitesсписок сайтов клиент
companyкомпания клиента


channel_dataмассив, с данными о текущем канале запроса (версия 2.0)
ПараметрЗначение
type

тип канала, по которому пришел запрос

  • email
  • telephony
  • chat
  • whatsapp
  • telegram
  • twitter
  • vk
  • ok
  • instagram
  • viber
  • facebook
  • sdk
data

данные канала, по которому пришел запрос

  • email: почтовый адрес
  • telephony: номер телефона
  • chat: почтовый адрес, если запрашивает чат
  • whatsapp: номер телефона
  • telegram: 12345678
  • twitter: адрес страницы группы
  • vk: адрес страницы группы
  • ok: id чата
  • instagram: название аккаунта
  • viber: id
  • facebook: id записи
  • sdk: почтовый адрес, если запрашивает чат

** UID -  приоритетнее, если его нет вернет вышеуказанные данные

idid учетной записи из канала, по которому пришел запрос



Code Block
languagephp
titleПример запроса
linenumberstrue
{
	"ticket_id": 2252750,
	"subject": "Hello!",
	"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
  }
}