Интеграция с внешним мессенджером

Вы можете настроить интеграцию с внешним мессенджером с использованием вебхуков. Вебхук (webhook) — это отправка запросов по событиям.

Настройка интеграции

1. Создайте канал с типом «Page messenger».

В панели управления перейдите в раздел «Каналы» и нажмите на кнопку «Добавить канал», расположенную в правом верхнем углу экрана.

Далее в окне «Добавление канала» из выпадающего списка выберите тип канала «Page messenger».

Укажите любые нужные параметры ниже и нажмите «Добавить канал».

Подробнее о создании каналов в статье «Каналы связи | Channels».

1. Создайте ИИ для входящих сообщений.

Для создания ИИ перейдите в раздел «ИИ» и нажмите на кнопку «Создать ИИ».

Подробнее в статье «Создание и настройка ИИ | AI».

1. Создайте интеграцию с типом «Все сообщения» для получения вебхуков о новых сообщениях.

Для создания интеграции с типом «Все сообщения» перейдите в раздел «Интеграции» и нажмите на кнопку «Создать интеграцию».

В окне «Добавление интеграции» из выпадающего списка выберите тип интеграции «Another».

В поле «Название» укажите название. В поле «webhook url» укажите URL для получения вебхуков. Затем в выпадающем списке «Выберите тип webhook» выберите «Все сообщения». Нажмите «Создать интеграцию».

Подробнее в статье «Интеграции | Integration».

1. Создайте задание с типом «Web».

Для создания задания с типом «Web» перейдите в раздел «Задания» и нажмите на кнопку «Создать задание».

В окне «Создать задание» в выпадающем списке «Тип» выберите «Web».

Далее выберите формат работы сервиса, созданные до этого канал, менеджера, ИИ, интеграцию и нажмите на кнопку «Создать задание».

После создания скопируйте id задания, он понадобится для запросов по API.

Подробнее в статье «Задания | Tasks».

1. Интегрируйте метод отправки сообщения от пользователя к ИИ:

send message external

post

🇬🇧 Send external message

🇷🇺 Отправить внешнее сообщение

🇺🇿 Tashqi xabar yuborish

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

task_idstringRequiredExample: 1721129985149x478019552540622850

chat_idstringRequired

unique chat_id in your system

Example: 123456789

messagestringRequiredExample: Test message via api

Responses

200

example

application/json

post

/api/1.1/wf/send_message_external

HTTPcURLJavaScriptPython

POST /api/1.1/wf/send_message_external HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "task_id": "1721129985149x478019552540622850",
  "chat_id": "123456789",
  "message": "Test message via api"
}

200

example

{
  "response": {
    "thread": {
      "Created By": "1708251849975x447112648674775600",
      "Created Date": 1731336491590,
      "Modified Date": 1731336491593,
      "_id": "1731336491572x316716105037601100",
      "ai_thread_id": "thread_zZ32RNJ0WIH6rzBLS719LylE",
      "chat_id": "123456789",
      "close": false,
      "company": "1708251850060x460235863640434700",
      "contact": "123456789",
      "count_message": 0,
      "get_contact": false,
      "interest": false,
      "is_bot": false,
      "operator": false,
      "success": false,
      "task": "1827394658203x947362851049736284",
      "title": "API chat 123456789",
      "user_replied": false,
      "wh_get_contact": false,
      "wh_interest": false,
      "wh_success": false
    }
  },
  "status": "success"
}

Передавайте в chat_id уникальный идентификатор пользователя, например, Telegram user_id. По этому id будет объединяться контекст диалога, а вы сможете идентифицировать вебхуки.

1. Получите вебхук после генерации сообщения ИИ и отправьте сообщение в диалог с пользователем.

Список параметров и описание

Параметр	Описание параметра
channel_id	id канала. Используется для идентификации конкретного канала, через который осуществляется коммуникация. Может быть полезно для маршрутизации и обработки сообщений на вашей стороне.
close	Диалог закрыт/не закрыт. Используется для обозначения закрытия диалога или завершения коммуникации. Он сигнализирует о завершении сессии общения с пользователем или закрытии определенной задачи.
company_id	id компании. Используется для идентификации организации, к которой относится поступающее сообщение или команда. Позволяет точно обработать данные в контексте конкретной компании или отделения внутри системы.
contacts	Контакт. Используется для передачи информации о контакте, таких как телефон, юзернейм и др. Позволяет автоматически обновлять и синхронизировать контактные данные между системами.
external_chat_id	id диалога. Используется для идентификации конкретного чата или диалога в сторонней системе или мессенджере. Позволяет связывать сообщения и взаимодействия с нужным внешним диалогом.
get_contact	Контакт получен/не получен. Информирует, что в диалоге пользователь прислал телефон, почту и др.
interest	Проявление интереса есть/нет. Используется для обозначения заинтересованности клиента или активации интереса к определенному продукту или услуге.
is_bot	Диалог ведется с роботом да/нет. Если да, то наша система определила, что данный диалог ведется с ботом.
manager_id	id менеджера. Используется для идентификации конкретного менеджера, связанного с задачей или взаимодействием.
message_id	id сообщения. Используется для уникальной идентификации конкретного сообщения. Позволяет отслеживать, обрабатывать и ссылаться на определенные сообщения в системе.
message_text	Текст сообщения. Используется для передачи текста сообщения. Он позволяет получить и обработать содержимое сообщения, отправленного пользователем или системой, в нужном формате.
message_type	Тип сообщения бот/оператор/пользователь.
operator	Диалог передан на оператора да/нет.
panel_url	Ссылка на диалог в личном кабинете с возможностью ответить пользователю.
share_url	Ссылка на диалог только для просмотра, без возможности ответить.
success	Диалог является успешным да/нет.
task_id	id задания. Используется для уникальной идентификации задачи в системе.
thread_id	id треда. Используется для идентификации диалога с пользователем.
title	Заголовок. ФИО пользователя.
wh_type	Тип вебхука. Обозначает тип вебхука, событий или действий. Он помогает различать, какое именно событие произошло или какая информация передается через вебхук, для соответствующей обработки.

Пример вебхука:

{
  "channel_id": "5q",
  "close": "no",
  "company_id": "1708251850060x460235863640434700",
  "contacts": "123456789",
  "external_chat_id": "123456789", // Ваш id диалога, можете произвести идентификацию по нему
  "get_contact": "no",
  "interest": "no",
  "is_bot": "no",
  "manager_id": "4q",
  "message_id": "1731336491876x582725124419040400",
  "message_text": "It looks like you are testing API functionality by sending a test message along with metadata like a timestamp and timezone. If you have any questions or need assistance with this, feel free to ask!",
  "message_type": "bot", // Отправляйте в диалог с пользователем только типы bot и operator. Вебхук с типом user можно проигнорировать ответив статусом 200 
  "operator": "no",
  "panel_url": "https://selarti.com/panel?menu=chats&thread=1731336491572x316716105037601100",
  "share_url": "https://selarti.com/share?thread=1731336491572x316716105037601100",
  "success": "no",
  "task_id": "1721129985149x478019552540622850",
  "thread_id": "1731336491572x316716105037601100",
  "title": "API chat 123456789",
  "wh_type": "all_messages" // Настройте обработку только данного типа вебхуков, так как на ваш url могут поступать вебхуки других типов 
}

Появился новый параметр panel_url. Он содержит ссылку на диалог в вашем личном кабинете. В отличие от share_url, где можно только просмотреть диалог, с panel_url вы можете ответить пользователю напрямую. Обратите внимание, что для доступа потребуется авторизация и права доступа в компанию.

1. Попробуйте ответить пользователю через личный кабинет.