Skip to content

GetContacts#

Test

השיטה נועדה לקבל רשימה של אנשי הקשר הנוכחיים בחשבון.

עדכון מידע על אנשי קשר יכול להימשך עד 5 דקות.

אם מתקבל מערך נתונים ריק - חזור על קריאת השיטה.

בַּקָשָׁה#

כדי לקבל אנשי קשר, עליך לבצע בקשה בכתובת:

GET
{{apiUrl}}/waInstance{{idInstance}}/getContacts/{{apiTokenInstance}}
TEST

לפרמטרים של בקשת apiUrl, idInstance ו-apiTokenInstance, עיין ב לפני שמתחילים סָעִיף.

תְגוּבָה#

פרמטרי תגובה#

פָּרָמֶטֶר סוּג תֵאוּר
id string זיהוי משתמש או צ'אט קבוצתי
name string שם איש הקשר. גרסאות אפשריות:
1) אם יש תכתובות/תגובות נכנסות מהחשבון, אז אנחנו מקבלים את השם מפרופיל WhatsApp
2) אם אין תכתובות/תגובות נכנסות מהחשבון, אז נקבל שורה ריקה
contactName string שם איש הקשר מתוך ספר הטלפונים
type string סוג איש קשר. גרסאות אפשריות:
user - איש הקשר שייך למשתמש
group - איש קשר הוא צ'אט קבוצתי

גוף לדוגמא תגובה#

[
    {
        "id": "11001234567@c.us",
        "name": "Ivan Petrov",
        "contactName": "Ivan Petorov Work",
        "type": "user"
    },
    {
        "id": "79001234568@c.us",
        "name": "Lyusya Sidorova",
        "contactName": "Liusya Sidorova Sewing Circle",
        "type": "user"
    },
    {
        "id": "79001234569-1479621234@g.us",
        "name": "My group",  
        "type": "group"
    }
]

GetContacts שגיאות#

לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות סָעִיף

HTTP קוד תיאור שגיאה פתרונות אפשריים
200 השיטה getContacts מחזירה מערך ריק [] 1.סרוק מחדש את קוד ה-QR.
2. צור קשר עם התמיכה הטכנית.

בקש דוגמאות#

import requests

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

payload = {}
headers= {}

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

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

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

System.out.println(response);
Sub GetContacts()
    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}}/GetContacts/{{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