SMS Events

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

ПараметрТипОписание
event_iduint64уникальный идентификатор события (отправка или получение SMS)
message_iduint64уникальный идентификатор сообщения
application_idstringуникальный идентификатор приложения, через которое прошло сообщение
datestringдата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601
senderstringномер отправителя / имя отправителя (альфа-имя) сообщения
receiverstringномер получателя сообщения
textstringтекст сообщения
directionenum Directionнаправление сообщения
segments_countuint32количество сегментов в сообщении
delivery_statusenum DeliveryStatusстатус доставки сообщения
statusenum Statusобщий статус сообщения (объединяет в себе доставку и оплату)
message_channelenum MessageChannelканал, в котором отправлено или получено сообщение

Direction

ПараметрТипОписание
DIRECTION_INCOMINGstringвходящее сообщение
DIRECTION_OUTGOINGstringисходящее сообщение

DeliveryStatus

ПараметрТипОписание
DELIVERY_STATUS_QUEUEDstringсообщение поставлено в очередь на отправку
DELIVERY_STATUS_TRANSMITTEDstringсообщение передано в SMS-центр
DELIVERY_STATUS_DELIVEREDstringсообщение доставлено получателю
DELIVERY_STATUS_FAILEDstringсообщение не может быть доставлено получателю
DELIVERY_STATUS_RETRIES_EXCEEDEDstringошибка — закончились попытки переотправки сообщения
DELIVERY_STATUS_PROHIBITEDstringприём и отправка сообщений заблокированы

Status

ПараметрТипОписание
STATUS_QUEUEDstringсообщение в очереди на отправку
STATUS_TRANSMITTEDstringсообщение отправлено в SMS-центр
STATUS_DELIVEREDstringсообщение доставлено получателю
STATUS_FAILEDstringне удалось отправить сообщение
STATUS_UNDERFUNDEDstringнедостаточно средств на балансе для отправки сообщения
STATUS_PROHIBITEDstringприем и отправка сообщений заблокированы

MessageChannel

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

Примеры

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

{
            "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,
            "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,
            "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,
            "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,
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}