Skip to main content

Уведомления

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

POST clientURL

Content-Type: application/json

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

Параметры

Параметр Тип Описание Примечание
type string Тип уведомления
files array Файлы Наличие зависит от типа
items array Элементы Содержание зависит от типа
Тип уведомления (параметр 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>
  }
Параметр Тип Описание Примечание
type string Тип содержимого - всегда base64
format string MIME-type файла
name string Имя файла
body string Содержимое файла, закодированное в base64
Параметр items

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

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