SendAuthorizationCode#
Метод предназначен для завершения процесса авторизации инстанса.
Используйте код проверки полученный из SMS при вызове метода StartAuthorization.
Для метода используются ограничения на частоту запросов в секунду.
Запрос#
Для отправки кода авторизации инстанса требуется выполнить запрос по адресу:
POST
{{apiUrl}}/v3/waInstance{{idInstance}}/sendAuthorizationCode/{{apiTokenInstance}}
Для получения параметров запроса apiUrl
, idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Код следует отправлять сразу после получения, иначе можно получить ошибку timeout
.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
code | string | Да | Параметр с проверочным кодом из SMS |
Пример тела запроса#
Примера тела запроса:
{
"code": "123456"
}
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
status | boolean | Статус отправленного кода авторизации |
true - Успешное выполнение запроса | ||
false - Ошибка выполнения запроса | ||
data | object | Подробности отправленного кода авторизации |
Поля объекта data
#
Поле | Тип | Описание |
---|---|---|
status | string | Результат выполнения авторизации: |
success - Успешное выполнение авторизации | ||
fail - Ошибка выполнения авторизации | ||
reason | string | Причина неуспепшной авторизации: |
already_registered - Инстанс уже авторизован | ||
verify_code_wrong - Неверный код авторизации | ||
code_expired - Время действия кода подтверждения истекло | ||
connection_closed - Соединение с серверами МАХ прервано (сервера недоступны) | ||
timeout - Сервера МАХ не прислали ответа в требуемый интервал времени | ||
rate_limit_exceeded Сейчас привязать устройство невозможно Повторите запрос через время, указанное в поле retryAfter Время указывается в миллисекундах | ||
blocked_or_deleted - Аккаунт удален или заблокирован со стороны МАХ | ||
retryAfter | integer | Время до следующей попытки запроса в миллисекундах Поле присутствует при "reason": "rate_limit_exceeded" При частых попытках связать устройство, MAX может установить ограничение на привязку устройств до 24-72 часов Если продолжить запрашивать код несмотря на ошибку rate_limit_exceeded , аккаунт может перейти в статус blocked_or_deleted |
Пример тела ответа#
Успешное выполнение метода#
{
"status": true,
"data": {
"status": "success",
"reason": ""
}
}
Выполнение метода с ошибкой#
status code 200
{
"status": false,
"data": {
"status": "fail",
"reason": "already_registered"
}
}
Ошибки SendAuthorizationCode#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки