{"info":{"_postman_id":"6094784b-6ae8-494b-826a-2f403544c5d1","name":"Flomni - Custom Intergrations API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"1005345","collectionId":"6094784b-6ae8-494b-826a-2f403544c5d1","publishedId":"S17owpY2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-03-18T18:11:05.000Z"},"item":[{"name":"Список поддерживаемых каналов","item":[],"id":"8ec18048-c199-4feb-9376-c82e40754b13","description":"

Канал	Идентификатор	Описание
WhatsApp Business Account	wab
Apple Business	abc
Viber	vbr
Viber Business 2way	vb
Facebook Messenger	fb
Telegram	tlgr
VKontakte	vk
Онлайн чат	web
SMS сообщение	sms
Голосовой бот	voicer
WhatsApp	wa	Аккаунт для персонального использования
Электронная почта	email
Мобильное приложение (SDK)	mobile

","event":[{"listen":"prerequest","script":{"id":"4ba4a971-1ec6-43f4-887b-79d018084421","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"49473267-51c1-42e6-baaf-95b85a451238","type":"text/javascript","exec":[""]}}],"_postman_id":"8ec18048-c199-4feb-9376-c82e40754b13"},{"name":"Установка виджетов","item":[{"name":"Виджет выбора мессенджеров","item":[],"id":"cf9e7443-46b0-43cd-9257-eac70ac68d47","description":"

Установка

Для добавления на страницу кнопок с мессенджерами в нужном месте страницы необходимо добавить контейнер. Если интерфейс выбора мессенджеров реализуется на клиентской стороне, то данное действие пропускаем.

<div id=\"flomni\"></div>\n

Скопировать из ЛК код клиента добавить его на страницу

<script>\n      window.flomniConfig = {\n        clientKey: 'youKey' \n      }\n</script>    \n

Дополнительные параметры виджета

Добавляются в объект widget.flomniConfig

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Параметр	Тип данных	Описание
transaction	Object
transaction.value	String	Идентификатор клиента, по которому в дальнейшем будет производится отправка сообщений. Например, номер телефона или номер заказа.
transaction.type	String	Опциональный тип идентификатора, который используется для маркировки идентификатора. Для отправки по номеру телефона необходимо передавать значение 'phoneNum'.
forceUserHash	String	Переопределение идентификатора пользователя если виджет устанавливается в авторизованную часть приложения. Не рекомендуется использовать в случае если есть неавторизованная зона.

Публичное API

/**\n * Функция для открытия/закрытия popup,\n * - при передачи null будет закрывать popup\n * - в случаи указания неверного провайдера, будет выдать предупреждение в консоль\n */\nwindow.$flomni.linker.openPopup(provider: string|null): void \n/*\n * Свойство, возвращаем массив доступных провайдеров\n */\nwindow.$flomni.linker.providers: Array\n\n

\n","event":[{"listen":"prerequest","script":{"id":"b4bb905a-28d2-43eb-8baf-92ece36e688a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d007b3a-542d-4f67-9e1c-d4af5ecd9424","type":"text/javascript","exec":[""]}}],"_postman_id":"cf9e7443-46b0-43cd-9257-eac70ac68d47"},{"name":"Онлайн чат","item":[{"name":"Corner chat","item":[],"id":"76af1233-65e3-4544-b7ce-b414f6e9e314","description":"

Установка

Добавьте контейнер <div id='flomni'></div>
Добавьте код непосредственно перед закрывающим тегом

<script>\n  window.flomni = {\n    clientKey: 'youKey',\n    customizing: {\n      // пример как сделать чат с маленькой темой\n      // 'modules.chat.options.themeName': 'small'\n    },\n    visitorAttributes: {\n      // любые значения key: value, которые будут\n      // переданы при вызове invite для линкера\n      // testKey: 'testValue',\n      // testObject: { testSubKey: 'testSubValue' },\n    },\n    // отменяет рендер после загрузки бандла и передает управление API\n    onlyApiWay?: boolean\n    // принудительно выключает Invitation (only corner.chat)\n    noInvitation?: boolean\n    // принудительное открытие чата\n    // перебивает связку onlyApiWay & Flomni_API.chat.create(false)\n    openPagerImmediately?: boolean\n    threadId?: string\n    // Идентификатор и его тип, который надо сохранить в пользователя\n    transaction?: { type?: string, value: string }\n  }\n</script>\n\n<script src=\"https://i.v2.flomni.com/chat.corner.js\"></script>\n\n

\n","event":[{"listen":"prerequest","script":{"id":"36c2a750-7632-4905-acb7-d56abecbe7a3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"94d4389c-4f3b-4e34-b77c-6bae67da14c0","type":"text/javascript","exec":[""]}}],"_postman_id":"76af1233-65e3-4544-b7ce-b414f6e9e314"},{"name":"Embed chat","item":[],"id":"1fb639b4-51d1-4a14-a65b-5bcf7b899580","description":"

Установка

Добавьте код непосредственно перед закрывающим тегом

<script>\n    window.flomni = {\n        clientKey: 'youKey',\n    },\n    customizing: {\n      // пример как сделать чат с маленькой темой\n      // 'modules.chat.options.themeName': 'small'\n    },\n    visitorAttributes: {\n      // любые значения key: value, которые будут\n      // переданы при вызове invite для линкера\n      // testKey: 'testValue',\n      // testObject: { testSubKey: 'testSubValue' },\n    }\n</script>\n<script src=\"https://i.v2.flomni.com/chat.embedded.js\"></script>\n

Добавьте блок в место установки виджета контейнер <div id=\"flomni\"></div>.

\n","_postman_id":"1fb639b4-51d1-4a14-a65b-5bcf7b899580"}],"id":"1b7da29f-ab60-425b-b2a8-f80748b8383d","description":"

Варианты установки

базовый вариант - чат поверх страницы: чат располагается в нижнем правом углу поверх содержимого страницы
встроенный чат: чат располагается прямо на странице, в этом случае чат масштабируется по размерам родительского контейнера (чат занимает 100% выделенной контейнером-родителем ширины и высоты)

\n","event":[{"listen":"prerequest","script":{"id":"f7f3d252-ddae-4f15-ae91-88353ea2d7fe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"11a80f61-494d-405b-982d-e5069ae9eaf8","type":"text/javascript","exec":[""]}}],"_postman_id":"1b7da29f-ab60-425b-b2a8-f80748b8383d"},{"name":"Виджет сбора акцептов","item":[],"id":"5154c5fc-db84-40a4-be21-2759c2af2e94","description":"

Принцип работы

Виджет позволяет по идентификатору пользователя (им может быть номер телефона или любой другой уникальный идентификатор клиента) проверить наличие акцепта и, для случаев когда его нет, предложить пользователю подтвердить готовность получать сообщения от компании в нативном мессенджере (Messages для iOs, Google Hangouts для Android).

Установка

Идентификатор пользователя должен быть передан на страницу с виджетом через query параметр t. То есть ваш клиент должен переходить по ссылке вида https://yourcompany.com/something/?t=123987.
Добавьте в конец html страницы код:

   window.flomni = {\n      clientKey: 'youKey',\n      // Указать в каких мессенджерах предлагаем подписаться\n      // Если указан abc то форма перехода будет показана только на совместимых устройствах\n      // При отсутствии мессенджера в конфигурации аккаунта он будет пропущен\n      linkerConnectorMessengers: ['abc','tlgr'],\n      transaction: {\n            value: getSettingsFromQueryString(/t/i)\n      }\n   }\n\n

3. Добавьте функцию, которая будет получать значение из GET параметра страницы

</code>\n<br></div><div>function getSettingsFromQueryString (mask) {\n<br>  return (\n<br>    document.location.search\n<br>      .split('&')\n<br>      .map((pair) => decodeURI(pair))\n<br>      .map((pair) => pair.split('='))\n<br>      .filter((parts) => mask.test(parts[0]))\n<br>      .map((parts) => parts[1])[0]\n<br>  )\n<br>}\n<br></div><div>\n\n

\n","_postman_id":"5154c5fc-db84-40a4-be21-2759c2af2e94"},{"name":"Передача в виджет данных о клиенте","item":[],"id":"31172572-c2e4-4f6f-860e-1083b4249186","description":"

Для передачи дополнительной информации о клиенте с вашего сайта в бота или на рабочее место оператора необходимо передать данные в объекте visitorAttributes. Пример использования:

<script>\n    window.flomni = {\n        clientKey: 'youKey',\n        visitorAttributes: {\n            'Имя клиента' : 'Евгений'\n            'Тариф' : 'Бизнес'\n        }\n    }\n</script>\n

\n","_postman_id":"31172572-c2e4-4f6f-860e-1083b4249186"},{"name":"Установка нескольких виджетов на одной странице","item":[],"id":"8bec9fbc-0930-4b46-893d-72f1bfb9d366","description":"

По умолчанию все виджеты используют контйенер <div id=\"flomni\"></div> для отрисовки интерфейса.

Возможен вариант установки нескольких виджетов на одной странице. Это можно осуществить с помощью своих селекторов, указав свой для каждого приложения, например:

<script src=\"https://i.v2.flomni.com/chat.js\" data-selector=\"#chat\"></script>\n<script src=\"https://i.v2.flomni.com/linker.standalone.js\" data-selector=\".linker-standalone\"></script>\n

Таким образом мы можем разворачивать несколько виджетов на одной странице.

\n","event":[{"listen":"prerequest","script":{"id":"474fcd22-cd5f-43ef-9f81-4a3fad44bf79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0d4447f7-9eb3-45fd-a471-19a4dd6b91fb","type":"text/javascript","exec":[""]}}],"_postman_id":"8bec9fbc-0930-4b46-893d-72f1bfb9d366"},{"name":"Расширенные настройки инициализации","item":[],"id":"803d98c6-0ad5-4924-adc0-863c56678dd4","description":"

window.flomniConfig = {  \nclientKey: '5d0cd1707741de0009e061cb',  \n// language: 'ru',  \nonlyApiWay: false, // инициализации только через api если true  \n// welcomeMode: 'draft',  \n//transaction: {  \n//value: null\n//},  \n// forceUserHash: \"custom-permanent-id-for-user\",  \ncustomizing: {},  \nonToggle: (state) => {},  \nonLoad: (state) => {  \nconsole.log('The widget is loaded')  \n},  \nonLinked: ({ userHash }) => {  \nconsole.log('onLinked', userHash)  \n}  \n}\n\n

","_postman_id":"803d98c6-0ad5-4924-adc0-863c56678dd4"},{"name":"API виджетов","item":[],"id":"3409a313-f1d1-4291-9ff7-d3e7445f8955","description":"

/**\n * Создает instance чата.\n * При повторном вызове не будет создавать новый instance.\n * Принимает параметр — открыть чат. Актуально только для\n * corner чата.\n * (см. onlyApiWay параметр)\n */\nwindow.$flomni.chat.create(bool): object\n/**\n * Уничтожает instance чата.\n */\nwindow.$flomni.chat.destroy(): bool\n/**\n * Открывает/закрывает окно чата.\n * Без аргументов инвертирует состояние.\n */\nwindow.$flomni.chat.switchToggler(bool | undefined): void\n/**\n * Состояние окна чата.\n */\nwindow.$flomni.chat.togglerState(): bool\n/**\n * Открывает/закрывает окно чата в указанном потоке.\n * Идентификатор потока можно получить в Личном Кабинете.\n */\nwindow.$flomni.chat.openThread(string): void\n/**\n * Уничтожает instance чата.\n */\nwindow.$flomni.chat.destroy(): bool\n/**\n * Сброс сессии (создает новый userHash).\n */\nwindow.$flomni.chat.reset(): void\n/**\n * Скролит к debug message по actionId\n * @throws Если actionId не существует\n */\nwindow.$flomni.chat.scrollToDebugMessage(actionId: string): void\n/**\n * Функция для открытия/закрытия popup,\n * - при передачи null будет закрывать popup\n * - в случаи указания неверного провайдера, будет выдать предупреждение в консоль\n */\nwindow.$flomni.linker.openPopup(provider: string|null): void\n/*\n * Свойство, возвращаем массив доступных провайдеров\n */\nwindow.$flomni.linker.providers: Array\n\n

\n","event":[{"listen":"prerequest","script":{"id":"d8d6c8c3-d8cc-4cce-af66-895b89f7b5e2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"758d4883-2e90-4e94-9864-fd4edd4ad970","type":"text/javascript","exec":[""]}}],"_postman_id":"3409a313-f1d1-4291-9ff7-d3e7445f8955"},{"name":"Использование произвольных селекторов для установки виджетов","item":[],"id":"4b28d579-f27e-4d3a-8d4e-cc8aeed31762","description":"

Существует аттрибут [data-selector=\".mySelector\"], который позволяет указать специфичный контейнер, где приложение\nдолжно будет развернуться. Например:

<script src=\"https://i.flomni.com/linker.standalone.js\" data-selector=\".mySelector\"></script>\n

Приложение будет искать <div> class=\"mySelector\"></div> для развертывания внутри.

\n","_postman_id":"4b28d579-f27e-4d3a-8d4e-cc8aeed31762"},{"name":"Рецепты для custom css","item":[],"id":"0bff788d-10e0-420e-9f73-1504eee56db5","description":"

Удаление шапки из Fixed чата

[component='Pager'] [type='Embedded'] [component='Header'] {\ndisplay: none;\n}\n\n

Замена аватарки бота в чате

[type=\"BotAvatar\"] {\nbackground: url('https://icdn.lenta.ru/images/2021/10/06/19/20211006191440079/top7_ae1493ee25c9a6f4bea4f539b3d39967.jpg');\nbackground-size: contain;\n}\n\n

\n","_postman_id":"0bff788d-10e0-420e-9f73-1504eee56db5"}],"id":"d99c8434-8faf-402d-a8ee-f919fe514ab2","_postman_id":"d99c8434-8faf-402d-a8ee-f919fe514ab2","description":""},{"name":"Транспорт сообщений - каскад по номеру телефона","item":[{"name":"Отправка сообщений","item":[{"name":"Отправка сообщения с произвольным текстом (устарел)","id":"dd38aae6-622d-412d-8ece-4e648b1d6f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-SmartDelivery-Key","value":"{{X-SmartDelivery-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"mid\": \"произвольный идентификатор\",\r\n \"phoneNum\": \"79211234567\",\r\n \"message\": [\r\n {\r\n \"type\": \"default\",\r\n \"text\": \"Сообщение для всех каналов за исключением тех, которые переданы явно\",\r\n \"meta\": {\r\n \"metaVar1\": \"произвольная переменная\",\r\n \"metaVar2\": \"произвольная переменная\"\r\n }\r\n },\r\n {\r\n \"type\": \"wa\",\r\n \"text\": \"Сообщение для клиента в WhatsApp\",\r\n \"meta\": {\r\n \"metaVar1\": \"произвольная переменная\",\r\n \"metaVar2\": \"произвольная переменная\"\r\n },\r\n \"channelOffset\": 600000\r\n },\r\n {\r\n \"type\": \"wa\",\r\n \"text\": \"Сообщение для клиента в WhatsApp\",\r\n \"meta\": {\r\n \"metaVar1\": \"произвольная переменная\",\r\n \"metaVar2\": \"произвольная переменная\"\r\n },\r\n \"channelOffset\": 1200000\r\n }\r\n ],\r\n \"ttl\": 3600000,\r\n \"attributes\": [\"аттрибут строкой\"]\r\n}"},"url":"https://sd.flomni.com/message/","description":"

Параметр	Тип	Описание
mid	String	Произвольный идентификатор. Должен быть уникальным, по одному `mid` будет обработан только первый вопрос, остальные отобьются с ответом 409.
phoneNum	String	Номер телефона в формате 7XXXХХХХХХХ
message	Array	Массив сообщений, должен содержать как минимум 1 элемент
message.type	String	Для какого канала сообщение; возможные значения - default, wa, vbr, vk, fb, voicer, mobileapp.
message.meta	Object	Поля для передачи в бота или интерфейс оператора
channels	Array	Набор идентификаторов каналов, в которые разрешена отправка сообщения
ttl	Number	Время в мс в течение которого необходимо завершить обработку сообщения (минимум 10 минут)
attributes	Array	Массив произвольных строк, которые необходимо возвращать вместе со статусом сообщения

\n\n

Ответы сервера

\n\n

200 Сообщение успешно отправлено

\n\n

{
\"mid\": \"d19d602d-d5ba-43ca-9a42-2639b8f36750\"
}

mid - уникальный идентификатор сообщения

404 Получатель не найден

\n\n

409 Сообщение с указанным идентификатором уже отправлено

\n\n

417 Переданные параметры содержат ошибку

","urlObject":{"protocol":"https","path":["message",""],"host":["sd","flomni","com"],"query":[],"variable":[]}},"response":[{"id":"fdf18a58-ac78-4294-862d-2c24da4d0f38","name":"Сообщение добавлено в очередь на отправку","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"disabled":false,"key":"X-SmartDelivery-Key","value":"{{X-SmartDelivery-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNum\": \"79211234567\",\r\n \"message\": [\r\n {\r\n \"type\": \"default\",\r\n \"text\": \"Сообщение для всех каналов за исключением тех, которые переданы явно\",\r\n \"meta\": {\r\n \t\"metaVar1\": \"произвольная переменная\",\r\n \t\"metaVar2\": \"произвольная переменная\"\r\n }\r\n },\r\n {\r\n \"type\": \"wa\",\r\n \"text\": \"Сообщение для клиента в WhatsApp\",\r\n \"meta\": {\r\n \t\"metaVar1\": \"произвольная переменная\",\r\n \t\"metaVar2\": \"произвольная переменная\"\r\n }\r\n }\r\n ],\r\n \"ttl\": 3600000,\r\n \"attributes\": [\"аттрибут строкой\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sd.flomni.com/message/"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.13.12"},{"key":"Date","value":"Mon, 20 May 2019 15:20:02 GMT"},{"key":"Content-Length","value":"12"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"}],"cookie":[],"responseTime":null,"body":"{\n \"mid\": \"874dbfbd-140d-49d8-bd95-f84dac35096d\"\n}"}],"_postman_id":"dd38aae6-622d-412d-8ece-4e648b1d6f0e"},{"name":"Отправка шаблонного сообщения с подстановкой параметров","id":"84563f73-3144-4d9b-b4a9-977ff125d6d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-SmartDelivery-Key","value":"{{X-SmartDelivery-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"mid\": \"произвольный идентификатор\",\r\n \"phoneNum\": \"79211234567\",\r\n \"template\": {\r\n \"name\": \"Заказ оформлен\",\r\n \"vars\": {\r\n \"var1\": \"Строка 1\",\r\n \"var2\": \"Строка 2\"\r\n },\r\n \"meta\": {\r\n \"metaVar1\": \"произвольная переменная\",\r\n \"metaVar2\": \"произвольная переменная\"\r\n }\r\n },\r\n \"channels\": [\r\n \"viber\",\r\n \"sms\"\r\n ],\r\n \"attachments\": [\r\n {\r\n \"url\": \"https://example.com/logo.png\",\r\n \"filename\": \"Логотип\"\r\n }\r\n ],\r\n \"ttl\": 3600000,\r\n \"attributes\": [\r\n \"аттрибут строкой\"\r\n ]\r\n}"},"url":"https://sd.flomni.com/template-message/","description":"

