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