SMS Events

Параметры уведомлений о входящих и исходящих сообщениях

Параметр Тип Описание
event_id uint64 уникальный идентификатор события (отправка или получение SMS)
message_id uint64 уникальный идентификатор сообщения
application_id string уникальный идентификатор приложения, через которое прошло сообщение
date string дата отправки / получения сообщения в формате RFC-3339 / ISO-8601
sender string номер отправителя / имя отправителя (альфа-имя) сообщения
receiver string номер получателя сообщения
text string текст сообщения
direction enum Direction направление сообщения
segments_count uint32 количество сегментов в сообщении
billing_status enum BillingStatus статус оплаты сообщения
delivery_status enum DeliveryStatus статус доставки сообщения
status enum Status общий статус сообщения (объединяет в себе доставку и оплату)
message_channel enum MessageChannel канал, в котором отправлено или получено сообщение

Direction

Параметр Тип Описание
DIRECTION_INCOMING string входящее сообщение
DIRECTION_OUTGOING string исходящее сообщение

BillingStatus

Параметр Тип Описание
BILLING_STATUS_PREBILLED string сообщение поставлено в очередь на обработку и оплату
BILLING_STATUS_BILLED string сообщение оплачено
BILLING_STATUS_UNDERFUNDED string недостаточно средств на балансе для отправки сообщения
BILLING_STATUS_FAILED string ошибка оплаты сообщения
BILLING_STATUS_AUTHORIZED string плата за сообщение зарезервирована
BILLING_STATUS_RETRIES_EXCEEDED string ошибка — закончились попытки переотправки сообщения

DeliveryStatus

Параметр Тип Описание
DELIVERY_STATUS_QUEUED string сообщение поставлено в очередь на отправку
DELIVERY_STATUS_TRANSMITTED string сообщение передано в SMS-центр
DELIVERY_STATUS_DELIVERED string сообщение доставлено получателю
DELIVERY_STATUS_FAILED string сообщение не может быть доставлено получателю
DELIVERY_STATUS_RETRIES_EXCEEDED string ошибка — закончились попытки переотправки сообщения
DELIVERY_STATUS_PROHIBITED string приём и отправка сообщений заблокированы

Status

Параметр Тип Описание
STATUS_QUEUED string сообщение в очереди на отправку
STATUS_TRANSMITTED string сообщение отправлено в SMS-центр
STATUS_DELIVERED string сообщение доставлено получателю
STATUS_FAILED string не удалось отправить сообщение
STATUS_UNDERFUNDED string недостаточно средств на балансе для отправки сообщения
STATUS_PROHIBITED string прием и отправка сообщений заблокированы

MessageChannel

Параметр Тип Описание
MESSAGE_CHANNEL_SMS string SMS-сообщение

Примеры

Исходящие сообщения 

{
            "event_id": "449727651343549249",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.040913196Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_PREBILLED",
            "delivery_status": "DELIVERY_STATUS_QUEUED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_QUEUED"
}
{
            "event_id": "449727651444212545",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.107040342Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_AUTHORIZED",
            "delivery_status": "DELIVERY_STATUS_QUEUED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_QUEUED"
}
{
            "event_id": "449727651460989761",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.113153506Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_AUTHORIZED",
            "delivery_status": "DELIVERY_STATUS_TRANSMITTED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_TRANSMITTED"
}
{
            "event_id": "449727651528098625",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.157362833Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_BILLED",
            "delivery_status": "DELIVERY_STATUS_TRANSMITTED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_TRANSMITTED"
}
{
            "event_id": "449727659866374977",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.117363454Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_BILLED",
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}

Входящие сообщения 

{
            "event_id": "449727660168364865",
            "message_id": "449727659849588395",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.298316597Z",
            "sender": "79133333333",
            "receiver": "79999999999",
            "text": "Test events",
            "direction": "DIRECTION_INCOMING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_PREBILLED",
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}
{
            "event_id": "449727660302582593",
            "message_id": "449727659849588395",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.381193714Z",
            "sender": "79133333333",
            "receiver": "79999999999",
            "text": "Test events",
            "direction": "DIRECTION_INCOMING",
            "segments_count": 1,
            "billing_status": "BILLING_STATUS_BILLED",
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}

Содержание статьи