1MSG

Отправить Список сообщений

POST
/sendList

Отправка списка опций в существующий чат (только с открытым диалоговым окном). Нужен только один параметр адресата - chatId, phone или bsuid. В BSUID-centric режиме chatId может быть [email protected], bsuid@lid, [email protected] или username@username. Поле phone принимает телефон или BSUID; bsuid можно передать отдельным полем.

Authorization

JWT token
querytoken<token>

Request Body

  1. body
body*string

Основной текст сообщения

header?string

Текст, который будет расположен над текстом сообщения

footer?string

Текст, который будет расположен под текстом сообщения

action*string

Подпись кнопки раскрытия списка

sections*array<>

Массив с разделами доступных для выбора опций Не более 10.

Каждый раздел - это объект, содержащий следующие поля:

title - Заголовок раздела, не более 24 символов. Обязателен, если указано более 1 раздела

rows - доступные для выбора опции. Обязателен

Каждая опция - это объект, содержащий следующие поля:

id - Уникальный идентификатор, не более 200 символов. Обязателен

title - Заголовок опции, не более 24 символов. Обязателен

description - Описание опции, не более 72 символов

Пример:

[{"title":"Section 1","rows":[{"id":"1","title":"Option 1","description":"Description 1"}]},{"title":"Section 2","rows":[{"id":"2","title":"Option 2","description":"Description 2"}]}]

chatId?string

Обязателен, если не указаны phone и bsuid

ID чата из списка сообщений. Примеры: [email protected], RU.1504711984690866@lid, username@username или [email protected] (группа). Используется вместо параметра phone.

phone?string

Обязателен, если не указаны chatId и bsuid

Идентификатор получателя. Принимает номер телефона с кодом страны или BSUID, например RU.1504711984690866.

Для chatId используйте полные ID чатов: [email protected], bsuid@lid, username@username или [email protected].

bsuid?string

Необязательная альтернатива phone/chatId

BSUID получателя без суффикса @lid. Пример: RU.1504711984690866.

Response Body

Server response example

application/json
  1. response
sent?boolean
id?string

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

message?string

Уведомление о статусе отправки сообщения

description?string

Комментарий к результату отправки

curl -X POST 'https://api.1msg.io/123/sendList' \  -H 'Content-Type: application/json' \  -d '{  "body": "Please choose option",  "header": "Some options",  "footer": "Thank you",  "action": "List",  "sections": [    {      "title": "Section 1",      "rows": [        {          "id": "1",          "title": "Option 1",          "description": "Description 1"        }      ]    }  ],  "phone": "12020721369"}'
{  "sent": true,  "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8",  "message": "Sent to [email protected]",  "description": "Message has been sent to the provider"}