GetWaSettings#
השיטה נועדה לקבל מידע על חשבון WhatsApp
בקשה#
כדי לקבל מידע על חשבון WhatsApp עליך לבצע בקשה בכתובת:
{{apiUrl}}/waInstance{{idInstance}}/getWaSettings/{{apiTokenInstance}}
לקבלת פרמטרי הבקשה 'apiUrl', 'idInstance' ו- 'apiTokenInstance', עיין ל לפני שתתחיל במקטע.
תגובה#
פרמטרים של תגובה#
| פרמטר | סוג | תיאור |
|---|---|---|
avatar | string | כתובת URL של אווטאר חשבון WhatsApp |
base64Avatar | string | base64 אווטאר בפורמט |
chatId | string | lid של החשבון המחובר כעת. אם המופע אינו מורשה, שדה זה מחזיר מחרוזת ריקה. |
phone | string | מספר חשבון WhatsApp |
historySyncProgress | מספר שלם | אחוז מהיסטוריית הצ'אט שהורדה במופע |
stateInstance | string | מצב מופע. יש גרסאות: |
notAuthorized - המופע אינו מורשה. לדוגמה, הרשאה: לפני שתתחיל במקטע | ||
authorized - המופע מורשה | ||
blocked - מופע נאסר | ||
sleepMode - Status is out of date. המופע נמצא במצב שינה. המצב אפשרי כאשר הטלפון כבוי. לאחר הפעלת הטלפון, ייתכן שיחלפו עד 5 דקות עד שמצב המופע ישתנה ל- authorized. | ||
starting - המופע נמצא בתהליך של אתחול (מצב שירות). מופע, שרת או מופע במצב תחזוקה מאותחל מחדש. ייתכן שיחלפו עד 5 דקות עד שמצב המופע יוגדר כ authorized. | ||
yellowCard - שליחת הודעות הושעתה זמנית במקרה זה עקב פעילות ספאם. הודעות שנשלחות לאחר קבלת הסטטוס נשמרות בתור לשליחה למשך 24 שעות | ||
deviceId | string | Device ID |
logoutProcess | boolean | תהליך ניקוי נתוני המופע פועל. לא ניתן לקבל הרשאה למופע. אנא המתן להשלמת התהליך |
אם המופע כולל את המצב 'notAuthorized', 'חסום' או
starting, השדותavatar,chatId,phone,deviceIdיהיו ריקים.
דוגמה לאפשרות תגובה#
{
"stateInstance": "authorized",
"deviceId": "0123456789:26@s.whatsapp.net",
"chatId": "209723420885003@lid",
"phone": "0123456789",
"historySyncProgress": 100,
"avatar": "https://pps.whatsapp.net/v/t61.24694-24/362901986_992130525270289_51888663873132080_n.jpg?stp=dst-jpg_s96x96&ccb=11-4&oh=01_AdQyzknkSczbj9GISmMOEgba4hnYLqqtAoLaLpT5GvJ5wQ&oe=64F40542&_nc_cat=106",
"base64Avatar": "data:image/png;base64,/9j/4 ... AA/9k="
}
גוף תגובה לדוגמה בעת הפעלת תהליך ניקוי הנתונים על מופע#
```json { "stateInstance": "notAuthorized", "logoutProcess": true, "avatar": "" }
שגיאות GetWaSettings#
לקבלת רשימה של שגיאות המשותפות לכל השיטות, עיין במאמר שגיאות נפוצות במקטע
שאילתות לדוגמה#
```python import requests
The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed#
url = "{{apiUrl}}/waInstance{{idInstance}}/getWaSettings/{{apiTokenInstance}}"
payload = {} headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text.encode('utf8')) ```
```php <?php //The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed $url = "{{apiUrl}}/waInstance{{idInstance}}/getWaSettings/{{apiTokenInstance}}";
$options = array( 'http' => array( 'header' => "Content-Type: application/json\r\n", 'method' => 'GET' ) );
context = stream_context_create(options);
response = file_get_contents(url, false, $context);
echo $response; ?> ```
c curl --location '{{apiUrl}}/waInstance{{idInstance}}/getWaSettings/{{apiTokenInstance}}'
```java var restTemplate = new RestTemplate(); var requestUrl = new StringBuilder(); requestUrl .append({{apiUrl}}) .append("/waInstance").append({{idInstance}}) .append("/getWaSettings/") .append({{apiTokenInstance}});
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class); System.out.println(response); ```
```java var requestUrl = new StringBuilder(); requestUrl .append({{apiUrl}}) .append("/waInstance").append({{idInstance}}) .append("/getWaSettings/") .append({{apiTokenInstance}});
var response = Unirest.get(requestUrl.toString()) .header("Content-Type", "application/json") .asString();
System.out.println(response); ```
```VB Sub GetWaSettings() 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}}/getWaSettings/{{apiTokenInstance}}"
Set http = CreateObject("WinHttp.WinHttpRequest.5.1")
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
```
```delphi program GetWaSettings;
{$APPTYPE CONSOLE}
uses System.SysUtils, System.Classes, System.Net.HttpClient, System.Net.URLClient, System.Net.HttpClientComponent;
var HttpClient: TNetHTTPClient; RequestHeaders: TNetHeaders; Response: IHTTPResponse; EndpointURL, ID_INSTANCE, API_TOKEN_INSTANCE: string;
begin ID_INSTANCE := '110100001'; API_TOKEN_INSTANCE := 'd75b3a66374942c5b3c019c698abc2067e151558acbd451234';
EndpointURL := 'https://api.green-api.com/waInstance' + ID_INSTANCE + '/getWaSettings/' + API_TOKEN_INSTANCE;
HttpClient := TNetHTTPClient.Create(nil); RequestHeaders := [ TNetHeader.Create('Content-Type', 'application/json') ];
try Response := HTTPClient.Get(EndpointURL, nil, RequestHeaders);
if Response.StatusCode = 200 then
Writeln('[Response]: ' + Response.ContentAsString)
else
Writeln('[ERROR ' + IntToStr(Response.StatusCode) + ']:' + Response.StatusText + '' + Response.ContentAsString);
readln;
except on E: Exception do Writeln(E.ClassName, ': ', E.Message); end;
HttpClient.Free;
end. ```