Отримання коду підтвердження верифікації
URI: api/v1/promotion/customer/verification-code?phone={phone_number}&type={type}
Метод використовується для отримання коду верифікації для вказаного номе ра телефону через SMS або дзвінок.
Запит виконується методом GET.
⚠️ Запит повинен містити заголовок Accept: application/json
Параметри URI
URI запиту має містити змінні:
| Ім'я | Тип | Обов'язковий | Опис |
|---|---|---|---|
| phone | string | Так | Номер телефону клієнта |
| type | string | Так | Тип відправки коду: sms, call, null, viber, viber_bot, telegram_bot 🛈Якщо поле не передано або type = null — буде використано тип підтвердження, визначений у базових налаштуваннях. 🛈 Типи viber, viber_bot та telegram_bot доступні лише за умови попереднього підключення відповідних сервісів. 🛈 Будь-які інші поля type, окрім перелічених, не допускаються |
Приклад запиту
/api/v1/promotion/customer/verification-code?phone=380991234567&type=sms
Параметри відповіді
| Ім'я | Тип | Опис |
|---|---|---|
| type | string | Тип відправки коду:sms, call, null, viber, viber_bot, telegram_bot 🛈Якщо поле не передано або type = null — буде використано тип підтвердження, визначений у базових налаштуваннях. 🛈 Типи viber, viber_bot та telegram_bot доступні лише за умови попереднього підключення відповідних сервісів. 🛈 Будь-які інші поля type, окрім перелічених, не допускаються |
| code | string | Код підтвердження Для типа відправки sms код складається з 6 цифр Для типа відправки call код складається з 4 цифр |
| phone | string | Номер телефону клієнта |
| expired_at | data | Дата і час відправки коду, в форматі Y-m-d H:i Формат часу - 24 години |
Приклад відповіді
Відповідь: /api/v1/promotion/customer/verification-code?phone=380991234567&type=sms
{
"type": "sms",
"code": "221145",
"phone": "380991234567",
"expired_at": "2025-02-28T11:23:27.879011Z"
}
Відповідь: /api/v1/promotion/customer/verification-code?phone=380991234567&type=call
{
"type": "call",
"code": "2211",
"phone": "380991234567",
"expired_at": "2025-02-28T11:23:27.879011Z"
}
Приклад неуспішної відповіді
У клієнта не існує ідентифікатора ліцензії
Відповідь: 404 Bad Request
{
"code": "Lic id does not exists for client"
}
Потрібно вказати телефон і тип
Відповідь: 400 Bad Request
{
"code": "Phone and type is required"
}