Skip to content

Отправить OTP на телефон

Request

Отправляет одноразовый код подтверждения на указанный номер телефона.

После успешной отправки поле data.retry.TTL содержит фактическое оставшееся в Redis количество секунд до следующей разрешённой отправки. Это значение может быть больше обычного cooldown, если после отправки активировалась более длительная блокировка.

При повторном запросе до истечения TTL сервер сохраняет прежний контракт ошибки: строковое значение времени находится непосредственно в data.TTL.

Требования:

  • обязателен заголовок captcha-token
Headers
captcha-tokenstringrequired

Одноразовый токен Yandex SmartCaptcha.

Передаётся в заголовке: captcha-token: <token>

Bodyapplication/jsonrequired
recipientstring, <= 32 charactersrequired

Телефон в произвольном пользовательском формате; сервер нормализует значение.

Example:"+79991234567"
curl -i -X POST \
  https://felmee.com/api/auth/phone/send/otp \
  -H 'Content-Type: application/json' \
  -H 'captcha-token: string' \
  -d '{
    "recipient": "+79991234567"
  }'

Responses

OTP успешно отправлен; возвращён актуальный TTL следующей отправки

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(PhoneSendOtpSuccessData)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "OTP code sent successfully", "codeError": null, "error_code": null, "data": { "retry": { … } } }