Skip to main content

Уведомления

Если в личном кабинете настроены уведомления типа Вэбхук, то на указанный URL приходят POST-запросы вида:

POST clientURL

Content-Type: application/json

{
  "type": <string>,
  "files": <array>,
  "items": <array>
}

Параметры

ПараметрТипОписаниеПримечание
typestringТип уведомления
filesarrayФайлыНаличие зависит от типа
itemsarrayЭлементыСодержание зависит от типа
Тип уведомления (параметр type)
ЗначениеОписание
msu_lockБлокировка сим по MSU
package_emptyЗакончился пакет трафика
generate_billДобавлен новый счет на оплату
unpaid_bill_3Отправляется на 3й рабочий день после выставления счета, в случае неоплаты
unpaid_bill_5Отправляется на 5й рабочий день после выставления счета, в случае неоплаты
unpaid_bill_6Отправляется на 6й рабочий день после выставления счета, в случае неоплаты. Блокировка всем сим-карт и ограничение функциональности ЛК и API
Параметр files

Параметр files заполняется только в случае отправки уведомления по финансовым обязательствам, когда type = generate_bill, unpaid_bill_3, unpaid_bill_5, unpaid_bill_6. Элемент массива представлен следующим объектом:


  {
    "type": "base64",
    "format": <string>,
    "name": <string>,
    "body": <string>
  }
ПараметрТипОписаниеПримечание
typestringТип содержимого - всегда base64
formatstringMIME-type файла
namestringИмя файла
bodystringСодержимое файла, закодированное в base64
Параметр items

Параметр items содержит массив элементов, тип которых зависит от значения параметра type:

  • Объект типа Сим-карта, для type = msu_lock, package_empty
  • Объект типа Счёт, для type = generate_bill, unpaid_bill_3, unpaid_bill_5, unpaid_bill_6