Skip to Content
1MSG

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

POST
/sendMessage

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

Нужен только один параметр адресата - chatId, phone или bsuid. В BSUID-centric режиме chatId может быть [email protected], bsuid@lid, [email protected] или username@username. Поле phone принимает телефон или BSUID; bsuid можно передать отдельным полем.

Direct Send в стадии beta. Meta включает его не на каждом бизнес-портфолио, поэтому category и directSend — бета-опция: смотрите ошибки доставки, прежде чем на них опираться.

category utility или authentication отправляет сообщение вне 24-часового окна как шаблон Meta Direct Send, а не как маркетинговый автошаблон 1MSG. authentication тоже в этой beta и не рекомендуется. directSend.serviceFirst: true сначала шлёт обычное сервисное сообщение и переходит на Direct Send только если Meta отклоняет его из-за закрытого окна (131047). directSend.templateName допустим только с utility (^[a-z0-9_]+$, максимум 512). Текст Direct Send — не длиннее 1024 символов. Без templateName первая новая фраза может уйти онбординг-шаблоном Meta. Имя шаблона не гарантирует доставку — ждите ошибки вебхука 131000 или 132021. Открытое 24-часовое окно всё равно тарифицируется как utility, если задан category и serviceFirst не true.

Authorization

JWT token
querytoken<token>

Request Body

  1. body
body*string

Текст сообщения, любая строка включая emoji 🍏. Может использоваться с "mentionedPhones", пример: "Этот текст для @78005553535"

category?string

Необязательная категория Direct Send. Direct Send в стадии beta: Meta включает его не на каждом бизнес-портфолио. utility или authentication включают Direct Send. authentication тоже в этой beta и не рекомендуется. Пусто или service — обычное сервисное сообщение. marketing отклоняется.

Value in"utility""authentication""service"
directSend?

Необязательно. Игнорируется, если category не utility и не authentication. serviceFirst в Meta не уходит.

quotedMsgId?string

Идентификатор цитируемого сообщения (Cloud API)

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

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

Example Request
curl -X POST 'https://api.1msg.io/123/sendMessage' \  -H 'Content-Type: application/json' \  -d '{  "body": "Hello World",  "phone": "12020721369"}'
Example Response200
{  "sent": true,  "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8",  "message": "Sent to [email protected]",  "description": "Message has been sent to the provider"}