Универсальный коннектор Chat API

Chat API — универсальный канал с публичным API, предназначенный для подключения а к ам, для которых нет встроенного в .Организовать такой универсальный канал можно с помощью а

Подключение

Конфигурация канала агента в Платформе

у необходимо создать и настроить с коннектором

Кликните по кнопке настроек а.
Нажмите кнопку Add channel.
Откроется панель выбора .
Выберите .
Откроется панель создания .
По необходимости пропишите заголовок для данного в поле названия с плейсхолдером New channel.
Пропишите адрес вашего сервера в поле Channel webhook URL в виде https://{server_adress}, где {server_adress} — адрес .
Важно: к указанному адресу будет подставлен метод при отправке ом ответа на запрос из канала/сервера клиента: https://your_company.com/send_message.
По необходимости установите токен в поле Channel token.
Важно: токен необходимо указывать в случае, если авторизация на стороне клиента осуществляется через header. Подробнее описано в .
Скопируйте ссылку на вебхук канала агента (поле Chatbot webhook URL), нажав кнопку Copy this webhook.
Для сохранения без его активации, нажмите кнопку CREATE.
Для сохранения и активации , нажмите кнопку CREATE & ACTIVATE.
1. будет сохранен и активирован, если:
2. 1. обучен;
  2. токен в поле Channel token уникален (нет ли активных того же типа с тем же значением в поле);
  3. будет доступен адрес ;
  4. удастся зарегистрировать вебхук канала.
3. будет сохранен, но не активирован, если одно или больше условий не будут выполнены.
Для отмены создания нажмите кнопку CANCEL.

Редактирование и удаление Канала Агента

Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение.
1. Изменения будут применены, если:
2. 4. удастся зарегистрировать вебхук канала.
3. Изменения не будут применены, если одно или больше условий не будут выполнены.
2. 4. удастся зарегистрировать вебхук канала.

Запросы из канала/сервера клиента к Агенту на Платформе

Платформа развернута в облаке

https://admin.chatme.ai/connector/chatapi/chatapi_message/{token}/bot_api_webhook

Платформа развернута в контуре клиента

https://{server_adress}/connector/chatapi/chatapi_message/{token}/bot_api_webhookГде:

{token} — токен авторизации.

Общая структура запроса

Вид тела запроса:

{ "event": (string), "chat_id": (string), "visitor"(optional object): {   "id": (string),   "fields": {     Fields (object)   } }, "message": {   Message (object) }, "service_data"(optional object): {   Service data (object) }}

Важно: структура объекта Message зависит от типа передаваемого сообщения (текст, файл, нажатие на кнопку) и может состоять из разных видов данных и полей.

Тип события event

Идентификатор chat_id

Объект Visitor

{  "id": (string — псевдоуникальный идентификатор Собеседника, назначенный сервером клиента),  "fields": {    "name": (string),    "login": (string),    "phone": (string),    "email": (string),    "site": (string)  }}

Пример Visitor:

{  "id": "03e1c040d8214bfa8ccfbb053186a24a",  "fields": {    "name": "Иван",    "login": "ivan",    "phone": "+79991111111",    "email": "ivan@gmail.com",    "site": "https://site.com"  }}

Объект Message

{  "kind": (string — тип сообщения),  "text": (string — текст сообщения Собеседника),  "data": (JSON — данные о файле или нажатой кнопке)}

Поддерживаемый контент сообщений

Ниже представлены примеры содержимого объекта Message для различных типов сообщений.

Текст

Вид Message:

{"kind": "text","text": (string — message text)}

Пример Message:

{  "kind": "visitor",  "text": "Здравствуйте"}

Файл

Вид Message:

{"kind": "attachment","attachment": { "id": (string — file id), "content_type": (string — Internet Media Type), "url": (string — file URL) }}

Пример Message:

{ "kind": "file_visitor",  "attachment": {    "id": "81f0488",    "content_type": "text",    "size": 560,    "url": "https://yoursite.com/content/file.txt"  }}

Нажатие на кнопку

Вид Message:

{  "kind": "keyboard_response",  "keyboard_response": {    "button": {      "id": (string — идентификатор кнопки),      "text": (string — текст кнопки)    }  }}

Пример Message:

{  "kind": "keyboard_response",  "keyboard_response": {    "button": {      "id": "937bec4863154a2fb0889ff1320d1e2f",      "text": "Задать вопрос оператору"    }  }}

Объект Service data

Ответы на запросы из канала/сервера клиента к Агенту на Платформе

Ответ Платформы при успешном запросе

HTTP status: 200 OKBODY:

{  "result": "ok"}

Ответ Платформы при неуспешном запросе

HTTP status: 400 Bad RequestBODY:

{    "error": "There is no active channel for received event."}

Отсутствует обязательный параметр в теле запроса
HTTP status: 400 Bad Request
Указан некорректный URL
HTTP status: 404: Not Found
Некорректный JSON тела запроса: невалидный параметр event или kind
HTTP status: 200 OK

Запросы от Платформы в канал/сервер клиента

Ниже изложены форматы, примеры и описания запросов от Публичного API "Chat API" на сервер клиента.

Базовый URL

{method} — один из методов Публичного API "Chat API".

Методы Публичного API "Chat API":

Авторизация на стороне клиента

Авторизация может осуществляться через:

Уникальный URL

Header

Общая структура запроса

https://{server_adress}/send_message

{    "message": Message (object),    "chat_id": (string)}

Важно: структура объекта Message зависит от типа передаваемого сообщения (текст, файл, кнопки).

Идентификатор chat_id

Объект Message

{  "kind": (string — тип сообщения),  "text": (string — текст сообщения Агента),  "data": (JSON — данные о файле),  "buttons": (object — данные о кнопке/кнопках)}

Поддерживаемый контент сообщений

Ниже представлены примеры содержимого объекта Message для различных типов сообщений.

Текст

Вид Message:

{  "kind": "operator",  "text": (string — текст сообщения Агента)}

Пример Message:

{  "kind": "operator",  "text": "Здравствуйте, чем я могу вам помочь?"

Файл

Вид Message:

{ "kind": "attachment", "attachment": {    "url": (string — file URL),    "type": (string — Internet Media Type),    "caption": (string — Attachment Caption. Optional field) }}

Пример Message:

{  "kind": "attachment",  "attachment": {    "url": "https://site.ru/wp-content/uploads/2019/04/diagram.png",    "type": "image/png",    "caption": "подпись"  }}

Важно: отправка файлов происходит из слота .

Сообщение с кнопками

Вид Message:

{  "kind": "keyboard",  "buttons": [    [      {        "text": (string — текст кнопки),        "id": (string — идентификатор кнопки)      }    ]  ]}

Пример Message:

{  "kind": "keyboard",  "buttons": [    [      {        "text": "Перевести на техподдержку",        "id": "fedc60c4dc0d4348b48b524d"      }    ],    [      {        "text": "Перевести на отдел продаж",        "id": "574f2caad88a41a7a2d6b667"      }    ]  ]}

Важно: идентификатор кнопки может содержать только латинские буквы, цифры, символы дефиса и нижнего подчёркивания, и должен быть не более 24 символов в длину.

Перевод на оператора

Запрос для перевода на оператора

Метод: /close_chatТип запроса: POSTContent-type: application/jsonQuery-string параметры: не нужныURL: https://{server_address}/close_chatВид тела запроса: