StartAuthorization#

Метод предназначен для авторизации инстанса.

В процессе авторизации будет отправлен код проверки в системный чат Телеграмм.

Полученный код необходимо отправить методом SendAuthorizationCode для завершения процесса авторизации.

Важно

Авторизационный код сохраняет актуальность в течение 5 минут после его получения.
Если с предыдущего запроса startAuthorization прошло менее 5 минут, то новый код не будет отправлен.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для начала авторизации инстанса требуется выполнить запрос по адресу:

POST

{{apiUrl}}/waInstance{{idInstance}}/startAuthorization/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`phoneNumber`	integer	Да	Номер телефона для авторизации в мессенджере Telegram

Пример тела запроса#

Пример тела запроса:

{
    "phoneNumber": 79876543210
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`status`	boolean	Статус запроса кода авторизации
		`true` - Успешное выполнение метода
		`false` - Выполнение метода с ошибкой
`data`	object	Подробности запроса кода авторизации

Поля объекта `data`#

Поле	Тип	Описание
`status`	string	Результат запроса кода авторизации. Возможные значения: `succes` и `fail`
`reason`	string	Причина неуспешного запроса кода авторизации
		`already_registered` - Инстанс уже авторизован
		`system_busy` - Система ожидает ввода кода или пароля
		`invalid_phone_number` - Некорректный формат номера телефона
		`blocked_or_deleted` - Номер заблокирован или аккаунт удален
		`rate_limit_exceeded` - Превышен лимит попыток (Flood Wait). См. поле `retryAfter`
		`timeout_waiting_client` - Сервера Telegram недоступны или таймаут ожидания
		`connection_closed` - Соединение разорвано
`retryAfter`	integer	Время до следующей попытки запроса в миллисекундах Поле присутствует при `"reason": "rate_limit_exceeded"`

Пример тела ответа#

Успешное выполнение метода#

{
    "status": true,
    "data": {
        "status": "success",
        "reason": ""
    }
}

Выполнение метода с ошибкой#

Пример, когда инстанс занят (уже ждет код):

{
    "status": false,
    "data": {
        "status": "fail",
        "reason": "system_busy"
    }
}

Пример превышения лимитов:

{
    "status": false,
    "data": {
        "status": "fail",
        "reason": "rate_limit_exceeded",
        "retryAfter": 60
    }
}

Ошибки#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Идентификатор ошибки	Описание
200	`already_registered`	Инстанс уже авторизован
200	`system_busy`	Инстанс занят другим процессом входа
200	`invalid_phone_number`	Неверный формат номера