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` - Инстанс уже авторизован

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

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

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

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

status code 200

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

Ошибки SendAuthorizationCode#

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