Skip to content

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": "79876543210@c.us"
    },
    {
        "stateInstance": "notAuthorized",
        "timestamp": 1778132743,
        "phoneNumber": "79876543210@c.us"
    },
    {
        "stateInstance": "authorized",
        "timestamp": 1778132546,
        "phoneNumber": "79876543210@c.us"
    },
    {
        "stateInstance": "notAuthorized",
        "timestamp": 1778131747,
        "phoneNumber": "79876543210@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