Классы Чата

Класс конфигурации Чата - UsedeskChatConfiguration:
Свойство Тип Описание
urlChat* String Адрес сервера чата
urlOfflineForm* String Адрес для отправки данных формы обратной связи (стандартный https://secure.usedesk.ru/)
urlToSendFile* String Адрес для отправки файлов чата (стандартный https://secure.usedesk.ru/uapi/v1/)
companyId* String ID компании
channelId* String Идентификатор канала (добавлен в v3.1.6)
clientEmail String Email клиента
clientName String? Имя клиента
clientPhoneNumber Long? Телефонный номер клиента
clientAdditionalId Long? Дополнительный ID клиента
clientInitMessage String? Сообщение от клиента при открытии чата

Абстрактный класс сообщения - UsedeskMessage:
Свойство Тип Описание
id Long ID сообщения
createdAt Calendar Дата создания сообщения
type UsedeskMessage.Type Тип сообщения (TYPE_AGENT_TEXT, TYPE_AGENT_IMAGE, TYPE_AGENT_FILE, TYPE_CLIENT_TEXT, TYPE_CLIENT_IMAGE, TYPE_CLIENT_FILE)


Интерфейс сообщения агента - UsedeskMessageAgent:
Свойство Тип Описание
name String Имя агента
avatar String Ссылка на иконку агента

Интерфейс сообщения клиента - UsedeskMessageClient:
Свойство Тип Описание
status UsedeskMessageClient.Status Статус отправки сообщения (SENDING, SUCCESSFULLY_SENT, SEND_FAILED, RECEIVED)


Класс текстового сообщения - UsedeskMessageText : UsedeskMessage:
Свойство Тип Описание
text String Текстовое сообщение

Класс сообщения с файлом - UsedeskMessageFile : UsedeskMessage:
Свойство Тип Описание
file UsedeskFile Файл сообщения

Класс текстового сообщения агента - UsedeskMessageAgentText : UsedeskMessageText, UsedeskMessageAgent:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_AGENT_TEXT)
buttons List Кнопки действий сообщения
feedbackNeeded Boolean Флаг ожидания отзыва от пользователя
feedback UsedeskFeedback? Проставленный отзыв от пользователя


Класс сообщения с файлом агента - UsedeskMessageAgentFile : UsedeskMessageFile, UsedeskMessageAgent:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_AGENT_FILE)


Класс сообщения с изображением агента - UsedeskMessageAgentImage : UsedeskMessageFile, UsedeskMessageAgent:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_AGENT_IMAGE)


Класс текстового сообщения клиента - UsedeskMessageClientText : UsedeskMessageText, UsedeskMessageClient:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_CLIENT_TEXT)

Класс сообщения с файлом клиента - UsedeskMessageClientFile : UsedeskMessageFile, UsedeskMessageClient:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_CLIENT_FILE)


Класс сообщения с изображением клиента - UsedeskMessageClientImage : UsedeskMessageFile, UsedeskMessageClient:
Свойство Тип Описание
type UsedeskMessage.Type Тип сообщения (TYPE_CLIENT_IMAGE)


Класс информации о файле на устройстве - UsedeskFileInfo:
Свойство Тип Описание
uri Uri Ссылка на файл
type String MIME-тип файла
name String Название файла


Класс информации о файле на сервере - UsedeskFile:
Свойство Тип Описание
content String Ссылка на файл
type String MIME-тип файла
size String Размер файла
name String Название файла


Класс настроек Формы Обратной Связи - UsedeskOfflineFormSettings:
Свойство Тип Описание
noOperators Boolean Все операторы оффлайн
workType WorkType
Тип ФОС:
NEVER - никогда,
CHECK_WORKING_TIMES - в нерабочее время,
ALWAYS_ENABLED_CALLBACK_WITHOUT_CHAT - всегда только ФОС,
ALWAYS_ENABLED_CALLBACK_WITH_CHAT - всегда ФОС + Чат.
callbackTitle String
Заголовок ФОС
callbackGreeting String
Приветственное сообщение ФОС
fields List
Список дополнительных полей
topics List
Список тем обращения
topicsTitle String
Заголовок тем обращения
topicsRequired Boolean
Необходимость выбора темы обращения


Класс заполненного дополнительного поля - UsedeskOfflineFormSettings.CustomField:
Свойство Тип Описание
key String Ключ дополнительного поля
required Boolean Необходимость заполнения дополнительного поля
checked Boolean Активность дополнительного поля
placeholder String Заголовок дополнительного поля


Класс формы обратной связи - UsedeskOfflineForm:
Свойство Тип Описание
clientName String Имя клиента
clientEmail String Email клиента
topic String Выбранная тема обращения
fields List Заполненные дополнительные поля
message String Текстовое сообщение клиента


Класс заполненного дополнительного поля - UsedeskOfflineForm.Field:
Свойство Тип Описание
key String Ключ дополнительного поля
title String Заголовок дополнительного поля
value String Значение дополнительного поля

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

Да Нет