Параметр	Тип	Описание
mid	String	Произвольный идентификатор. Должен быть иникальным, по одному `mid` будет обработан только первый вопрос, остальные отобъются с ответом 409.
phoneNum	String	Номер телефона в формате 7XXXХХХХХХХ
email	String	Электронная почта в формате test@flomni.com
template.name	String	Название используемого шаблона (выдается при регистрации)
template.vars	Object	Переменные для подставновки в текст сообщений. Все переменные должны быть типа String.
template.meta	Object	Поля для передачи в бота или интерфейс оператора.
ttl	Number	время в мс в течение которого необходимо завершить обработку сообщения (минимум 10 минут)
channels	Array	Набор идентификаторов каналов, в которые разрешена отправка сообщения
attributes	Array	Массив произвольных строк, которые необходимо возвращать вместе со статусом сообщения

\n\n

Ответы сервера

\n\n

200 Сообщение успешно отправлено

\n\n

{
\"mid\": \"d19d602d-d5ba-43ca-9a42-2639b8f36750\"
}

mid - уникальный идентификатор сообщения

404 Получатель не найден

\n\n

409 Сообщение с указанным идентификатором уже отправлено

\n\n

417 Переданные параметры содержат ошибку

","urlObject":{"protocol":"https","path":["template-message",""],"host":["sd","flomni","com"],"query":[],"variable":[]}},"response":[{"id":"c7872f29-bf4e-4907-8ab6-dcece116880c","name":"Сообщение добавлено в очередь на отправку","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"disabled":false,"key":"X-SmartDelivery-Key","value":"{{X-SmartDelivery-Key}}"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNum\": \"79211234567\",\r\n \"template\": {\r\n \"name\": \"Заказ оформлен\",\r\n \"vars\": {\r\n \t\"var1\": \"Строка 1\",\r\n \t\"var2\": \"Строка 2\"\r\n },\r\n \"meta\": {\r\n \t\"metaVar1\": \"произвольная переменная\",\r\n \t\"metaVar2\": \"произвольная переменная\"\r\n }\r\n },\r\n \"ttl\": 3600000,\r\n \"attributes\": [\"аттрибут строкой\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sd.flomni.com/template-message/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"mid\": \"874dbfbd-140d-49d8-bd95-f84dac35096d\"\n}"}],"_postman_id":"84563f73-3144-4d9b-b4a9-977ff125d6d4"}],"id":"138d2efe-273f-4fed-8879-5b6efc915ae0","_postman_id":"138d2efe-273f-4fed-8879-5b6efc915ae0","description":""},{"name":"Получение статуса сообщений","item":[{"name":"Способ 1 - HTTP запрос статуса","id":"accd4005-3e03-4295-ac73-3a1692d7da3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"url":"https://sd.flomni.com/status/?data=mid1,mid2,mid3","description":"

Допускается указать от 1 до 100 идентификаторов сообщений в одном запросе. Текущие статусы доставки возвращаются в виде массива.

\n","urlObject":{"protocol":"https","path":["status",""],"host":["sd","flomni","com"],"query":[{"description":{"content":"

Идентификаторы сообщений через запятую

\n","type":"text/plain"},"key":"data","value":"mid1,mid2,mid3"}],"variable":[]}},"response":[{"id":"6049da27-b90c-4b18-9a6a-6c85ebdfa114","name":"Получение статус отправленного сообщения","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","disabled":false},{"key":"X-SmartDelivery-Key","value":"{{X-SmartDelivery-Key}}","disabled":true}],"url":{"raw":"https://sd.flomni.com/status/?data=mid1,mid2,mid3","protocol":"https","host":["sd","flomni","com"],"path":["status",""],"query":[{"key":"data","value":"mid1,mid2,mid3","description":"Идентификаторы сообщений через запятую"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"mid\": \"f4d6eb91-13e9-4576-9100-25dd8931f8ae\",\n \"lastStatusUpdate\": \"2019-05-21T04:50:11.805Z\",\n \"status\": \"delivered\",\n \"code\": 7,\n \"channel\": \"viber\",\n \"attributes\": [\"аттрибут строкой\"],\n \"log\": [\n {\n \"status\": \"query\",\n \"when\": \"2019-05-21T04:50:11.678Z\"\n }\n ]\n }\n]"}],"_postman_id":"accd4005-3e03-4295-ac73-3a1692d7da3a"},{"name":"Способ 2 - Обратный вызов на URL клиента","id":"e5534954-a20d-4b4a-a6a2-ef79279ad2e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"mid\": \"f4d6eb91-13e9-4576-9100-25dd8931f8ae\",\r\n \"lastStatusUpdate\": \"2019-05-21T04:50:11.805Z\",\r\n \"status\": \"delivered\",\r\n \"code\": 7,\r\n \"channel\": \"viber\",\r\n \"log\": [\r\n {\r\n \"status\": \"query\",\r\n \"when\": \"2019-05-21T04:50:11.678Z\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL сервиса обработки статусов}}","description":"

Мы делаем 3 попытки передать статус доставки сообщения. Ожидаем от вас статус в ответе на запрос 200-299. Если ответ не получен или статус отличается от ожидаемого то следующая попытка передать статус состоится через 20 секунд (таймаут увеличивается экспоненциально при последующих попытках)

\n","urlObject":{"host":["{{URL сервиса обработки статусов}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5534954-a20d-4b4a-a6a2-ef79279ad2e1"}],"id":"aaf669e0-905b-4003-9148-d14b6990a673","description":"

Получение статуса сообщений возможно двумя способами:

HTTP запросом с указанием идентификатора одного или нескольких сообщений
Через механизм обратного вызова (Webhooks)

\n\n

mid - уникальный идентификатор сообщения
\nlastStatusUpdate - время последнего обновления статуса
\nstatus - последний статус сообщения
\ncode - числовой код статуса
\nchannel - канал в котором был получен статус
\nattributes - массив строк, переданных в одноименном поле при отправке сообщения
\nlog - массив, содержащий хронологию изменения статусов

Таблица соответствия статусов

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Код	Название статуса	Описание статуса
10	interact	Взаимодействие пользователя с сообщением (нажата кнопка, отправлено ответное сообщение). Возможен только для акцептированных контактов.
9	seen	Сообщение прочитано
7	delivered	Сообщение доставлено
6	undelivered	Сообщение не удалось доставить
5	expired	Время ожидания доставки сообщения истекло
3	pending	Сообщение доставляется. Временный статус, в логах не передается.
1	query	Запрос принят к обработке.
-	Not found	Сообщение не найдено

","_postman_id":"aaf669e0-905b-4003-9148-d14b6990a673"},{"name":"Передача uid вместе с сообщением","item":[],"id":"e51300e3-f902-4d82-bc2b-89099004b2ab","description":"

В отдельных случаях требуется вместе с сообщением передавать уникальный идентификатор клиента, который будет использоваться в дальнейшем для обмена информации между Flomni и ИТ системами Заказчика. В этом случае Заказчик на своей стороне должен обеспечить уникальность этих идентификаторов.

Этот идентификатор будет использоваться для запроса истории переписки, в статистических данных и в уведомлениях о новых событиях.

Для использования необходимо добавить поле uid в тело запроса на отправку сообщения.

{\n...\nuid: 'Уникальный идентификатор клиента',\n...\n}\n\n

\n","_postman_id":"e51300e3-f902-4d82-bc2b-89099004b2ab"},{"name":"Использование собственного домена для отправки электронной почты","item":[],"id":"61a11d54-1da6-43d3-b29d-6ed5a04a04f5","description":"

Вы можете использовать собственный домен для отправки email сообщений.

Определите домен, с которого будут отправляться сообщения. Для массовой отправки сообщений мы рекомендуем использовать отдельный поддомен, например, mail.youcompany.com. Это позволит избежать влияния настроек канала на основной почтовый домен.
Добавьте 2 TXT записи в настройки DNS для подтверждения прав на использование домена сервисом Flomni.
Добавьте MX записи. Эти записи позволят нам получать почту, направленную на адрес в данном домене. Даже если вы используете только исходящую отправку email сообщений мы рекомендуем добавить MX записи, так как это положительно сказывается на доставляемости сообщений.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Тип записи	Домен	Дополнительно
TXT	smtp._domainkey.mail.youcompany.com
TXT	mail.youcompany.com
MX	mail.youcompany.com	priority = 10
MX	mail.youcompany.com	priority = 10

После того как настройки произведены может пройти до 24 часов до момента обновления DNS записей. Не дожидаясь этого, можно добавить домен в настройки канала Email в Личном кабинете Flomni и начинать его использование.

\n","_postman_id":"61a11d54-1da6-43d3-b29d-6ed5a04a04f5"}],"id":"b2c5b8bb-c1e7-4916-a26a-79e364b67395","description":"

Отправка каскадных сообщений клиентам по номеру телефона. Для идентификации используется заголовок X-SmartDelivery-Key.
\nСписок идентификаторы каналов доставки сообщений здесь

\n","event":[{"listen":"prerequest","script":{"id":"995f4334-d601-4903-af4a-0c587eaf511c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92f722a9-3571-42b3-a328-29afd72d38f3","type":"text/javascript","exec":[""]}}],"_postman_id":"b2c5b8bb-c1e7-4916-a26a-79e364b67395"},{"name":"Работа с акцептированной базой контактов","item":[{"name":"Управление контактами клиентов","item":[{"name":"Получение данных контакта","id":"615467cc-4f00-48e5-bde4-60b5ccb52312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"url":"https://api.flomni.com/recipients?uid=your-unique-client-id","description":"

Метод возвращает данные клиента по уникальному номеру клиента.

Параметр	Тип	Описание
uid	String	Идентификатор клиента, по которому запрашиваем данные

Ответы сервера

200 Пользователь найден

\n\n

{
\"profile\": { ... },
\"metaData\": [ {...} ],
\"tags\": [ String ],
\"transactions\": [ {...} ],
}

Ответ:
profile.name - имя клиента в мессенджере,
profile.avatarUrl - ссылка на аватар,
metaData - объект с заполненными CRM полями контакта (название параметра - id CRM поля),
tags - массив идентификаторов тэгов, прикрепленных к контакту,
transactions[].phoneNum - номера телефона(-ов) прикрепленных к контакту

404 Пользователь не найден

","urlObject":{"protocol":"https","path":["recipients"],"host":["api","flomni","com"],"query":[{"key":"uid","value":"your-unique-client-id"}],"variable":[]}},"response":[],"_postman_id":"615467cc-4f00-48e5-bde4-60b5ccb52312"},{"name":"Добавление/изменение контакта","id":"7127faeb-8132-4c0c-848d-f659216a2d3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNum\": \"79112223344\",\r\n \"metaData\": {\r\n \"618a1f34691481002e0165be\": \"Данные в CRM поле3\"\r\n },\r\n \"profile\": {\r\n \"name\": \"Имя клиента3\",\r\n \"avatarUrl\": \"https://yandex.ru/avatar.gif\"\r\n },\r\n \"tags\": [\"60c39a168fc36e001dcd969a\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.flomni.com/recipients?uid=87eff5e6-890e-4936-9d41-c4909ac28417-draft-ru","description":"

Метод обновляет данные клиента по уникальному номеру клиента. Если клиента с указанным идентификатором не существует - он создается.

Параметр	Тип	Описание
uid	String	Идентификатор клиента, по которому запрашиваем данные

\n\n\n\n\n\n\n\n\n

Тело запроса	Тип	Описание
phoneNum	Number	Номер телефона в международном формате
metaData	Array	Данные CRM полей
tags	Array	Идентификаторов тэгов, которые надо добавить к контакту
profile.name	String	Имя контакта
profile.avatarUrl	String	Ссылка на аватар контакта

\n\n

Ответы сервера

200 Пользователь обновлен

\n\n

{
\"profile\": { ... },
\"metaData\": [ {...} ],
\"tags\": [ String ],
\"transactions\": [ {...} ],
}

417 Ошибка валидации

","urlObject":{"protocol":"https","path":["recipients"],"host":["api","flomni","com"],"query":[{"key":"uid","value":"87eff5e6-890e-4936-9d41-c4909ac28417-draft-ru"}],"variable":[]}},"response":[],"_postman_id":"7127faeb-8132-4c0c-848d-f659216a2d3a"},{"name":"Удаление контакта","id":"5c725c13-fa69-48a0-8905-4aad0f885ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"url":"https://api.flomni.com/recipients?uid=your-unique-client-id","description":"

Метод удаляет клиента по уникальному номеру клиента.

Параметр	Тип	Описание
uid	String	Идентификатор клиента, который надо удалить

\n\n

Ответы сервера

200 Пользователь удален

Метод удаляет номер телефона у контакта.

\n\n\n

Параметр	Тип	Описание
uid	String	Идентификатор клиента
phonenum	String	Номер телефона

\n\n

Ответы сервера

200 Пользователь удален

","urlObject":{"protocol":"https","path":["recipients","phonenum"],"host":["api","flomni","com"],"query":[{"description":{"content":"

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

\n","type":"text/plain"},"key":"uid","value":"your-unique-client-id"},{"description":{"content":"

Номер телефона, который надо отвязать от контакта

\n","type":"text/plain"},"key":"phoneNum","value":"79112223344"}],"variable":[]}},"response":[],"_postman_id":"aac7ce74-304b-495e-b4d3-e01843aa4ffe"},{"name":"Удаление номера тэгов из контакта","id":"e5799c44-38ce-425b-83f3-fd42aaf15ca2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"url":"https://api.flomni.com/recipients/tags?uid=your-unique-client-id&tags=60c39a168fc36e001dcd969a","description":"

Метод удаляет перечисленные тэги у контакта.

\n\n\n

Параметр	Тип	Описание
uid	String	Идентификатор клиента
tags	String	Идентификаторы тэгов через запятую

\n\n

Ответы сервера

200 Пользователь удален

","urlObject":{"protocol":"https","path":["recipients","tags"],"host":["api","flomni","com"],"query":[{"key":"uid","value":"your-unique-client-id"},{"description":{"content":"

Идентификаторы тэгов через запятую

\n","type":"text/plain"},"key":"tags","value":"60c39a168fc36e001dcd969a"}],"variable":[]}},"response":[],"_postman_id":"e5799c44-38ce-425b-83f3-fd42aaf15ca2"}],"id":"c3f7e6c9-d7ae-47ed-9b10-a62d335482b6","_postman_id":"c3f7e6c9-d7ae-47ed-9b10-a62d335482b6","description":""},{"name":"Запрос истории переписки по клиенту","id":"42825970-cad9-42d5-9108-08730dc1f715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"url":"https://api.flomni.com/message/history/?userHash=4c106ca8-4bc8-44b4-8ae8-424d19aab413&limit=50&offset=0&sessionId=5058eebe-1df3-47b8-acba-f2eeadb649ac&fromDate=2025-04-18T13:45:10.097Z&untilDate=2025-04-25T13:45:10.097Z","description":"

Метод возвращает массив сообщений, отсортированных от новых к старым сообщениям.

Параметр	Тип	Описание
userHash	String	Идентификатор клиента, по которому запрашиваем статистику
limit	Number	Количество запрашиваемых сообщений (по умолчанию возвращаются все)
offset	Number	Массив кнопок
sessionId	String	Идентификатор сессии
fromDate	String, ISO8601	Сообщения отправленные не ранее этой даты
untilDate	String, ISO8601	Сообщения отправленные не позже этой даты

\n\n

Ответы сервера

\n\n

200 Пользователь найден

\n\n

{
\"profile\": { ... },
\"history\": [ {...} ]
}

Ответ:
profile.name - имя клиента в мессенджере,
profile.avatarUrl - ссылка на аватар,
history[].time - время отправки сообщения,
history[].type - тип сообщения (входящее/исходящее),
history[].msg - объект с сообщением

404 Пользователь не найден

","urlObject":{"protocol":"https","path":["message","history",""],"host":["api","flomni","com"],"query":[{"key":"userHash","value":"4c106ca8-4bc8-44b4-8ae8-424d19aab413"},{"key":"limit","value":"50"},{"key":"offset","value":"0"},{"key":"sessionId","value":"5058eebe-1df3-47b8-acba-f2eeadb649ac"},{"key":"fromDate","value":"2025-04-18T13:45:10.097Z"},{"key":"untilDate","value":"2025-04-25T13:45:10.097Z"}],"variable":[]}},"response":[],"_postman_id":"42825970-cad9-42d5-9108-08730dc1f715"},{"name":"Отправка текстового сообщения","id":"7754b71b-0235-4f76-8eb6-0c1e0b94c6d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение по API\",\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Текст сообщения 1000 символов
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7754b71b-0235-4f76-8eb6-0c1e0b94c6d1"},{"name":"Отправка сообщения с вложенным изображением","id":"619fea49-e28a-5a97-60b8-38ef13e302b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенным изображением\",\n \"attachment\":[\n \t{\n \t\t\"type\": \"image\",\n \t\t\"url\": \"https://flomni.com/png/or/jpeg/pic.jpg\"\n \t}\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - image
attachment.url	String	Ссылка на png или jpeg изображение, размер - до 1Мб
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"619fea49-e28a-5a97-60b8-38ef13e302b0"},{"name":"Отправка сообщения с вложенным видео","id":"67bab3cb-ec42-41f7-9398-e7eccb4a134f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенным видео\",\n \"attachment\":[\n \t{\n \t\t\"type\": \"video\",\n \t\t\"url\": \"https://flomni.com/sample/flomni.mp4\"\n \t}\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - video
attachment.url	String	Ссылка на видео, размер - до 5Мб
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"67bab3cb-ec42-41f7-9398-e7eccb4a134f"},{"name":"Отправка сообщения с вложенной аудио-заметкой","id":"693d5ede-0428-4bb1-8c16-bee2c944c508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенным аудио\",\n \"attachment\": [\n {\n \"type\": \"audio\",\n \"url\": \"https://petersapparel.com/bin/clip.mp3\",\n \"length\": \"65\"\n }\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - audio
attachment.url	String	Ссылка на аудио, размер - до 1Мб
attachment.length	String	Длина записи в секундах
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"693d5ede-0428-4bb1-8c16-bee2c944c508"},{"name":"Отправка сообщения с вложенным документом","id":"e70d3ae3-b26d-46d1-bd1e-80b0387b94f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенным документом\",\n \"attachment\": [\n {\n \"type\": \"file\",\n \"url\": \"https://petersapparel.com/bin/receipt.pdf\"\n }\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - file
attachment.url	String	Ссылка на документ, размер - до 1Мб
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e70d3ae3-b26d-46d1-bd1e-80b0387b94f6"},{"name":"Отправка сообщения с вложенной гео-меткой","id":"cf85ea07-cf70-4780-9523-d64c765395a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенной гео-меткой\",\n \"attachment\": [\n {\n \"type\": \"location\",\n \"title\": \"Park Pobedy (Saint Petersburg Metro)\",\n \"coordinates\": {\n \"lat\": 59.866361111111,\n \"long\": 30.321802777778\n }\n }\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - image
attachment.title	String	Заголовок гео-метки
attachment.coordinates.lat	String	Координаты гео-точки: широта
attachment.coordinates.long	String	Координаты гео-точки: долгота
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf85ea07-cf70-4780-9523-d64c765395a4"},{"name":"Отправка сообщения с вложенным контактом","id":"3d2417c7-38ca-4692-9b1c-f063a9997c09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Flomni-API","value":"{{X-Flomni-API}}"}],"body":{"mode":"raw","raw":"{\n \"receiver\": {{userId}},\n \"text\": \"Исходящее сообщение с вложенным контактом\",\n \"attachment\": [\n {\n \"type\": \"contact\",\n \"name\": \"Ivan Petrov\",\n \"phone_number\": \"+79781979888\"\n }\n ],\n \"buttons\": [\n {\n \"type\": \"template\",\n \"caption\": \"Надпись на кнопке\",\n \"value\": \"Название или id точки входа\"\n }\n ]\n}"},"url":"https://api.flomni.com/message/","description":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
receiver	String	Идентификатор клиента, которому необходимо отправить сообщение
text	String	Подпись к картинке 200 символов
attachment	Array	Массив медиа-вложений из 1-3 объектов
attachment.type	String	Тип вложенного медиа - contact
attachment.name	String	Имя контакта
attachment.phone_number	String	Номер телефона
buttons	Array	Массив кнопок
buttons.type	String	Тип кнопки: `template` - действие в боте, `url` - переход по ссылке
buttons.caption	String	Надпись на кнопке
buttons.value	String	Для типа `template`: bдентификатор или название точки входа, для типа `url` - ссылка

\n\n

Ответ: mid - уникальный идентификатор сообщения, status - sent (отправлено сразу) или pending (поставлено в очередь)

\n","urlObject":{"protocol":"https","path":["message",""],"host":["api","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d2417c7-38ca-4692-9b1c-f063a9997c09"}],"id":"f6323815-7e7e-4ab3-bd64-ee21e7ea5f2b","description":"

Токен для отправки сообщений выводится в Личном кабинете.

\n","_postman_id":"f6323815-7e7e-4ab3-bd64-ee21e7ea5f2b"},{"name":"Уведомления о новых событиях через механизм Webhooks","item":[{"name":"Получение акцепта от пользователя","id":"1b2399f4-ff69-460d-8461-a3d0237ef7c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"profile\":{\n\t\t\"name\":\"optional\",\n\t\t\"avatarUrl\": \"optional\"\n\t},\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"onLinked\"\n}"},"url":"{{webhook_url}}","description":"

Type = onLinked

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b2399f4-ff69-460d-8461-a3d0237ef7c9"},{"name":"Отзыв акцепта от пользователя","id":"9bc2b0ac-65e6-47be-9ed7-2aa022ada1fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"profile\":{\n\t\t\"name\":\"optional\",\n\t\t\"avatarUrl\": \"optional\"\n\t},\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"onUnlinked\"\n}"},"url":"{{webhook_url}}","description":"

Type = onUnlinked

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bc2b0ac-65e6-47be-9ed7-2aa022ada1fc"},{"name":"Открытие чата от пользователя (только для Viber)","id":"aa34c91e-a218-4f08-80ac-33c2ca5c36e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"profile\":{\n\t\t\"name\":\"optional\",\n\t\t\"avatarUrl\": \"optional\"\n\t},\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"openNotLinked\"\n}"},"url":"{{webhook_url}}","description":"

Type = openNotLinked (если пользователь еще не акцептирован)

Type = openAlreadyLinked (если пользователь уже дал акцепт)

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa34c91e-a218-4f08-80ac-33c2ca5c36e8"},{"name":"Отправка исходящего сообщения клиентам","id":"24b69a2c-4dbd-41ce-a500-7e3f3058d4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"content\":[ \n\t { \n\t \"msg\":{ \n\t \"receiver\":{{userId}},\n\t \"buttons\":[ \n\t\n\t ],\n\t \"text\":\"Спасибо! Ваш аккаунт успешно подтвержден.\",\n\t \"mid\":\"a1d27843-24ec-4c7f-8c95-b803d530213b\",\n\t \"attachment\":[ \n\t\n\t ]\n\t },\n\t \"_id\":\"5c8d3ade74c1390009dd3557\",\n\t \"time\":\"2019-03-16T18:05:18.993Z\",\n\t \"type\":\"outbound\",\n\t \"botName\":\"wa79381635910\"\n\t }\n\t],\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"onMessage\"\n}"},"url":"{{webhook_url}}","description":"

