Перейти к содержанию

GetStateInstanceHistory#

Test Postman Apidog

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

Запрос#

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

GET
{{apiUrl}}/waInstance{{idInstance}}/GetStateInstanceHistory/{{apiTokenInstance}}

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

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

Допускается указывать параметры выборочно. Хотя бы один параметр должен быть указан.

Параметр Тип Обязательный Описание
count integer Нет Количество записей авторизации на инстансе в хронологическом порядке. По умолчанию count = 100

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

{
    "count": 200
}

Ответ#

Поля ответа#

Поле Тип Описание
stateInstance string Состояние инстанса. Принимает значения:
notAuthorized - Инстанс не авторизован. Для авторизации инстанса обратитесь к разделу Перед началом работы
authorized - Инстанс авторизован
blocked - Инстанс получил блокировку
timestamp integer Время события в UNIX-формате
phoneNumber integer Номер телефона

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

[
    {
        "stateInstance": "authorized",
        "timestamp": 1778132812,
        "phoneNumber": "79636191168@c.us"
    },
    {
        "stateInstance": "notAuthorized",
        "timestamp": 1778132743,
        "phoneNumber": "79636191168@c.us"
    },
    {
        "stateInstance": "authorized",
        "timestamp": 1778132546,
        "phoneNumber": "79636191168@c.us"
    },
    {
        "stateInstance": "notAuthorized",
        "timestamp": 1778131747,
        "phoneNumber": "79636191168@c.us"
    }
]

Ошибки GetStateInstanceHistory#

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

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

import requests

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

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/GetStateInstanceHistory/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/GetStateInstanceHistory/")
    .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("/GetStateInstanceHistory/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);
Sub GetStateInstance()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/GetStateInstanceHistory/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.Send

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    ' Range("A1").Value = response

    Set http = Nothing
End Sub