Перейти к основному содержимому

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

Когда вы подключаете канал Operator API, на ваш веб-сервер приходит запрос POST {apiUrl}/setWebhook. В этом запросе указан вебхук JAICP. Формат вебхука: http://bot.jaicp.com/chatapi/webhook/operatorapi/{apiKey}, где {apiKey} — идентификатор канала Operator API.

Чтобы передавать события от ваших операторов в бота, отправляйте запросы на этот вебхук.

Запрос

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Выбор направления обращения.

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

ПараметрТипОбязательныйОписание
idstringдаУникальный строковый идентификатор сообщения.
userIdstringдаИдентификатор клиента, присвоенный в платформе JAICP.
typestringдаТип события.
employee
employeeIdstringдаИдентификатор оператора.
firstNamestringнетИмя оператора.
lastNamestringнетФамилия оператора.
avatarUrlstringнетСсылка на аватар оператора.
TextMessage
textstringдаТекстовое сообщение, отправленное оператором.
FileMessage
urlstringдаСсылка для скачивания файла.
namestringдаИмя файла для скачивания.
sizeintegerдаРазмер файла в байтах.
commentstringдаКомментарий к передаваемому файлу.
SelectDestination
destinationIdstringдаИдентификатор группы операторов.
namestringдаИмя группы операторов.
hasOnlinebooleanдаДоступность группы операторов для направления событий.

Пишите, я помогу!

Пишите, я помогу!

База знаний по документации