StartAuthorization#

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

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

Важно

Процесс авторизации заключается в подключении к шлюзу GREEN-API существующего аккаунта мессенджера MAX.

Перед началом авторизации убедитесь в том, что на номере телефона уже зарегистрирован аккаунт мессенджера MAX через мобильное приложение.

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

Запрос#

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

POST

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

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

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

Параметр	Тип	Обязательный	Описание
`phoneNumber`	int	Да	Номер телефона для авторизации в мессенджере MAX. Допускается использовать только номера телефонов для РФ и РБ с кодами `7` и `375` соответственно. Например: `79991234567` или `375291234567`

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

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

{
    "phoneNumber": 79991234567
}

Ответ#

Поля ответа#

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

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

Поле	Тип	Описание
`status`	string	Результат запроса кода авторизации. Возможные значения: `succes` и `fail`
`reason`	string	Причина неуспешного запроса кода авторизации
		`already_registered` - Данный инстанс уже авторизован
		`timeout` - Сервера MAX недоступны
		`rate_limit_exceeded` - Превышена частота запроса метода Повторите запрос через время, указанное в поле `retryAfter` Время указывается в миллисекундах
		`connection_closed` - Запрос отклонён серверами MAX Попробуйте повторить попытку. Если ошибка сохраняется - обратитесь в техническую поддержку
		`not_ready` - Инстанс не готов к работе Попробуйте повторить попытку. Если ошибка сохраняется - обратитесь в техническую поддержку
`retryAfter`	integer	Время до следующей попытки запроса в миллисекундах Поле присутствует при `"reason": "rate_limit_exceeded"`

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

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

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

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

status code 200

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

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

Ошибки StartAuthorization#

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

Код HTTP	Идентификатор ошибки	Описание
200	`already_registered`	Инстанс уже авторизован
200	`rate_limit_exceeded`	Инстанс не авторизован, но превышена частота запроса метода. Попробуйте выполнить запрос позже.