SendAuthorizationCode#
Метод предназначен для завершения процесса авторизации инстанса.
Используйте код проверки полученный из SMS или системного чата при вызове метода StartAuthorization.
Код авторизации остаётся актуальным в течение 5 минут, даже после отправки неправильного кода/пароля.
Если введен правильный код, но не введен пароль, авторизация считается незавершённой - следует отправить пароль методом sendAuthorizationPassword.
Для метода используются ограничения на частоту запросов в секунду.
Рекомендуем выполнять авторизацию по QR методу, так как авторизация по нему проходит стабильнее и проще.
Запрос#
Для отправки кода авторизации инстанса требуется выполнить запрос по адресу:
{{apiUrl}}/waInstance{{idInstance}}/sendAuthorizationCode/{{apiTokenInstance}}
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Код следует отправлять сразу после получения, иначе можно получить ошибку timeout.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
code | string | Да | Код подтверждения, полученный в приложении Telegram или по SMS |
password | string | Нет | Пароль двухфакторной аутентификации (Cloud Password), если он установлен на аккаунте |
Пример тела запроса#
Примера тела запроса:
{
"code": "123456",
"password": "qwerty"
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
status | boolean | Статус отправленного кода авторизации |
true - Успешное выполнение запроса | ||
false - Ошибка выполнения запроса | ||
data | object | Подробности отправленного кода авторизации |
Поля объекта data#
| Поле | Тип | Описание |
|---|---|---|
status | string | Результат выполнения авторизации: |
success - Успешное выполнение авторизации | ||
fail - Ошибка выполнения авторизации | ||
reason | string | Причины при fail: |
already_registered — инстанс уже авторизован | ||
2fa_required — код верный, но требуется ввод password | ||
invalid_password — указан неверный пароль | ||
verify_code_wrong — неверный код | ||
code_expired — код просрочен | ||
rate_limit_exceeded — слишком много попыток, попробуйте позже | ||
authorization_not_started — не был вызван метод startAuthorization | ||
timeout — истекло время ожидания ответа от серверов Telegram |
Пример тела ответа#
Успешное выполнение метода#
{
"status": true,
"data": {
"status": "success",
"reason": ""
}
}
Выполнение метода с ошибкой#
Требуется пароль (2FA):
{
"status": false,
"data": {
"status": "fail",
"reason": "2fa_required"
}
}
Превышен лимит попыток:
{
"status": false,
"data": {
"status": "fail",
"reason": "rate_limit_exceeded"
}
}
Ошибки#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки