464 lines
50 KiB
HTML
464 lines
50 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="ru">
|
||
|
||
<head>
|
||
<title>Настройка запросов взаимодействия в произвольном мессенджере</title>
|
||
<meta name="generator" content="Help+Manual" />
|
||
<meta name="keywords" content="" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="description" content="Общие сведения Наименование, типы методов и структура JSON-ответов разработаны в соответствии с принятыми стандартами ELMA365 и не могут быть изменены клиентом. Базовые URL и..." />
|
||
<meta name="picture" content="" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:title" content="Cправка по Low-code платформе ELMA365" />
|
||
<meta property="og:url" content="https://elma365.com/ru/help" />
|
||
<meta property="og:image" content="" />
|
||
<meta property="og:site_name" content="ELMA365" />
|
||
<link rel="icon" href="favicon.png" type="image/png" />
|
||
|
||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
|
||
<link rel="stylesheet" href="./jquery-ui.min.css" />
|
||
<link rel="stylesheet" href="default.css" />
|
||
<link rel="stylesheet" href="./search-yandex.css" />
|
||
<link rel="stylesheet" href="./article.css" />
|
||
<link rel="stylesheet" href="./glossary.css" />
|
||
<link rel="stylesheet" href="./theme.css" />
|
||
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="helpman_settings.js"></script>
|
||
<script type="text/javascript" src="helpman_topicinit.js"></script>
|
||
|
||
<script type="text/javascript" src="highlight.js"></script>
|
||
<script type="text/javascript">
|
||
$(document).ready(function(){highlight();});
|
||
</script>
|
||
</head>
|
||
|
||
<body>
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-M6ETBEC1R9"></script><script>window.dataLayer=window.dataLayer || []; function gtag(){dataLayer.push(arguments);}gtag('js', new Date()); gtag('config', 'G-M6ETBEC1R9');</script>
|
||
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
|
||
|
||
<header class="header elma-365">
|
||
<div class="container">
|
||
<a class="header__logo" href="https://elma365.com/ru/help">
|
||
<img src="./logo.svg" alt="header logo">
|
||
</a>
|
||
<!-- <div class="hero__search-form" id="search-panel">
|
||
<form class="search-form" onsubmit="ym(83179930,'reachGoal','poisk')">
|
||
<label class="search-form__label">
|
||
<span id="reset-search" class="search__icon"></span>
|
||
<input class="search-form__input" type="text">
|
||
</label>
|
||
<input class="search-form__submit" type="submit" value="Submit">
|
||
</form>
|
||
</div> -->
|
||
|
||
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
|
||
<div class="hero__search">
|
||
<a href="#" id="search-icon" class="hero__search-icon">
|
||
<img src="search-icon-white.svg" alt="search string">
|
||
</a>
|
||
<a href="#" id="side-menu-icon" class="hero__side-icon">
|
||
<img src="side_menu.svg" alt="side menu">
|
||
</a>
|
||
</div>
|
||
<div class="header__navi">
|
||
|
||
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://elma365.com/ru/help/platform/get-trial.html">Платформа</a></li><li><a class="project-link" href="https://elma365.com/ru/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://elma365.com/ru/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://elma365.com/ru/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://elma365.com/ru/help/projects/projects-functions.html">Проекты</a></li><li><a class="project-link" href="https://elma365.com/ru/help/business_solutions/-elma365-store.html">Бизнес-решения</a></li></ul></span></li><li><a href="https://api.elma365.com/ru/"target="_blank">API</a></li><li><a href="https://tssdk.elma365.com/"target="_blank">SDK</a></li><li><a href="https://community.elma365.com/" target="_blank">Community</a></li><li><a href="https://elma-academy.com/ru/" target="_blank">Академия</a></li><li><a href="https://elma365.com/ru/" target="_blank">Сайт ELMA365</a></li></ul>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</header>
|
||
|
||
|
||
|
||
|
||
<main class="main container">
|
||
|
||
<aside class="sidebar" id="sidebar">
|
||
<div class="sidebar__header">
|
||
<a class="header__logo" href="https://elma365.com/ru/help">
|
||
<img src="./logo-light.svg">
|
||
</a>
|
||
<span class="sidebar__close elma-365-close" id="close"></span>
|
||
</div>
|
||
<div class="sidebar__wrapper" id="side-menu">
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
<article class="article" id="article">
|
||
<div class="article-inner">
|
||
<div class="content">
|
||
<header class="article__header">
|
||
<div class="article__bread" style="display:flex; gap:10px;">
|
||
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
|
||
|
||
<div class="topic__breadcrumbs">
|
||
<p>Настроить работу в линиях > <a href="connection_to_line.html">Подключить мессенджеры к линии</a> > <a href="custom-messenger.html">Произвольный мессенджер</a> / Настройка запросов взаимодействия в произвольном мессенджере</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Настройка запросов взаимодействия в произвольном мессенджере</span></h1>
|
||
</div>
|
||
|
||
</header>
|
||
<section class="article__content">
|
||
<div class="scroll-top-inner">
|
||
<a href="#h1-article" class="scroll-top"></a>
|
||
</div>
|
||
<!-- Placeholder for topic body. -->
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Общие сведения</span></h2>
|
||
<p class="p_Normal">Наименование, типы методов и структура JSON-ответов разработаны в соответствии с принятыми стандартами ELMA365 и не могут быть изменены клиентом.</p>
|
||
<p class="p_Normal">Базовые URL и token для взаимодействия систем прописаны в настройках мессенджера. </p>
|
||
<p class="p_Normal">Логика работы оператора с сессиями клиентов реализуется в рамках стандартной логики решения <a href="service-functions.html" class="topiclink">ELMA365 Service</a>, предусмотренной для остальных мессенджеров, и не подразумевает дополнительной функциональности.</p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Настройка мессенджера </span></h2>
|
||
<p class="p_Normal">Подключение произвольного мессенджера к линии производится аналогично другим доступным мессенджерам. Подробнее об этом читайте в разделе <a href="connection_to_line.html" class="topiclink">«Подключить мессенджеры к линии»</a>. </p>
|
||
<p class="p_Normal">Перечень настроек, которые должны присутствовать в произвольном мессенджере для его подключения к линии: </p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal">наименование канала связи с мессенджером с типом <code><b>[string]</b></code>. Не влияет на взаимодействие с мессенджером. Служит дополнительной информацией и отображается в списке подключённых каналов для администратора и в сессии для оператора; </li><li class="p_Normal">токен доступа к API стороннего мессенджера (строка подтверждения) с типом <code><b>[string]</b></code>. Заполняется при создании канала для связи с мессенджером. Будет передаваться с каждым сообщением из системы ELMA365 в мессенджер. Может быть пустой;</li><li class="p_Normal">API URL мессенджера с типом <code><b>[string]</b></code> — URL (вебхук), на который будут отправляться сообщения из системы ELMA365.</li></ul>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">API</span></h2>
|
||
<p class="p_Normal">Ниже приведены методы для взаимодействия пользовательского мессенджера с ELMA365.</p>
|
||
<p class="p_Normal">Все методы должны возвращать следующие значения:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal">200 — ОК;</li><li class="p_Normal">401 — Unauthorized. Возвращается, если токен не совпадает;</li><li class="p_Normal">404 — Not Found. Возвращается, если канала не существует;</li><li class="p_Normal">500 — Internal Server Error. Возвращается в случае непредвиденной ошибки сервера.</li></ul>
|
||
<p class="p_Normal">Все методы имеют неизменяемый префикс — базовый URL, установленный настройками инсталляции ELMA365 и компании.</p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Методы взаимодействия ELMA365 с мессенджером (ELMA365 —> Messenger) </span></h3>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Запрос на подключение мессенджера (POST Connect)</span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Параметры для запроса:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>token</b></code> — токен, сформированный на стороне мессенджера; </li><li class="p_Normal"><code><b>channelId</b></code> — ID канала в системе ELMA365; </li><li class="p_Normal"><code><b>data.webhook</b></code> — вебхук для отправки запросов в систему ELMA365. </li></ul>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "connect",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "channelId": "ebf45efc-cc67-4b60-9e3f-121966ba9f30",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "webhook": "https://my-domen.com/api/messengers/external/other/webhook/ebf45efc-cc67-4b60-9e3f-121966ba9f30"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод отправки сообщения в мессенджер (POST Send Message) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Параметры для запроса:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>token</b></code> — токен, сформированный на стороне мессенджера; </li><li class="p_Normal"><code><b>channelId</b></code> — ID канала в системе ELMA365; </li><li class="p_Normal"><code><b>data.targetChatId</b></code> — ID чата в мессенджере;</li><li class="p_Normal"><code><b>data.text</b></code> — текст сообщения; </li><li class="p_Normal"><code><b>data.files</b></code> — массив приложений. </li></ul>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "message",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "channelId": "ebf45efc-cc67-4b60-9e3f-121966ba9f30",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "targetChatId": "chat1",</span><br />
|
||
<span class="f_CodeExample"> "text": "text",</span><br />
|
||
<span class="f_CodeExample"> "files": [</span><br />
|
||
<span class="f_CodeExample"> {</span><br />
|
||
<span class="f_CodeExample"> "name": "file1.png",</span><br />
|
||
<span class="f_CodeExample"> "size": 12345,</span><br />
|
||
<span class="f_CodeExample"> "URL": "https://elma365.com/ru/img/partners/partners-hero.png"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample"> ]</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод отправки результата приёма сообщения (POST Send Message Outcome) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Если сообщение обработано успешно, то <code><b>success</b></code> будет в значении <code><b>true</b></code>.</p>
|
||
<p class="p_Normal">Если <code><b>success = false</b></code> или ответа не последовало, повторите отправку сообщения с указанным <code><b>messageId</b></code>.</p>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "messageOutcome",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "success": </span><span class="f_CodeExample" style="font-weight: bold;">true</span><span class="f_CodeExample">,</span><br />
|
||
<span class="f_CodeExample"> "messageId": "message1"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод запроса данных пользователя (POST Get User Info) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Параметры для запроса:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>token</b></code> — токен, сформированный на стороне мессенджера; </li><li class="p_Normal"><code><b>channelId</b></code> — ID канала в системе ELMA365; </li><li class="p_Normal"><code><b>data.userId</b></code> — ID пользователя в мессенджере.</li></ul>
|
||
<p class="p_Normal">Ответ:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>Avatar</b></code> — файл в base64. </li></ul>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "userInfo",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "userId": "user1"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Пример ответа на запрос:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "id": "extUser1"</span><br />
|
||
<span class="f_CodeExample"> "username": "JohnDoe"</span><br />
|
||
<span class="f_CodeExample"> "phoneNumber": "89990002266"</span><br />
|
||
<span class="f_CodeExample"> "avatar": "data:image/jpeg;base64,/9j/4AAQSkZJRg... "</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод для получения метки о прочтении сообщения (POST Mark Message As Read) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "markAsRead",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "messageId": "message1"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод запроса-оповещения о разрыве соединения с мессенджером (POST Disconnect) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/test/webhook</span></p>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "disconnect",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "channelId": "ebf45efc-cc67-4b60-9e3f-121966ba9f30"</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Методы взаимодействия мессенджера с ELMA365 (Messenger —> ELMA365) </span></h3>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод отправки сообщения в ELMA365 (POST Send Message)</span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/other/webhook/8ec8228f-7ff2-462b-a8d7-4f9b3f62c253</span></p>
|
||
<p class="p_Normal">Параметры для запроса:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>token</b></code> — токен, сформированный на стороне мессенджера; </li><li class="p_Normal"><code><b>data.externalMessageId</b></code> — ID сообщения в мессенджере; </li><li class="p_Normal"><code><b>data.externalChatId</b></code> — ID чата в мессенджере; </li><li class="p_Normal"><code><b>data.externalUserId</b></code> — ID пользователя в мессенджере; </li><li class="p_Normal"><code><b>data.text</b></code> — текст сообщения;</li><li class="p_Normal"><code><b>data.files</b></code> — массив приложений.</li></ul>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "message",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm2",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "externalMessageId": "message63",</span><br />
|
||
<span class="f_CodeExample"> "externalChatId": "chat12",</span><br />
|
||
<span class="f_CodeExample"> "externalChatName": "Chat name: chat 12",</span><br />
|
||
<span class="f_CodeExample"> "externalUserId": "user12",</span><br />
|
||
<span class="f_CodeExample"> "text": "text test",</span><br />
|
||
<span class="f_CodeExample"> "files": [</span><br />
|
||
<span class="f_CodeExample"> {</span><br />
|
||
<span class="f_CodeExample"> "name": "file1.png",</span><br />
|
||
<span class="f_CodeExample"> "URL": "https://elma365.com/ru/img/partners/partners-hero.png"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample"> ]</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод запроса-оповещения о разрыве соединения по инициативе мессенджера (POST Disconnect) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/other/webhook/ebf45efc-cc67-4b60-9e3f-121966ba9f30</span></p>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "disconnect",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm"</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h4 class="p_Heading4"><span class="f_Heading4">Метод запроса данных пользователя (POST Get User Info) </span></h4>
|
||
<p class="p_Normal">Строка запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/other/webhook/c5f9889f-0fcc-4112-a8bd-d1a93cd5ab53</span></p>
|
||
<p class="p_Normal">Пример тела запроса: </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "userInfo",</span><br />
|
||
<span class="f_CodeExample"> "token": "confirm",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "userId": "95806fe5-f8e8-460c-b2be-ce607068726c"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Запросы взаимодействия</span></h2>
|
||
<p class="p_Normal">Все запросы отправляются на вебхук (API URL мессенджера) и содержат в себе следующую информацию:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal">token мессенджера;</li><li class="p_Normal">тип запроса;</li><li class="p_Normal">данные запроса.</li></ul>
|
||
<p class="p_Normal">Все запросы должны получить ответ 200, как успешное выполнение запроса.</p>
|
||
<p class="p_Normal">Типы запросов для взаимодействия ELMA365 с мессенджером (ELMA365 → Messenger): </p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>Connect</b></code> — запрос на создание соединения. Используется всегда при создании нового канала в системе ELMA365. Служит для закрытия потребности стороннего мессенджера в подготовке данных. Если вам не требуется подготовка данных, верните код 200;</li><li class="p_Normal"><code><b>Message</b></code> — запрос на отправку сообщения клиенту от оператора;</li><li class="p_Normal"><code><b>UserInfo</b></code> — запрос на получение данных о пользователе: ФИО, логин (уникальный идентификатор), номер телефона, аватар и т. д.;</li><li class="p_Normal"><code><b>MarkMessageAsRead</b></code> — запрос на пометку сообщения, как прочитанное, в стороннем мессенджере;</li><li class="p_Normal"><code><b>Disconnect</b></code> — запрос-оповещение о прекращении взаимодействия с мессенджером.</li></ul>
|
||
<p class="p_Normal">Типы запросов для взаимодействия мессенджера с ELMA365 (Messenger → ELMA365): </p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><code><b>Message</b></code> — запрос на отправку сообщения оператору от клиента;</li><li class="p_Normal"><code><b>Disconnect</b></code> — запрос-оповещение о прекращении взаимодействия по инициативе мессенджера.</li></ul>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Примеры запросов и ответов при взаимодействии ELMA365 с произвольным мессенджером</span></h3>
|
||
<p class="p_Normal">Рассмотрим примеры следующих типов взаимодействия ELMA365 с произвольным мессенджером: <code><b>connect</b></code>, <code><b>message</b></code> и <code><b>userInfo</b></code>. </p>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="1" class="p_Normal">Настройка соединения ELMA365 с произвольным мессенджером для получения сообщений. </li></ol>
|
||
<p class="p_Normal">В <a href="custom-messenger.html#custom-messenger-settings" class="topiclink">настройках подключения мессенджера</a> в ELMA365 укажите его вебхук, а также строку подтверждения. После соединения в системе создаётся канал с уникальным ID. На вебхук мессенджера придёт событие типа <code><b>connect</b></code>, содержащее вебхук ELMA365:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "connect",</span><br />
|
||
<span class="f_CodeExample"> "token": "123",</span><br />
|
||
<span class="f_CodeExample"> "channelId": "ebf45efc-cc67-4b60-9e3f-121966ba9f30",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "webhook": "https://my-domen.com/api/messengers/external/other/webhook/ebf45efc-cc67-4b60-9e3f-121966ba9f30"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Ответ: 200 — ОК.</p>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="2" class="p_Normal">Отправка сообщения из мессенджера в ELMA365. </li></ol>
|
||
<p class="p_Normal">Производится в несколько этапов:</p>
|
||
<p class="p_Normal">1. Строка запроса:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">https://my-domen.com/api/messengers/external/other/webhook/ebf45efc-cc67-4b60-9e3f-121966ba9f30</span></p>
|
||
<p class="p_Normal">Тело запроса:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "message",</span><br />
|
||
<span class="f_CodeExample"> "token": "123",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "externalMessageId": "</span><span class="f_CodeExample">extMsgId</span><span class="f_CodeExample">",</span><br />
|
||
<span class="f_CodeExample"> "</span><span class="f_CodeExample">externalChatId</span><span class="f_CodeExample">": "</span><span class="f_CodeExample">extChat1</span><span class="f_CodeExample">",</span><br />
|
||
<span class="f_CodeExample"> "externalChatName": "Chat name: chat 12",</span><br />
|
||
<span class="f_CodeExample"> "externalUserId": "</span><span class="f_CodeExample">extUser1</span><span class="f_CodeExample">",</span><br />
|
||
<span class="f_CodeExample"> "text": "</span><span class="f_CodeExample">sample</span><span class="f_CodeExample">",</span><br />
|
||
<span class="f_CodeExample"> "files": [</span><br />
|
||
<span class="f_CodeExample"> {</span><br />
|
||
<span class="f_CodeExample"> "name": "file1.png",</span><br />
|
||
<span class="f_CodeExample"> "URL": "https://elma365.com/ru/img/partners/partners-hero.png"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample"> ]</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Ответ: 200 — ОК.</p>
|
||
<p class="p_Normal">2. После того как в ELMA365 будет принято сообщение, от системы отправится запрос на получение информации о пользователе. На вебхук мессенджера придёт событие типа <code><b>userInfo</b></code>:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "userInfo",</span><br />
|
||
<span class="f_CodeExample"> "token": "123",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "userId": "extUser1"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Пример ответа с информацией о пользователе от мессенджера:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "id": "extUser1"</span><br />
|
||
<span class="f_CodeExample"> "username": "JohnDoe"</span><br />
|
||
<span class="f_CodeExample"> "phoneNumber": "89990002266"</span><br />
|
||
<span class="f_CodeExample"> "avatar": "data:image/jpeg;base64,/9j/4AAQSkZJRg... "</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">3. Когда информация о пользователе поступит в ELMA365, на вебхук мессенджера придёт событие типа <code><b>messageOutcome</b></code> с оповещением об успешном получении сообщения системой:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "messageOutcome",</span><br />
|
||
<span class="f_CodeExample"> "token": "123",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "success": true,</span><br />
|
||
<span class="f_CodeExample"> "messageId": "message1"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Ответ: 200 — ОК.</p>
|
||
<ol style="list-style-type:upper-roman">
|
||
<li value="3" class="p_Normal">Получение сообщения от ELMA365.</li></ol>
|
||
<p class="p_Normal">На вебхук мессенджера приходит событие типа <code><b>message</b></code>:</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">{</span><br />
|
||
<span class="f_CodeExample"> "type": "message",</span><br />
|
||
<span class="f_CodeExample"> "token": "123",</span><br />
|
||
<span class="f_CodeExample"> "channelId": "ebf45efc-cc67-4b60-9e3f-121966ba9f30",</span><br />
|
||
<span class="f_CodeExample"> "data": {</span><br />
|
||
<span class="f_CodeExample"> "targetChatId": "extChat1",</span><br />
|
||
<span class="f_CodeExample"> "text": "message from ELMA",</span><br />
|
||
<span class="f_CodeExample"> "files": [</span><br />
|
||
<span class="f_CodeExample"> {</span><br />
|
||
<span class="f_CodeExample"> "name": "file1.png",</span><br />
|
||
<span class="f_CodeExample"> "size": 12345,</span><br />
|
||
<span class="f_CodeExample"> "URL": "https://elma365.com/ru/img/partners/partners-hero.png"</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample"> ]</span><br />
|
||
<span class="f_CodeExample"> }</span><br />
|
||
<span class="f_CodeExample">}</span></p>
|
||
<p class="p_Normal">Ответ: 200 — ОК.</p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="custom-messenger.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">custom-messenger.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="connect-bot.html">
|
||
<span class="bottom-nav__link">connect-bot.html</span> <span
|
||
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
|
||
</a>
|
||
|
||
</div>
|
||
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
|
||
<div class="feedback-wrap"><div class="feedback" id="feedback"><span><b>Была ли статья полезной?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx">Спасибо за ваш отзыв!</div><div id="feedback-success-popup"><div class="wrap"><button type="button" class="feedback-popup-close">×</button><svg width="44" height="44" viewBox="0 0 44 44" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_212_2187)"><path d="M22 0.6875C10.2294 0.6875 0.6875 10.2294 0.6875 22C0.6875 33.7706 10.2294 43.3125 22 43.3125C33.7706 43.3125 43.3125 33.7706 43.3125 22C43.3125 10.2294 33.7706 0.6875 22 0.6875ZM22 40.5625C11.8023 40.5625 3.4375 32.3078 3.4375 22C3.4375 11.8024 11.6922 3.4375 22 3.4375C32.1977 3.4375 40.5625 11.6922 40.5625 22C40.5625 32.1976 32.3078 40.5625 22 40.5625ZM34.1713 16.933L18.6613 32.3186C18.257 32.7197 17.604 32.7171 17.203 32.3128L9.82283 24.873C9.42176 24.4686 9.42434 23.8157 9.82867 23.4146L10.5609 22.6884C10.9652 22.2873 11.6181 22.2899 12.0192 22.6942L17.9468 28.6697L31.9926 14.7366C32.3969 14.3356 33.0498 14.3382 33.4509 14.7425L34.1772 15.4747C34.5783 15.879 34.5757 16.532 34.1713 16.933Z" fill="#27AE60"></path></g><defs><clipPath id="clip0_212_2187"><rect width="44" height="44" fill="white"></rect></clipPath></defs></svg><p>Ваш отзыв успешно отправлен!</p><span>Спасибо за обратную связь.</span></div></div><div class="feedback__popup" id="feedback__popup_why"><button type="button" class="feedback-popup-close">×</button><div class="feedback__popup-header">Уточните, почему:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Рекомендации не помогли</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Текст трудно понять</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Нет ответа на мой вопрос</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Содержание статьи не соответствует заголовку</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Другая причина</label></div><div class="feedback__popup" id="feedback__popup-other"><button type="button" class="feedback-popup-close">×</button> <div class="feedback__popup-header">Расскажите, что вам не понравилось в статье:</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Отправить"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg"/><span class="feedback-form__btn-group_yes-btn">Да</span></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg"/><span class="feedback-form__btn-group_no-btn">Нет</span></label></div><select name="category"><option disabled>Выберите вариант</option><option value="bad_recommendation" selected>Рекомендации не помогли</option><option value="difficult_text">Текст трудно понять</option><option value="no_answer">Нет ответа на мой вопрос</option><option value="bad_header">Содержание статьи не соответствует заголовку</option><option value="other_reason">Другая причина</option></select><input type="submit"></form></div></div>
|
||
|
||
</section>
|
||
</div>
|
||
<aside class="article__sidebar" style="display:none">
|
||
<input type="checkbox" />
|
||
<div class="article__arrow"></div>
|
||
<div class="table-of-contents elma365-right" id="toc2Content">
|
||
<h3 class="h3-toc">В этой статье</h3>
|
||
<nav id="toc2"></nav>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</article>
|
||
</main>
|
||
<footer class="footer">
|
||
<div class="footer-container">
|
||
<div class="footer-mobile">
|
||
|
||
<ul class="footer-mobile__list"><li><a href="https://api.elma365.com/ru/" target="_blank">API</a></li><li><a href="https://tssdk.elma365.com/" target="_blank">TS SDK</a></li><li><a href="https://community.elma365.com/" target="_blank">Community</a></li><li><a href="https://elma-academy.com/ru/elma365" target="_blank">Академия</a></li></ul><ul class="footer-mobile__list"><li><a href="https://elma365.com/ru/help/platform/get-trial.html">Платформа</a></li><li><a href="https://elma365.com/ru/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://elma365.com/ru/help/service/service-functions.html">Service</a></li><li><a href="https://elma365.com/ru/help/projects/projects-functions.html">Проекты</a></li></ul>
|
||
|
||
|
||
</div>
|
||
<div class="container">
|
||
<div class="footer-wrap">
|
||
|
||
<div><span class="mobile-question-popup">Отправить фидбэк</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Задать вопрос</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Отправить"></div></form><div class="hidden fade-in question-success-xs">Ваш фидбэк отправлен.</div></div>
|
||
|
||
<div class="footer-flex-b">
|
||
<div class="footer-top">
|
||
<span class="footer-copy">© 2025
|
||
ELMA365
|
||
|
||
|
||
</span>
|
||
|
||
<a href="https://navigator.sk.ru/orn/1122971" target="_blank">
|
||
<img src="sk-resident.svg" alt="sk icon" class="footer-img" width="117" height="34">
|
||
</a>
|
||
|
||
</div>
|
||
<div class="footer-line">
|
||
|
||
<div class="footer-line-copy">
|
||
<span class="footer-copy">© 2025
|
||
ELMA365
|
||
|
||
|
||
</span>
|
||
</div>
|
||
|
||
<ul class="footer-list">
|
||
|
||
<li class="footer-item"><a href="https://elma365.com/ru/" target="_blank" class="footer-link" style="color: #0D4A75;"><img src="browse.svg" alt="browse icon" class="footer-img">elma365.com</a></li><li class="footer-item"><a href="https://www.youtube.com/user/ELMABPM" target="_blank" class="footer-link"><img src="yt.svg" alt="youtube icon" class="footer-img"></a></li><li class="footer-item"><a href="https://vk.com/elma_bpm" target="_blank" class="footer-link"><img src="vk.svg" alt="vk icon" class="footer-img"></a></li><li class="footer-item"><a href="https://t.me/elmaday" target="_blank" class="footer-link"><img src="tg.svg" alt="telegram icon" class="footer-img"></a></li><li class="footer-item"><a href="https://dzen.ru/elma" target="_blank" class="footer-link"><img src="dzen.svg" alt="dzen icon" class="footer-img"></a></li>
|
||
|
||
|
||
<li class="footer-item">
|
||
<a href="https://navigator.sk.ru/orn/1122971" target="_blank">
|
||
<img src="sk-resident.svg" alt="sk icon" class="footer-img" width="117" height="34">
|
||
</a>
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<a href="#" class="arrow-top"></a>
|
||
</div>
|
||
|
||
</footer>
|
||
<!-- <script type="text/javascript" src="jquery1.min.js"></script>-->
|
||
<iframe name="hmnavigation" style="display:none!important"></iframe>
|
||
<!--<script src="./jquery-ui.js"></script> -->
|
||
<script src="./jquery-ui.min.js"></script>
|
||
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
|
||
<script src="./jquery.tocify.min.js"></script>
|
||
<script src="./TypoReporter.min.js"></script>
|
||
<script src="./google-search.js"></script>
|
||
<script src="./main.js"></script>
|
||
</body>
|
||
|
||
</html>
|