Интеграция с Chat2Desk
🧾 Интеграция Chat2Desk с Агентом
Chat2Desk – одна из омниканальных платформ для общения с клиентами в текстовых каналах. Вы можете использовать её в качестве канала для публикации вашего Агента в качестве бота-оператора. Ознакомиться с пользовательской документацией вы можете по этой ссылке.
🔧 Подключение
1. Конфигурация бота на стороне Chat2Desk
- Зайдите в аккаунт Chat2Desk
- Перейдите в раздел Настройки → API
- Нажмите "Показать" API-токен и введите пароль учетной записи администратора аккаунта
- Скопируйте полученный API-токен
2. Конфигурация канала агента в Платформе
Агенту необходимо создать и настроить Канал Проекта с Коннектором "Chat2Desk" .
- Кликните по кнопке настроек Агента
- Нажмите кнопку Add channel
- Откроется панель выбора Конечный канал
- Выберите Chat2Desk
Откроется панель создания Канал Проекта.
- По необходимости пропишите заголовок для данного Канал Проекта в поле названия с плейсхолдером New channel
- Пропишите ссылку https://api.chat2desk.com/v1 или https://api.chat2desk.kz/v1 в поле Chat2Desk webhook URL
- Вставьте API-токен, скопированный в аккаунте Chat2Desk, в поле Chat2Desk token
- Если необходимо настроить автоназначение чатов на конкретного оператора, вставьте id оператора в поле Chat2Desk operator ID
- По необходимости переключите тумблер Receive service messages , чтобы получать Сервисные сообщения канала
Для сохранения Канал Проекта без его активации, нажмите кнопку CREATE.
Для сохранения и активации Канал Проекта, нажмите кнопку CREATE & ACTIVATE.
✅ Канал Проекта будет сохранен и активирован, если:
- Агент обучен
- Токен в поле Chat2Desk token уникален (нет ли активных Канал Проекта того же типа с тем же значением в поле)
- Будет доступен адрес Канал Проекта
- Удастся зарегистрировать вебхук канала
⚠️ Канал Проекта будет сохранен, но не активирован, если одно или больше условий не будут выполнены.
Для отмены создания Канал Проекта нажмите кнопку CANCEL.
🛠 Редактирование и удаление Канала Агента
- Для редактирования Канал Проекта, необходимо кликнуть по его иконке на карточке Агента
- Чтобы отредактировать значение в любом поле, кликните по полю и впишите новое значение
- Чтобы применить изменения к активированному Канал Проекта, нажмите кнопку APPLY.
✅ Изменения будут применены, если:
- Агент обучен
- Токен в поле Chat2Desk token уникален
- Доступен адрес Канал Проекта
- Удалось зарегистрировать вебхук канала
⚠️ Изменения не будут применены, если одно или больше условий не будут выполнены
- Чтобы деактивировать Канал Проекта, нажмите кнопку DEACTIVATE
- Чтобы применить изменения к деактивированному Канал Проекта, нажмите кнопку SAVE
- Чтобы применить изменения и активировать Канал Проекта, нажмите кнопку SAVE & ACTIVATE
✅ Изменения будут применены и Канал Проекта будет активирован, если:
- Агент обучен
- Токен уникален
- Доступен адрес Канал Проекта
- Удалось зарегистрировать вебхук
⚠️ Изменения будут применены, но Канал Проекта не будет активирован, если одно или больше условий не будут выполнены
- Чтобы отменить внесение изменений, нажмите кнопку CANCEL
- Чтобы удалить Канал Проекта, нажмите кнопку DELETE
💬 Общение
Подключение Бота как оператора в Chat2Desk
В Chat2Desk возможно настроить автоназначение чатов на конкретного оператора. При выключенном автоназначении чаты поступают в общую очередь.
Если необходимо, чтобы Бот обрабатывал только чаты, назначенные на конкретного оператора, нужно подключить Бота в качестве конкретного оператора и настроить назначение новых чатов на этого оператора.
В случае, если в настройках Канал Проекта не указан id оператора, Бот будет принимать все сообщения из общей очереди, т.е. не распределенные на какого-либо конкретного оператора.
Чтобы настроить подключение Бота в качестве оператора в Chat2Desk, необходимо:
- Зайти в аккаунт Chat2Desk
- Перейти в раздел Настройки → Операторы → Список
- Нажать кнопку Создать оператора
- Заполнить все данные для нового оператора
- Авторизоваться в качестве только что созданного оператора
- Получить API-токен, как описано в шаге 3 раздела "Конфигурация бота на стороне Chat2Desk"
- Перейти в приложение Postman и отправить следующий запрос:
Метод: GET
URL: https://api.chat2desk.com/v1/operators/
Headers: Authorization: {API-токен из личного кабинета}
В ответ на запрос будет получен список с информацией о всех операторах следующего формата:
{"data": [{"id": "id оператора","email": "электронная почта","first_name": "имя","last_name": "фамилия","role": "роль","phone": "номер телефона","avatar": "аватар","last_visit": "время последнего логина в аккаунт","online": 1,"offline_type": null,"external_id": null,"opened_dialogs": "количество открытых диалогов","status_id": 0}],"meta": {"total": "количество операторов","limit": "лимит на количество операторов","offset": 0},"status": "success"}
Необходимо найти информацию по оператору, созданному для подключения Бота, и скопировать значение параметра "id".
Данное значение необходимо вставить в поле Chat2Desk operator ID настроек Канал Проекта Chat2Desk.
Переменная |
Конечный канал |
Переменная в запросе из канала |
Примечания |
---|---|---|---|
channel_message_id |
Chat2Desk |
message_id |
id сообщения, которое присвоил ему Chat2Desk (реализовано только в C2D) |
channel_message_recipient |
Chat2Desk |
operator_id |
Бот в Chat2Desk является оператором и в эту переменную вы получите его id (реализовано только в C2D) |
channel_visitor_id |
Chat2Desk |
client_id |
— |
channel_conversation_id |
Chat2Desk |
dialog_id |
— |
channel_visitor_phone |
Chat2Desk |
client.phone |
После отправки рассылки Слотом Notification в эту переменную попадает номер телефона, на который была отправлена рассылка |
channel_visitor_firstname |
Chat2Desk |
client.name |
— |
channel_visitor_lastname |
Chat2Desk |
— |
— |
channel_visitor_account |
Chat2Desk |
— |
— |
channel_visitor_email |
Chat2Desk |
— |
— |
channel_visitor_source |
Chat2Desk |
— |
— |
channel_visitor_auth |
Chat2Desk |
— |
— |
channel_visitor_location |
Chat2Desk |
— |
— |
Сообщение |
Конечный канал |
Client message |
Описание |
---|---|---|---|
Закрытие диалога в Chat2Desk |
Chat2Desk |
Строкаc2d: dialog closed |
Сервисное сообщение поступает в client_message при событии закрытии диалога в Chat2Desk через функцию Закрыть чат |
Функционал общения |
Конечный канал |
Доступность в канале |
Примечания |
---|---|---|---|
Использование маркдауна |
Chat2Desk |
Частично |
Поддерживается в виджете. Отображение текста, размеченного с помощью Markdown, в остальных каналах зависит от самих каналов. Поддерживаются следующие типы разметки:*курсив*,_курсив_,__жирный шрифт__,*__жирный курсив__*,[ссылка](http://www.example.com/) |
channel_chat_id |
Chat2Desk |
Да |
Формат: `<client_id.channel_id> |
Сообщения дойдут до собеседника, если агент напишет первый в существующем чате |
Chat2Desk |
Да |
Кейсы: Оператор принял и остался в чате — бот может написать собеседнику. Оператор принял и закрыл чат — бот может написать собеседнику. |
Кнопки |
Chat2Desk |
Да |
— |
Перевод на оператора |
Chat2Desk |
Частично |
Change Chat Mode — нет, External Request — да |
Передача файлов в виде файлов от Агента (Attachment) |
Chat2Desk |
Да |
В виджет приходит иконка, ведущая на ссылку вида https://storage.chat2desk.com/companies/company_236200/messages/199219/Kalimba.mp3, при переходе автоматически воспроизводится содержимое. Изображения передаются в виде изображений. |
Передача файлов в виде ссылок от Агента (Attachment) |
Chat2Desk |
Частично |
Отображается аналогично переданному файлу, ссылка ведет на storage.chat2desk.com и файл автоматически открывается в браузере. Примечание: не отображается в Telegram |
Получение файла от Собеседника в сценарий |
Chat2Desk |
Да |
Формат: `file:photo |
Получение геолокации от собеседника в сценарии |
Chat2Desk |
Нет |
— |
Доставка сообщений более 1000 символов от Агента до Собеседника |
Chat2Desk |
Да |
— |
Получить ссылку на источник лида |
Chat2Desk |
Нет |
— |
Рассылки с помощью Notification |
Chat2Desk |
Нет |