type = onMessageOut (отправка инициирована ботом или оператором в Диалогах)

type = onMessageApi (отправка инициирована через API)

Данный метод отправляет массив из последних 10 событий с сортировкой по убыванию времени. Определить тип события можно по свойству type (outbound или inbound). Нулевой элемент массива - это всегда последнее сообщение, которое инициировало отправку запроса, и оно имеет свойство type: \"outbound\".

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"24b69a2c-4dbd-41ce-a500-7e3f3058d4ab"},{"name":"Получение входящего сообщения от клиента","id":"f2339fce-765e-4de3-9a71-385ef45837ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"content\":[ \n\t { \n\t \"msg\":{ \n\t \"receiver\":{{userId}},\n\t \"buttons\":[ \n\t\n\t ],\n\t \"text\":\"Shsjsj\",\n\t \"attachment\":[ \n\t\n\t ],\n\t \"mid\":\"6f6a5f5f-2aae-4e1b-9381-bb45123b0fb9\"\n\t },\n\t \"_id\":\"5c8f844374c1390009decac8\",\n\t \"time\":\"2019-03-18T11:42:59.672Z\",\n\t \"type\":\"inbound\",\n\t \"botName\":\"wa79381635910\"\n\t },\n\t { \n\t \"msg\":{ \n\t \"receiver\":{{userId}},\n\t \"buttons\":[ \n\t\n\t ],\n\t \"text\":\"Спасибо! Ваш аккаунт успешно подтвержден.\",\n\t \"mid\":\"a1d27843-24ec-4c7f-8c95-b803d530213b\",\n\t \"attachment\":[ \n\t\n\t ]\n\t },\n\t \"_id\":\"5c8d3ade74c1390009dd3557\",\n\t \"time\":\"2019-03-16T18:05:18.993Z\",\n\t \"type\":\"outbound\",\n\t \"botName\":\"wa79381635910\"\n\t }\n\t],\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"onMessage\"\n}"},"url":"{{webhook_url}}","description":"

