Передача событий в платформу

подсказка

При запросе POST {apiUrl}/setWebhook будет установлен вебхук, на который следует направлять события от операторов.

Формат вебхука:

http://{host_name}/chatadapter/chatapi/webhook/operatorapi/{apiKey}

Запрос

POST ​/chatapi​/webhook​/operatorapi​/{apiKey}

Тело запроса

Тело запроса содержит информацию, необходимую для создания или изменения объекта. Информация должна передаваться в формате JSON.

Ниже представлены допустимые для отправки события, их структура и поля.

POST ​/chatapi​/webhook​/operatorapi​/{apiKey}

Request body: TextMessage | FileMessage | Closed | SelectDestination

TextMessage: {
    "id": "id",
    "userId": "54321",
    "type": "TextMessage",
    "text": "text",
    "employee": {
        "employeeId": "id",
        "firstName": "first name",
        "lastName": "last name",
        "avatarUrl": "http://someUrl",
    },
},

FileMessage {
    "id": "id",
    "userId": "54321",
    "type": "FileMessage",
    "url": "http://someUrl",
    "employee": {
        "employeeId": "id",
        "firstName": "first name",
        "lastName": "last name",
        "avatarUrl": "http://someUrl",
    },
    "name": "example",
    "size": "2",
    "comment": "file",
},

Closed {
    "id": "id",
    "userId": "54321",
    "type": "Closed",
    "employee": {
        "employeeId": "id",
        "firstName": "first name",
        "lastName": "last name",
        "avatarUrl": "http://someUrl",
    },
},

SelectDestination {
    "id": "id",
    "userId": "54321",
    "type": "SelectDestination",
    "destination": {
        "destinationId": "id",
        "name": "name",
        "hasOnline": "true",
    },
},

Типы событий

Событие	Описание
TextMessage	Текстовое сообщение от оператора.
FileMessage	Вложенный файл от оператора.
Closed	Закрытие обращения со стороны оператора.
SelectDestination	Выбор направления обращения.

Параметры запроса

Параметр	Тип	Обязательный	Описание
id	string	да	Уникальный строковый идентификатор сообщения.
userId	string	да	Идентификатор клиента, присвоенный в платформе JAICP.
type	string	да	Тип события.
employee
employeeId	string	да	Идентификатор оператора.
firstName	string	да	Имя оператора.
lastName	string	да	Фамилия оператора.
avatarUrl	string	да	Ссылка на аватар оператора.
TextMessage
text	string	да	Текстовое сообщение, отправленное оператором.
FileMessage
url	string	да	Ссылка для скачивания файла.
name	string	да	Имя файла для скачивания.
size	integer	да	Размер файла в байтах.
comment	string	да	Комментарий к передаваемому файлу.
SelectDestination
destinationId	string	да	Идентификатор группы операторов.
name	string	да	Имя группы операторов.
hasOnline	boolean	да	Доступность группы операторов для направления событий.