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

Request

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

Требования:

обязателен заголовок 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 успешно отправлен

Bodyapplication/json

codeErrorstring or nullrequired

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

successbooleanrequired

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

Example:true

messagestringrequired

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

Example:"OK"

error_codestring or null(ERROR_CODE)required

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

Enum:"invalid_body""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"

Example:null

dataany or nullrequired

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

Example:null

Response

{
  "success": true,
  "message": "OTP code sent successfully",
  "error_code": null,
  "data": null
}