GetAuthorizationPasswordStatus#

Метод предназначен для получения настроек облачного пароля авторизованной учетной записи MAX: включён ли пароль и какая к нему установлена подсказка.

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

Запрос#

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

GET

{{apiUrl}}/waInstance{{idInstance}}/getAuthorizationPasswordStatus/{{apiTokenInstance}}

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

Ответ#

Поля ответа#

Поле	Тип	Описание
`status`	boolean	Статус выполнения запроса
		`true` - Успешное выполнение запроса
		`false` - Ошибка выполнения запроса
`data`	object	Настройки облачного пароля

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

Поле	Тип	Описание
`status`	string	Результат получения настроек:
		`success` - Настройки успешно получены
		`fail` - Ошибка получения настроек
`enabled`	boolean	Установлен ли облачный пароль на аккаунте:
		`true` - Пароль установлен
		`false` - Пароль не установлен
`hint`	string	Подсказка к паролю. Пустая строка, если подсказка не задана или пароль не установлен
`reason`	string	Причины при fail:
		`not_authorized` — Инстанс не авторизован
		`internal_error` — Внутренняя ошибка при выполнении запроса

Примечание

Если с момента авторизации учётной записи прошло менее 24 часов, мессенджер MAX ещё не предоставляет настройки пароля.
В этом случае метод возвращает успешный ответ со значениями enabled: false и hint: "".

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

Пароль установлен, задана подсказка:

{
    "status": true,
    "data": {
        "status": "success",
        "enabled": true,
        "hint": "Как обычно",
        "reason": ""
    }
}

Пароль не установлен:

{
    "status": true,
    "data": {
        "status": "success",
        "enabled": false,
        "hint": "",
        "reason": ""
    }
}

Инстанс не авторизован:

{
    "status": false,
    "data": {
        "status": "fail",
        "enabled": false,
        "hint": "",
        "reason": "not_authorized"
    }
}

Ошибки#

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

Код HTTP	Идентификатор ошибки	Описание
500	`Internal Server Error`	Возникла ошибка сервера

Примеры кода#

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/getAuthorizationPasswordStatus/{{apiTokenInstance}}"

payload = {}
headers = {}

response = requests.get(url, headers=headers, data=payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getAuthorizationPasswordStatus/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getAuthorizationPasswordStatus/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getAuthorizationPasswordStatus/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .asString();

System.out.println(response);