Щоб створити новий запис callback, скористайтеся наступним запитом:
| Method | Request URL* |
| POST | /api/v1/envelope/callback/add |
Create callback
| URL | |
| Method | POST |
| request URL | /api/v1/envelope/callback/add |
| Headers | |
| content-type | application/json |
| authorization | Bearer {token} де {token} токен авторизації, який користувач отримав після успішної авторизації на платформі |
| mailbox | UUID поштової скриньки, на яку ви налаштували callbacks |
REQUEST BODY
{ "filter": { "label": ["string"], "status": ["COMPLETED"], "subject": "string", "receiveDateFrom": "2023-02-16T12:34:26.606Z", "receiveDateTo": "2023-02-16T12:34:26.606Z", "expireDateFrom": "2023-02-16T12:34:26.606Z", "expireDateTo": "2023-02-16T12:34:26.606Z", "template": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"], "sender": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"], "scope": ["inbox"] }, "url": "string", "retries": 10, "timeout": 60000, "successCode": 200, "login": "string", "password": "string" }
Параметри запиту описані нижче:
| filter * | Об'єкт з даними фільтра, відповідно до якого буде ініційовано callback. Може бути порожнім, якщо ви не хочете використовувати жодних фільтрів |
| label | Фільтрує конверти за ярликом, який присвоєно конверту |
| status | Фільтрує конверти за статусом. Допустимі статуси для callback: Очікує на Вас , Завершено, Скасовано, Прострочено |
| subject | Фільтрує конверти за відповідною темою конверта. Фільтр працює за правилом змісту. Це означає, що якщо ми застосуємо фільтр за темою "договір", то всі конверти зі словом "договір" будуть додані в callback чергу і callback буде відправлений. |
| receiveDateFrom | Фільтрує конверти за датою отримання ВІД вказаної дати та часу |
| receiveDateTo | Фільтрує конверти за датою отримання ДО вказаної дати та часу |
| expireDateFrom | Фільтрує конверти за датою закінчення терміну дії конверта ВІД вказаної дати та часу |
| expireDateTo | Фільтрує конверти за датою закінчення терміну дії конверта ДО вказаної дати та часу |
| template | Фільтрує конверти за певним шаблоном (шаблон, з якого створено конверт). Допустимими значеннями є UUID шаблону |
| sender | Фільтрувати конверти за відправником конверта. Допустимими значеннями є UUID відправника |
| scope | Фільтрує конверти за напрямком листа. Допустимі значення вхідні та вихідні |
| url * | Параметр визначає URL, на який буде надіслано callback |
| retries * | Параметр визначає кількість повторних спроб надсилання callback. Повторні спроби можуть бути застосовані, якщо URL недоступний або successCode, отриманий з URL, відрізняється від очікуваного. Допустимі значення від 0 до 10. Якщо в callback встановлено значення 0, це означає, що система відсилатиме callback один раз і не буде повторювати спроби. |
| timeout * | Параметр визначає таймаут в мілісекундах, протягом якого система чекатиме на відповідь з successCode. Якщо таймаут досягнуто, запускається процедура повторних спроб (якщо налаштовано). Допустимі значення від 100 до 60000 |
| successCode | Параметр визначає код статусу, який система очікує від успішно відправленого callback. Якщо код статусу, отриманий з URL, відрізняється від необхідного, буде ініційовано процедуру повторних спроб (якщо налаштовано). Якщо не буде застосовано значення за замовчуванням (Код статусу: 200). |
| login | Параметр визначає логін для основного облікового запису (якщо URL-адреса доступна лише для основного облікового запису, цей параметр має бути визначений) |
| password | Параметр визначає пароль основного облікового запису (якщо URL-адреса доступна лише для основного облікового запису, цей параметр має бути визначений) |
* - визначає атрибут за потреби
RESPONSE
У відповідь ви отримуєте код статусу 201 (у разі успішного створення callback) та JSON дані callback
Response example (JSON):
{ "id": "f8c97405-9185-4998-a3c0-2c4d0edaf43b", "filter": { "label": ["string"], "status": ["COMPLETED"], "subject": "string", "receiveDateFrom": null, "receiveDateTo": null, "expireDateFrom": null, "expireDateTo": null, "template": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"], "sender": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"], "scope": ["inbox"] }, "url": "string", "retries": 10, "timeout": 60000, "successCode": 200, "authType": "BASIC" }