type = onMessage

Данный метод отправляет массив из последних 10 событий с сортировкой по убыванию времени. При отправке исходящих сообщенй по API также отправляется данное событие. Определить тип события можно по свойству type (outbound или inbound). Нулевой элемент массива - это всегда последнее сообщение, которое инициировало отправку запроса, и оно имеет свойство type: \"inbound\".

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2339fce-765e-4de3-9a71-385ef45837ce"},{"name":"Уведомление о нажатии кнопки","id":"9413640f-6c89-4aef-a3f2-f37893a9393e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"wId\":{{wId}},\r\n \"receiver\":{{userId}},\r\n \"metaData\":{ \r\n\r\n },\r\n \"content\":[ \r\n { \r\n \"msg\":{ \r\n \"postback\":{ \r\n \"type\":\"integration\",\r\n \"value\":\"_e78qjlyqb\"\r\n },\r\n \"receiver\":{{userId}},\r\n \"mid\":\"a99bb56d-4b3e-48c6-be7b-48be56815781\"\r\n },\r\n \"type\":\"inbound\",\r\n \"_id\":\"5d275235615ea1000ac58769\",\r\n \"time\":\"2019-07-11T15:13:57.223Z\",\r\n \"botName\":\"web\"\r\n },\r\n { \r\n \"msg\":{ \r\n \"originator\":{ \r\n \"service\":\"bots\",\r\n \"isBot\":true\r\n },\r\n \"receiver\":{{userId}},\r\n \"buttons\":[ \r\n { \r\n \"type\":\"template\",\r\n \"value\":\"custom__e78qjlyqb\",\r\n \"caption\":\"Главное меню\",\r\n \"conditions\":[ \r\n\r\n ]\r\n }\r\n ],\r\n \"text\":\"Срок хранения продлен до 20.07.2019.\",\r\n \"mid\":\"45d324c8-672c-4c4a-9e0a-664cee46b031\",\r\n \"attachment\":[ \r\n\r\n ]\r\n },\r\n \"_id\":\"5d26e4e5615ea1000ac5652c\",\r\n \"type\":\"outbound\",\r\n \"time\":\"2019-07-11T07:27:33.257Z\",\r\n \"botName\":\"web\"\r\n }\r\n ],\r\n \"service\":{ \r\n \"bot\":\"wa\",\r\n \"botId\":\"wa79381635910\",\r\n \"mUid\":\"79219871234\"\r\n },\r\n \"type\":\"onMessage\"\r\n}"},"url":"{{webhook_url}}","description":"

