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

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

BillingStatus

Параметр Тип Описание
1 string сообщение поставлено в очередь на обработку и оплату
2 string сообщение оплачено
4 string недостаточно средств на балансе для отправки сообщения
6 string ошибка оплаты сообщения
7 string плата за сообщение зарезервирована
8 string ошибка — закончились попытки оплаты сообщения

DeliveryStatus

Параметр Тип Описание
1 string сообщение поставлено в очередь на отправку
2 string сообщение доставлено в SMS-центр
3 string сообщение доставлено получателю
4 string сообщение не может быть доставлено получателю
5 string ошибка — закончились попытки переотправки сообщения
6 string приём и отправка сообщений заблокированы

Status

Параметр Тип Описание
1 string сообщение в очереди на отправку
2 string сообщение отправлено
3 string сообщение доставлено
4 string не удалось отправить сообщение
5 string недостаточно средств на балансе для отправки сообщения
6 string прием и отправка сообщений заблокированы

MessageChannel

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

Примеры

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

{
            "event_id": "449727651343549249",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.040913196Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "2",
            "segments_count": 1,
            "billing_status": "1",
            "delivery_status": "1",
            "message_channel": "1",
            "status": "1"
}
{
            "event_id": "449727651444212545",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.107040342Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "2",
            "segments_count": 1,
            "billing_status": "7",
            "delivery_status": "1",
            "message_channel": "1",
            "status": "1"
}
{
            "event_id": "449727651460989761",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.113153506Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "2",
            "segments_count": 1,
            "billing_status": "7",
            "delivery_status": "2",
            "message_channel": "1",
            "status": "2"
}
{
            "event_id": "449727651528098625",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.157362833Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "2",
            "segments_count": 1,
            "billing_status": "2",
            "delivery_status": "2",
            "message_channel": "1",
            "status": "2"
}
{
            "event_id": "449727659866374977",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.117363454Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "2",
            "segments_count": 1,
            "billing_status": "2",
            "delivery_status": "3",
            "message_channel": "1",
            "status": "3"
}

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

{
            "event_id": "449727660168364865",
            "message_id": "449727659849588395",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.298316597Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "1",
            "segments_count": 1,
            "billing_status": "1",
            "delivery_status": "3",
            "message_channel": "1",
            "status": "3"
}
{
            "event_id": "449727660302582593",
            "message_id": "449727659849588395",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.381193714Z",
            "sender": "79677099159",
            "receiver": "79677090942",
            "text": "Test events",
            "direction": "1",
            "segments_count": 1,
            "billing_status": "2",
            "delivery_status": "3",
            "message_channel": "1",
            "status": "3"
}

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