StartAuthorization#
Метод предназначен для авторизации мессенджера MAX. СМС с кодом авторизации придёт на ваш телефонный номер.
Запрос#
Для начала авторизации инстанса требуется выполнить запрос по адресу:
POST
{{apiUrl}}/v3/waInstance{{idInstance}}/startAuthorization/{{apiTokenInstance}}
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
phoneNumber | int/string | Да | Номер телефона для авторизации в мессенджере MAX |
Важно
В настоящее время применяются только телефонные номера Российской Федерации и Республики Беларусь.
Пример тела запроса#
Запрос сообщения:
{
"phoneNumber": 79001234321
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
status | boolean | Статус запроса кода авторизации |
data | object | Подробности запроса кода авторизации |
Поля объекта data#
| Поле | Тип | Описание |
|---|---|---|
status | string | Результат запроса кода авторизации |
reason | string | Причина неуспепшного запроса кода авторизации |
Пример тела ответа#
Успешное выполнение метода#
status code 200
{
"status": true,
"data": {
"status": "success",
"reason": ""
}
}
Ошибки StartAuthorization#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код HTTP | Идентификатор ошибки reason | Описание |
|---|---|---|
| 200 | "already_registered" | Инстанс уже авторизован |
| 200 | "rate_limit_exceeded" | Инстанс не авторизован, но превышена частота запроса метода. Попробуйте выполнить запрос позже. |