Callback конвертів

Написано Анатолій
Оновлено 8 місяців тому

Callback конвертів — це функціонал, який дозволяє отримувати сповіщення на відповідну URL-адресу в разі появи конверта в поштовій скриньці та згідно з налаштованими фільтрами.

Ви можете налаштувати callback для поштової скриньки, щоб отримувати сповіщення про конверти поза нашою платформою. Це робиться за допомогою API. Якщо callback налаштовано, посилання для його отримання доступне і конверт отримано, система надсилає callback на відповідне посилання з наступними JSON даними.


JSON Callback дані
{
  "mailbox": "F32A3BD9-CE5B-4AC5-A2D7-C2A2E7DD6636",
  "uuid": "74acfb70-78e9-4ca5-ac73-054c72402c0a",
  "label": ["string"],
  "status": "string",
  "subject": "string",
  "receiveDate": 1676039226765,
  "expireDate": 1678631226504,
  "template": "ebeb302b-597e-4b47-9de2-5ad3a33e4385",
  "sender": "fdfde267-6558-40a9-93fd-e59529baef36"
}

Опис JSON даних
mailbox UUID поштової скриньки, яка в даний момент обробляє конверт
uuid UUID конверта, який викликав callback на платформі
label Список UUID ярликів, які призначено конкретному конверту
status Статус конверта. Найбільш очікувані статуси: ОЧІКУЄ НА ВАС, ЗАВЕРШЕНО, ПРОСТРОЧЕНО, СКАСОВАНО
subject Тема конверта
receiveDate Дата отримання конверта. Отримується за часом UNIX
expireDate Дата закінчення терміну дії конверта. Отримується за часом UNIX
template UUID шаблону, з якого було створено конверт
sender UUID відправника конверта, поштової скриньки, яка ініціювала процес обробки конверта

Чи була наша стаття корисною?