API интерфейс/1. Инициализация процесса верификации
2 min read
1. Инициализация процесса верификации
Инициировать новый сеанс проверки и активировать сервер соединения.
Система ReOTP использует функцию пробуждения по запросу для экономии серверных ресурсов. Это означает, что ваше соединение WhatsApp находится в спящем режиме, и когда вы отправляете этот запрос, сервер пробуждается, чтобы открыть соединение и быть готовым принять сообщение клиента.
Отправляемые параметры (Request Body):
apiKey(строка - обязательно): API ключ вашего проекта.
phoneNumber(строка - обязательно): Номер телефона пользователя (пример:+966500000000).
method(строка - опционально): Метод верификации"WHATSAPP"или"TELEGRAM"(по умолчанию:"WHATSAPP").
returnUrl(строка - опционально): Ссылка, на которую клиент будет перенаправлен после успешной верификации в приложении Telegram.
Получаемые параметры (Response Body):
requestId(строка): Уникальный идентификатор операции для отслеживания статуса верификации.
waLink(строка): Ссылка на WhatsApp (возвращается только если методWHATSAPP).
tgLink(строка): Ссылка на Telegram (возвращается только если методTELEGRAM).
expectedText(строка): Текст автоматического сообщения, которое должно быть отправлено.
expiresIn(строка): Время истечения срока действия запроса (две минуты).
Важные примечания:
- Срок действия: У клиента есть всего две минуты (02:00), чтобы открыть ссылку и отправить автоматическое сообщение со своего телефона до истечения срока действия сессии и перехода сервера в спящий режим.
- Пользовательский интерфейс: Мы настоятельно рекомендуем отображать обратный отсчет для клиента в вашем интерфейсе, чтобы побудить его быстро отправить сообщение.
Отправьте запрос POST на URL, указанный на боковой панели кода, чтобы начать процесс.
Integration Code (SDKs)
Interactive Playground
Интерактивная платформа для тестирования API
Введите номер телефона, чтобы инициализировать сессию и мгновенно протестировать ответ сервера:
Интерактивная API-песочница
Протестируйте отправку запросов на верификацию вживую и сгенерируйте коды интеграции на предпочитаемом вами языке программирования.
curl -X POST https://reotp.com/api/verify/init \
-H "Authorization: Bearer 15a1c1c7-ed05-40df-b7c3-69c327542a07" \
-H "Content-Type: application/json" \
-d '{
"phoneNumber": "201000000000",
"method": "WHATSAPP"
}'