Перейти к основному содержимому

Запросить код подтверждения на телефон

POST 
/v5/auth/send-code-by-phone

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию (н-р, телефон имеет неверный формат) [429]: "NotificationsAreOutOfService" - сервис отправки сообщений недоступен, повторите запрос позже [429]: "TrySendCodeLater" - слишком часто (второй вызов разрешен через 30 сек, третий через 1 мин., четвертый через 5 мин)

Request​

Query Parameters

    domain string

    Домен организации [для восстановления]

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: c808d4d8-1eef-440c-a15b-1976f73fd8f5
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service, Android]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Body

Учетные данные пользователя требуемые для запроса кода подтверждения на телефон

    phone stringrequired

    Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

    Номер телефона

    token stringnullable

    Токен валидации пользователя

    ip stringnullable

    IP клиента

    captcha_type CaptchaType (string)

    Possible values: [YandexSmartCaptcha, hCaptcha]

    Типы капчи

Responses​

No Content

Loading...