type = onPostback

Иницируется нажатием кнопки клиентом. Данный метод отправляет массив из последних 10 событий с сортировкой по убыванию времени. Определить тип события можно по свойству type (outbound или inbound). Нулевой элемент массива содержит идентификатор нажатой кнопки.

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9413640f-6c89-4aef-a3f2-f37893a9393e"},{"name":"Обновление статуса доставки отправленного ранее сообщения","id":"dd033022-aa94-4555-bf1a-59e3243948e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wId\":{{wId}},\n\t\"receiver\":{{userId}},\n\t\"metaData\":{},\n\t\"messageStatus\":{\n\t\t\"status\":\"seen\",\n\t\t\"timestamp\":\"2019-03-18T12:44:02.751Z\"\n\t},\n\t\"service\":{\n\t\t\"bot\":\"wa\",\n\t\t\"botId\":\"wa79381635910\",\n\t\t\"mUid\":\"79219871234\"\n\t},\n\t\"type\":\"onStatus\"\n}"},"url":"{{webhook_url}}","description":"

type = onStatus

Статус передается в messageStatus.status.\nВозможные значения - opened (только для Viber), delivered, seen.

\n","urlObject":{"host":["{{webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd033022-aa94-4555-bf1a-59e3243948e9"}],"id":"ef1fa366-c16e-4133-ac6c-e9f0f667d581","description":"

Вебхуки включаются тут - https://my.flomni.com/configuration/integrations/server-url. Для активизации необходимо указать URL и при необходимости ограничить доступ к ресурсу через IP фильтрацию. Запросы Flomni осуществляются из подсети 95.213.233.128/29 или 84.252.130.192.\nВсе запросы отправляются POST, тело запроса содержит JSON с параметрами, которые описаны далее.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Параметр	Тип	Описание
wId	String	Уникальный идентификатор аккаунта Заказчика
receiver	String	Уникальный идентификатор клиента. По умолчанию автоматически генерируется в формате UUID или же передается Заказчиком произвольной строкой в методе Добавление клиента. В рамках одного идентификатора у клиента может быть подключено нексолько каналов коммуникации.
metaData	Object	Объект с набором пользовательских ключей, содержащий данные по пользователю. Наполнение данных может осуществляться из сервисов Боты (узел \"Управление чатом\" -> Сохранение данных о пользователе), Диалоги (ручной ввод оператором) или Транспорт сообщений (при отправке сообщений)
profile.name	String	Имя клиента. Поле заполняется одним из следующих способов: импортируется из мессенджера, вводится оператором в ответ на вопрос бота, вводится оператором в форму Онлайн-чата или вводится оператором вручную через Диалоги
profile.avatarUrl	String	HTTP ссылка на картинку-аватар пользователя. Аватар импортируется из аккаунта мессенджера (не применимо для части мессенджеров - WhatsApp, Apple Business)
service.bot	String	Сокращенный идентификатор канала коммуникации в котором призошло событие
service.botId	String	Идентификатор канала коммуникации
service.mUid	String	Идентифкатор пользователя, определяемый каналом коммуникации. Для WhatsApp и Voicer - номер абонента в международном формате, для других каналов - произвольная строка.
type	String	Тип события. Тип события также дублируется в GET параметре запроса, что позволяет осуществлять маршрутизацию события по различным обработчикам на стороне Заказчика.
content	Array	Массив сообщений и действий клиента (нажатий кнопок), отсортированный от более поздних сообщений к более ранним. Передаются последние 10 сообщений.
content.type	String	Возможные значния - inbound (клиент отправил сообщение Заказчику), outbound (бот или оператор Заказчика отправил сообщение клиенту).
content.time	Date	Дата и время обработки сообщения в формате ISO.
content.msg.mid	String	Уникальный UUID для сообщения
content.msg.originator	String	Наиманование сервиса, из которго отправлено сообщение. Возможные значения - bots, dialogs. Применимо только для content.type = outbound.
content.msg.text	String	Текст сообщения
content.msg.buttons	Array	Массив с кнопками, отправленных вместе с сообщением. Применимо только для content.type = outbound.
content.msg.postback.value	String	Значение, ассоциированное с нажатием кнопки, отправленной ранее в сообщении. Применимо только для content.type = inbound.

","event":[{"listen":"prerequest","script":{"id":"6abcd077-98e8-4a70-a2fc-040954d40d8d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e94ca17d-ab60-4a37-916b-3f4593eba172","type":"text/javascript","exec":[""]}}],"_postman_id":"ef1fa366-c16e-4133-ac6c-e9f0f667d581"},{"name":"Подключение кастомизированного виджета для сбора контактов из мессенджеров","item":[{"name":"Добавление Клиента","id":"d2baf8cb-7edd-4fd8-a3c0-67f3f0a9408f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"wId\": \"Идентификатор компании\",\n \"origin\": \"linker.standalone\",\n \"userId\": \"Произвольный уникальный идетификатор клиента\",\n \"messengerId\": \"Идентификатор мессенджера для которого получаем ссылку\",\n \"threadId\": \"Опциональный идентификатор мессенджера, куда преводим клиента\",\n \"language\": \"ru/en ... Опциональный идентификатор языка для мультиязычных ботов\"\n}"},"url":"https://link.v2.flomni.com/linking/invite/","urlObject":{"protocol":"https","path":["linking","invite",""],"host":["link","v2","flomni","com"],"query":[],"variable":[]}},"response":[{"id":"5eb65178-e95b-42d5-b4b2-dd79005b8236","name":"Добавление Клиента","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"userId\":\"478a636d00591f79329527027\",\n\t\"transactionId\":\"79211234567\",\n\t\"wId\":\"5b059b83522b030014c6a111\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://link.v2.flomni.com/invite/:messenger/ ","protocol":"https","host":["link","v2","flomni","com"],"path":["invite",":messenger"," "],"variable":[{"description":"Идентификатор мессенджера, который выбрал клиент. Допустимые значения: vbr, tlgr, wa, fb, vk, any. Значение по умолчанию – any.","key":"messenger","value":"any"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"result\": \"OK\"\n}"}],"_postman_id":"d2baf8cb-7edd-4fd8-a3c0-67f3f0a9408f"},{"name":"Получение массива ссылок для мессенджеров","id":"f61d1527-143b-4ac8-ae79-856d2dd41d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://link.v2.flomni.com/widget/settings/:wId/","urlObject":{"protocol":"https","path":["widget","settings",":wId",""],"host":["link","v2","flomni","com"],"query":[],"variable":[{"description":{"content":"

Уникальный идентификатор Заказчика

\n","type":"text/plain"},"type":"any","value":"","key":"wId"}]}},"response":[],"_postman_id":"f61d1527-143b-4ac8-ae79-856d2dd41d2d"},{"name":"Получение статуса регистрации Клиента","id":"561a08bf-49a8-42a4-9b4f-be7d08025c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"userId\":\"478a636d00591f79329527027aac55c5e7f87026b8a01a4e3604bb1\",\n\t\"transactionId\":\"\",\n\t\"wId\":\"5b059b83522b030014c6a111\"\n} "},"url":"https://link.v2.flomni.com/user/get/","urlObject":{"protocol":"https","path":["user","get",""],"host":["link","v2","flomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"561a08bf-49a8-42a4-9b4f-be7d08025c1c"}],"id":"30971738-b70e-44e1-885b-4cbe29712c73","description":"

Данный раздел описывает ИТ взаимодействие при реализации виджета выбора канала коммуникации (мессенджеры, смс или голосовой бот) на стороне Заказчика.

Под новыми клиентами понимаются пользователи с неакцптированным мессенджером и/или те пользователи, которые ранее отозвали акцепт.

Процесс выбора мессенджера для новых клиентов состоит из следующих шагов:

Клиент выбирает один предпочтительный мессенджер для взаимодействия с компанией
Заказчик производит запрос URL ссылок, по которым должен произойти переход пользователя в мессенджер
Заказчик формирует уникальный идентификатор клиента (например, хэш-строку от email профиля Клиента). Опционально могут передаваться идентификаторы транзакции (номер заказа, номер телефона клиента и пр.) по которым в дальнейшем будет осуществляться отправка сообщений в мессенджеры. • Клиент выбирает на каком устройстве установлен выбранный мессенджер
Если мессенджер установлен на текущем устройстве, то достаточно перевести клиента по ссылке, соответствующей мессенджеру с подстановкой идентификатора клиента.
Если мессенджер установлен на другом устройстве (например, Клиент оформляет заказ с desktop ПК, а мессенджер установлен на телефоне) то для перехода в мессенджер необходимо отсканировать QR код, в котором будет кодирована сформированная ссылка.
Для дополнительного удобства пользователя можно направлять SMS-сообщение содержащее ссылку на страницу выбора мессенджера или прямую ссылку в выбранный мессенджер.
Заказчик на своей стороне отслеживает статус выбора мессенджера. После получения подтверждения акцепта в интерфейсе можно вывести акцептированный мессенджер, аватар и имя пользователя, полученные из мессенджера.

Процесс выбора мессенджера для постоянных клиентов состоит из следующих шагов:

Заказчик запрашивает статус акцепта на стороне платформы Flomni.
Если есть действующий акцепт, то в ответ на запрос возвращаются данные пользователя - акцептированный мессенджер, аватар и имя пользователя.
Если акцепта нет или он был отозван, то необходимо повторить сбор акцепта в соответствии с описанным выше алгоритмом для новых пользователей.

\n","event":[{"listen":"prerequest","script":{"id":"37e6a661-1526-4fc0-80dc-7565b36d3de2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"79bbdea4-feb6-4e69-9810-c07489e5101f","type":"text/javascript","exec":[""]}}],"_postman_id":"30971738-b70e-44e1-885b-4cbe29712c73"},{"name":"Запрос статистики","item":[{"name":"Получение токена для запроса статистики","id":"ee46778c-53db-494e-bcf0-9bbf05a65d1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"example@flomni.ru\",\r\n \"password\" :\"xSLTijMdeZvcYR7\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashbk.flomni.com/v2/user/auth/","urlObject":{"protocol":"https","path":["v2","user","auth",""],"host":["dashbk","flomni","com"],"query":[],"variable":[]}},"response":[{"id":"b236408a-0d6f-44a0-85bd-d3c3dde90124","name":"Успешное получение токенов","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"as+gitlab@flomni.ru\",\r\n \"password\" :\"xSLTijMdeZvcYR7\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dashbk.flomni.com/user/auth/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:09:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"540"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, X-Florder-Key, x-florder-wsclient"},{"key":"Access-Control-Allow-Methods","value":"GET,POST, OPTIONS, PUT, PATCH, DELETE"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"47"},{"key":"X-RateLimit-Reset","value":"1619107962"},{"key":"ETag","value":"W/\"21c-q21MDVUO24gf2pbw2PA25rf+cY0\""},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"jwt\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYwNDc5YWEyM2MxYTIxMDAwYmM0ZDgyNCIsImlhdCI6MTYxOTEwNzc3MiwiZXhwIjoxNjE5NzEyNTcyfQ.dbw52OjhPWw1LeMCyZG7ByAK-FyY-AcirmX9nOinuVw\",\n \"jwt_services\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0\"\n}"}],"_postman_id":"ee46778c-53db-494e-bcf0-9bbf05a65d1d"},{"name":"Запрос агрегированной статистики за период","id":"688c3568-16b9-4eea-b38d-649f6dddf6b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-flomni","value":"{{X-Flomni-Stats-Temp}}","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":"https://stats.v2.flomni.com/events?startDate=2021-04-20&endDate=2021-04-24T23%3A59%3A59&groupBy=day&eventType=core.session&subGroup=false","urlObject":{"protocol":"https","path":["events"],"host":["stats","v2","flomni","com"],"query":[{"description":{"content":"

Дата от

\n","type":"text/plain"},"key":"startDate","value":"2021-04-20"},{"description":{"content":"

Дата до

\n","type":"text/plain"},"key":"endDate","value":"2021-04-24T23%3A59%3A59"},{"description":{"content":"

Интервал для группировки

\n","type":"text/plain"},"key":"groupBy","value":"day"},{"description":{"content":"

Название типа события

\n","type":"text/plain"},"key":"eventType","value":"core.session"},{"description":{"content":"

(Опционально) Группировка по подгруппам

\n","type":"text/plain"},"key":"subGroup","value":"false"}],"variable":[]}},"response":[{"id":"0ebb1819-03e1-43b7-89c0-4196b791e516","name":"Ответ для случая когда данные отсутствуют","originalRequest":{"method":"GET","header":[{"key":"x-flomni","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":{"raw":"https://stats.v2.flomni.com/events?startDate=2021-04-20&endDate=2021-04-20T23%3A59%3A59&groupBy=day&eventType=core.session","protocol":"https","host":["stats","v2","flomni","com"],"path":["events"],"query":[{"key":"startDate","value":"2021-04-20"},{"key":"endDate","value":"2021-04-20T23%3A59%3A59"},{"key":"groupBy","value":"day"},{"key":"eventType","value":"core.session"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:14:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"34-FXL/JA626jpN+J5PgBhs9w7a6a4\""},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"groups\": [],\n \"metrics\": []\n }\n}"},{"id":"6620d994-7348-49cc-8b51-5cf1bda96349","name":"Получен ответ","originalRequest":{"method":"GET","header":[{"key":"x-flomni","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":{"raw":"https://stats.v2.flomni.com/events?startDate=2021-04-20&endDate=2021-04-24T23%3A59%3A59&groupBy=day&eventType=core.session","protocol":"https","host":["stats","v2","flomni","com"],"path":["events"],"query":[{"key":"startDate","value":"2021-04-20"},{"key":"endDate","value":"2021-04-24T23%3A59%3A59"},{"key":"groupBy","value":"day"},{"key":"eventType","value":"core.session"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:21:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"709-YqBcGG9TjyQ8u5PX55fjNAjyFSI\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"groups\": [\n {\n \"events\": [\n {\n \"dt\": \"2021-04-22T16:00:00.000Z\",\n \"dtUser\": \"2021-04-22T19:00:00.000+0300\",\n \"date\": \"2021-04-22\",\n \"count\": 2,\n \"metrics\": [\n {\n \"name\": \"zAvgBotScore\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6a\",\n \"measurement\": null\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": false,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"zAvgAgentScore\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6b\",\n \"measurement\": null\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": false,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"sessionsQuantity\",\n \"value\": 2,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6c\",\n \"measurement\": null\n },\n \"type\": \"count\",\n \"isAverage\": false,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"avgDuration\",\n \"value\": 21607741.5,\n \"unit\": {\n \"type\": \"time\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6d\"\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"botResponse\",\n \"value\": 1,\n \"unit\": {\n \"type\": \"percent\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6e\"\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"ratedSessions\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6f\",\n \"measurement\": null\n },\n \"type\": \"count\",\n \"isAverage\": false,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n }\n ],\n \"eventType\": \"coreSessions\",\n \"originalEventType\": \"core.session\"\n }\n ],\n \"group\": {\n \"_id\": \"5f08b0c7edabd50018961b6c\",\n \"owner\": null,\n \"__v\": 0,\n \"groupName\": \"coreEventGroup\",\n \"idx\": 1\n },\n \"groupName\": \"coreEventGroup\"\n }\n ],\n \"metrics\": []\n }\n}"}],"_postman_id":"688c3568-16b9-4eea-b38d-649f6dddf6b0"},{"name":"Запрос агрегированной статистики в разрезе канала","id":"c26debce-1f94-4fe2-a92a-d706f344b983","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-flomni","value":"{{X-Flomni-Stats-Temp}}","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":"https://stats.v2.flomni.com/events/channel?startDate=2021-04-20&endDate=2021-04-24T23%3A59%3A59&groupBy=day&eventType=core.session&channel=vk&subGroup=false","description":"

Если оставить параметр channel пустым в ответ придут данные по всем каналам

\n","urlObject":{"protocol":"https","path":["events","channel"],"host":["stats","v2","flomni","com"],"query":[{"key":"startDate","value":"2021-04-20"},{"key":"endDate","value":"2021-04-24T23%3A59%3A59"},{"key":"groupBy","value":"day"},{"key":"eventType","value":"core.session"},{"key":"channel","value":"vk"},{"description":{"content":"

(Опционально) Группировка по подгруппам

\n","type":"text/plain"},"key":"subGroup","value":"false"}],"variable":[]}},"response":[{"id":"7f2d3183-a626-4c03-a5d6-2ada700a0a3e","name":"Ответ для случая когда данные отсутствуют","originalRequest":{"method":"GET","header":[{"key":"x-flomni","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":{"raw":"https://stats.v2.flomni.com/events?startDate=2021-04-20&endDate=2021-04-20T23%3A59%3A59&groupBy=day&eventType=core.session","protocol":"https","host":["stats","v2","flomni","com"],"path":["events"],"query":[{"key":"startDate","value":"2021-04-20"},{"key":"endDate","value":"2021-04-20T23%3A59%3A59"},{"key":"groupBy","value":"day"},{"key":"eventType","value":"core.session"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:14:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"34-FXL/JA626jpN+J5PgBhs9w7a6a4\""},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"groups\": [],\n \"metrics\": []\n }\n}"},{"id":"6b72487e-505c-4fb2-9112-0184429fc3ac","name":"Получен ответ","originalRequest":{"method":"GET","header":[{"key":"x-flomni","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":{"raw":"https://stats.v2.flomni.com/events?startDate=2021-04-20&endDate=2021-04-24T23%3A59%3A59&groupBy=day&eventType=core.session","protocol":"https","host":["stats","v2","flomni","com"],"path":["events"],"query":[{"key":"startDate","value":"2021-04-20"},{"key":"endDate","value":"2021-04-24T23%3A59%3A59"},{"key":"groupBy","value":"day"},{"key":"eventType","value":"core.session"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:21:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"709-YqBcGG9TjyQ8u5PX55fjNAjyFSI\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"groups\": [\n {\n \"events\": [\n {\n \"dt\": \"2021-04-22T16:00:00.000Z\",\n \"dtUser\": \"2021-04-22T19:00:00.000+0300\",\n \"date\": \"2021-04-22\",\n \"count\": 2,\n \"metrics\": [\n {\n \"name\": \"zAvgBotScore\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6a\",\n \"measurement\": null\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": false,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"zAvgAgentScore\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6b\",\n \"measurement\": null\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": false,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"sessionsQuantity\",\n \"value\": 2,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6c\",\n \"measurement\": null\n },\n \"type\": \"count\",\n \"isAverage\": false,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"avgDuration\",\n \"value\": 21607741.5,\n \"unit\": {\n \"type\": \"time\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6d\"\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"botResponse\",\n \"value\": 1,\n \"unit\": {\n \"type\": \"percent\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6e\"\n },\n \"type\": \"avg\",\n \"isAverage\": true,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n },\n {\n \"name\": \"ratedSessions\",\n \"value\": 0,\n \"unit\": {\n \"type\": \"amount\",\n \"denominator\": null,\n \"_id\": \"6081a27c478c3b002326db6f\",\n \"measurement\": null\n },\n \"type\": \"count\",\n \"isAverage\": false,\n \"showInReport\": true,\n \"showInAgentReport\": false,\n \"owner\": \"60479aa23c1a21000bc4d824\"\n }\n ],\n \"eventType\": \"coreSessions\",\n \"originalEventType\": \"core.session\"\n }\n ],\n \"group\": {\n \"_id\": \"5f08b0c7edabd50018961b6c\",\n \"owner\": null,\n \"__v\": 0,\n \"groupName\": \"coreEventGroup\",\n \"idx\": 1\n },\n \"groupName\": \"coreEventGroup\"\n }\n ],\n \"metrics\": []\n }\n}"}],"_postman_id":"c26debce-1f94-4fe2-a92a-d706f344b983"},{"name":"Запрос журнала событий статистики","id":"2c463bae-2192-4383-9656-1e8ed89efd38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-flomni","value":"{{X-Flomni-Stats-Temp}}","type":"text"}],"url":"https://stats.v2.flomni.com/events/log?startDate=2022-04-25T00:00:00.000&endDate=2022-04-25T23:59:59.999&eventType=message.generic&limit=20&direction=1","urlObject":{"protocol":"https","path":["events","log"],"host":["stats","v2","flomni","com"],"query":[{"description":{"content":"

Дата от

\n","type":"text/plain"},"key":"startDate","value":"2022-04-25T00:00:00.000"},{"description":{"content":"

Дата до

\n","type":"text/plain"},"key":"endDate","value":"2022-04-25T23:59:59.999"},{"description":{"content":"

Название типа события

\n","type":"text/plain"},"key":"eventType","value":"message.generic"},{"description":{"content":"

Количество записей в ответе

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Направление сортировки

\n","type":"text/plain"},"key":"direction","value":"1"}],"variable":[]}},"response":[{"id":"478a507c-0113-4ffc-9e2f-375ae6ddf281","name":"Получен ответ","originalRequest":{"method":"GET","header":[{"key":"x-flomni","value":"asfasGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiLCJwZXJtaXNzaW9ucyI6eyJzdGF0cyI6eyJyZWFkT25seSI6dHJ1ZSwib3JpZ2luYXRvciI6WyI2MDQ3OWFhMjNjMWEyMTAwMGJjNGQ4MjQiXX19LCJleHBpcmVzQXQiOiIyMDIyLTA0LTIyVDE2OjA5OjMyLjk2NloiLCJpYXQiOjE2MTkxMDc3NzIsImV4cCI6MzMxNTUxMDc3NzJ9.uIJQ0ZYG5gCCdODMox7N8aMJrBsW4e4NovADvsGa3D0","type":"text"},{"key":"x-flomni-timezone","value":"Europe/Moscow","type":"text"}],"url":{"raw":"https://stats.v2.flomni.com/events/log?eventType=message.generic&startDate=2022-04-25T00:00:00.000&endDate=2022-04-25T23:59:59.999&limit=20&direction=1","protocol":"https","host":["stats","v2","flomni","com"],"path":["events","log"],"query":[{"key":"eventType","value":"message.generic"},{"key":"startDate","value":"2022-04-25T00:00:00.000"},{"key":"endDate","value":"2022-04-25T23:59:59.999"},{"key":"limit","value":"20"},{"key":"direction","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Apr 2021 16:21:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"ETag","value":"W/\"709-YqBcGG9TjyQ8u5PX55fjNAjyFSI\""},{"key":"Content-Encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Provider","value":"Yandex"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"nextCursor\": \"6266014cca413a000a4d7b40\",\n \"data\": [\n {\n \"_id\": \"6266012102bc46000b7d6de1\",\n \"mservice\": \"SmartDelivery\",\n \"eventType\": \"message.generic\",\n \"eid\": \"305e1464-6d12-4c0e-9ae4-6fa4f836236b\",\n \"dt\": \"2022-04-25T02:01:58.334Z\",\n \"subGroup\": \"Listing Offer 2\",\n \"account\": \"62189ef2060aef48d1abab21\",\n \"channel\": \"vbr\",\n \"recipient\": {\n \"mUid\": \"your-uid\",\n \"phoneNum\": \"79211234567\"\n },\n \"data\": {\n \"status\": \"seen\",\n \"text\": \"Message Text\",\n \"templateName\": \"Listing Offer 2\",\n \"metaData\": [],\n \"lastStatusUpdate\": \"2022-04-25T02:24:04.078Z\",\n \"chnlType\": \"primary\",\n \"details\": {\n \"rateType\": \"transaction\"\n }\n },\n \"searchTokens\": [],\n \"eventDisplayName\": \"messageGenericEvent\"\n }\n ]\n }\n}"}],"_postman_id":"2c463bae-2192-4383-9656-1e8ed89efd38"}],"id":"a57149c4-e0f7-4fa8-b8e3-b2c22faca78c","description":"

Статистика работы сервиса доступна в Личном кабинете.\nЕсли есть необходимость получать статистические данные для испольщования во внешних системах, например, на дэшборде, используйте API:

Запросите токен для работы со статистическими данными
Отправьте запрос указав идентификатор нужного статистического события (eventType), период выгрузки и группировку

\n","event":[{"listen":"prerequest","script":{"id":"c85c39ae-1db1-4414-842b-7b2bfff23b23","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"100f4307-6cfb-4a44-af0e-1e34b3d53098","type":"text/javascript","exec":[""]}}],"_postman_id":"a57149c4-e0f7-4fa8-b8e3-b2c22faca78c"}],"event":[{"listen":"prerequest","script":{"id":"ff452f99-0025-4f44-b4f4-59e172c9dd15","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9aa7c0cc-362e-4117-853d-37db5f9bda81","type":"text/javascript","exec":[""]}}]}