Каталог событий MCN Telecom — SMS
0 просмотра
Создано 27.08.2026
Обновлено 27.08.2026SMS
События (вебхуки и триггеры), связанные с отправкой и получением SMS-сообщений и их тарификацией.
Единый Envelope используется для всех событий: один channel соответствует одному event_type.
Содержание
Также см.:
«Каталог событий MCN Telecom — Виртуальная АТС (Звонки ВАТС, Переадресация и внутренние номера)»;
«Каталог событий MCN Telecom — Виртуальная АТС (Очереди, Другие события ВАТС)»;
«Каталог событий MCN Telecom — Работа с речью»;
Общий формат события
Все события используют общую обёртку Envelope:
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
account_id | integer | ✓ | ID аккаунта в системе |
event_type | string | ✓ | Тип события |
created_at | string (date-time) | ✓ | Момент события (UTC) |
idempotencyKey | string (uuid) | — | Ключ идемпотентности; одинаков при повторных доставках и используется для дедупликации |
data | object | ✓ | Данные, специфичные для event_type |
✓— обязательное поле;—— необязательное.
Для каждого события приведены описание полей data и пример Payload.
SMS-сообщения
Sms_event - Входящее/исходящее СМС
Описание: Событие о входящем/исходящем СМС
Payload: allOf — общий Envelope + данные события.
Envelope
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
account_id | integer | ✓ | ID аккаунта в системе |
event_type | string | ✓ | Тип события — см. components/messages |
created_at | string (date-time) | ✓ | Момент события (UTC) |
idempotencyKey | string (uuid) | — | Ключ идемпотентности; используется для дедупликации повторных доставок |
data | object | ✓ | Данные, специфичные для event_type |
data
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
date | number | ✓ | Метка времени отправки сообщения |
client_account_id | number | ✓ | Номер лицевого счёта клиента |
message_coding | null | ✓ | Кодировка SMS-сообщения |
eventType | string | ✓ | Тип события |
message | string | ✓ | Текст сообщения |
type | string | ✓ | Тип SMS: p2p — между абонентами, a2p — от приложения абоненту |
src_number | string | ✓ | Номер отправителя (номер A) |
accountId | number | ✓ | Номер лицевого счёта; дублирует account_id из Envelope |
sent_time | number | ✓ | Unix-время отправки SMS, микросекунды |
id | number | ✓ | ID SMS-сообщения во внутренней системе |
dst_number | string | ✓ | Номер получателя (номер B) |
smsc | string | ✓ | Идентификатор SMS-центра (SMSC), через который отправлено сообщение |
direction | string | ✓ | Направление SMS: incoming — входящее, outgoing — исходящее |
✓— обязательное поле;—— необязательное.
Пример: Payload
{
"account_id": 10001,
"event_type": "sms_event",
"created_at": "2026-07-01T18:34:48.548Z",
"idempotencyKey": "5b133904-6192-49d2-abbc-f95be887fb70",
"data": {
"date": 1782920088283097,
"client_account_id": 10001,
"message_coding": null,
"eventType": "sms_event",
"message": "Текст входящего СМС",
"type": "p2p",
"src_number": "Example",
"accountId": 10001,
"sent_time": 1782920088279568,
"id": 7979973,
"dst_number": "+79000000004",
"smsc": "yate-smsgw",
"direction": "incoming"
}
}
Биллинг SMS
Sms_billing_event - Списание за отправку СМС
Описание: Биллинговая информация о СМС
Payload: allOf — общий Envelope + данные события.
Envelope
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
account_id | integer | ✓ | ID аккаунта в системе |
event_type | string | ✓ | Тип события — см. components/messages |
created_at | string (date-time) | ✓ | Момент события (UTC) |
idempotencyKey | string (uuid) | — | Ключ идемпотентности; используется для дедупликации повторных доставок |
data | object | ✓ | Данные, специфичные для event_type |
data
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
service_start_timestamp | number | ✓ | Unix-время начала тарифицируемой услуги |
setup_time | number | ✓ | Отметка времени |
account_tariff_light_id | number | ✓ | ID тарифного плана лицевого счёта |
number_service_id | number | ✓ | ID услуги номера, к которой относится списание |
term_gt | null | ✓ | Global Title принимающей стороны SMS; служебное поле SMPP |
package_pricelist_id | number | ✓ | ID прайс-листа пакета услуг |
package_sms_consumed | number | ✓ | Число SMS, списанных из пакета |
location_id | number | ✓ | ID локации/региона тарификации |
src_number | string | ✓ | Номер отправителя (номер A) |
rate | number | ✓ | Тариф за единицу услуги |
term_cdr_id | null | ✓ | ID CDR-записи принимающей стороны; служебное поле |
trunk_service_id | number | ✓ | ID транкового сервиса, через который отправлено SMS |
id | number | ✓ | ID записи биллинга SMS |
stats_package_sms_id | number | ✓ | ID записи статистики по пакету SMS |
id_since_start | number | ✓ | Порядковый номер записи с начала биллингового периода |
pricelist_location_id | number | ✓ | ID локации в прайс-листе |
cost | number | ✓ | Стоимость SMS |
smpp_cdr_id | number | ✓ | ID CDR-записи по SMPP-каналу отправки |
count | number | ✓ | Количество SMS |
eventType | string | ✓ | Тип события |
accountId | number | ✓ | Номер лицевого счёта; дублирует account_id из Envelope |
account_id | number | ✓ | Номер лицевого счёта |
dst_imsi | string | ✓ | IMSI принимающего абонента |
smpp_gt | null | ✓ | Global Title в SMPP-канале; служебное поле |
orig_cdr_id | null | ✓ | ID CDR-записи исходящей стороны; служебное поле |
dst_number | string | ✓ | Номер получателя (номер B) |
src_imsi | string | ✓ | IMSI отправляющего абонента |
orig_gt | null | ✓ | Global Title исходящей стороны; служебное поле |
✓— обязательное поле;—— необязательное.
Пример: Payload
{
"account_id": 10001,
"event_type": "sms_billing_event",
"created_at": "2026-07-01T23:40:24.352Z",
"idempotencyKey": "5b133904-6192-49d2-abbc-f95be887fb70",
"data": {
"service_start_timestamp": 1776168259,
"setup_time": 1782938422000000,
"account_tariff_light_id": 103523009,
"number_service_id": 2971790,
"term_gt": null,
"package_pricelist_id": 2667,
"package_sms_consumed": 0,
"location_id": 1,
"src_number": "79000000033",
"rate": 0,
"term_cdr_id": null,
"trunk_service_id": 0,
"id": 15873213,
"stats_package_sms_id": 0,
"id_since_start": 831164,
"pricelist_location_id": 39362,
"cost": 0,
"smpp_cdr_id": 77432665,
"count": 1,
"eventType": "sms_billing_event",
"accountId": 10001,
"account_id": 10001,
"dst_imsi": "",
"smpp_gt": null,
"orig_cdr_id": null,
"dst_number": "79000000034",
"src_imsi": "",
"orig_gt": null
}
}