Skip to content

GetSettings#

Test

השיטה מכוונת לקבלת הגדרות המופע הנוכחיות.

בַּקָשָׁה#

כדי לקבל את הגדרות המופע הנוכחיות עליך לבצע בקשה בכתובת:

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

לקבלת פרמטרים של בקשת 'apiUrl', 'idInstance' ו- 'apiTokenInstance', עיין ב לפני שתתחיל section.

תְגוּבָה#

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

פָּרָמֶטֶר סוּג תֵאוּר
wid string מזהה חשבון בווטסאפ
countryInstance string הוצא משימוש
typeAccount string הוצא משימוש
webhookUrl string כתובת URL לקבלת הודעות נכנסות. בעת קבלת הודעות עם HTTP API טכנולוגיה, השדה חייב להיות ריק. תיאור של אופן פעולת התחום.
webhookUrlToken string אסימון לחיבור לשרת ה-webhook שלך. תיאור של אופן פעולת התחום.
delaySendMessagesMilliseconds integer עיכוב בשליחת הודעה הוא במילישניות
markIncomingMessagesReaded string סמן הודעות נכנסות כנקראו או לא, גרסאות אפשריות: 'כן', 'לא'. התעלם אם markIncomingMessagesReadedOnReply הוא 'כן'.
markIncomingMessagesReadedOnReply string סמן הודעות נכנסות כנקראו בעת שליחת הודעה לצ'אט באמצעות API, גרסאות אפשריות: 'כן', 'לא'. אם 'כן', מתעלמים מהגדרת markIncomingMessagesReaded.
sharedSession string הוצא משימוש
outgoingWebhook string קבל התראות לגבי סטטוס שליחת/מסירה/קריאה של הודעות יוצאות, גרסאות אפשריות: 'כן', 'לא'
outgoingMessageWebhook string קבל התראות על הודעות שנשלחו מהטלפון, גרסאות אפשריות: 'כן', 'לא'
outgoingAPIMessageWebhook string קבל התראות על הודעות שנשלחו מ-API, גרסאות אפשריות: 'כן',' לא'. בעת שליחת הודעה לחשבון וואטסאפ לא קיים, ההודעה לא תגיע.
incomingWebhook string קבל התראות על הודעות וקבצים נכנסים, גרסאות אפשריות: 'כן', 'לא'
deviceWebhook string Temporarily out of service. קבל התראות לגבי המכשיר (טלפון) ורמת הסוללה, גרסאות אפשריות: 'כן', 'לא'
statusInstanceWebhook string הוצא משימוש
stateWebhook string קבל התראות על שינויים בסטטוס הרשאת המופע, גרסאות אפשריות: 'כן', 'לא'
enableMessagesHistory string הוצא משימוש
keepOnlineStatus string מגדיר את הסטטוס 'מקוון' עבור חשבונך
pollMessageWebhook string קבל התראות על יצירת סקר והצבעה בסקר, גרסאות אפשריות: 'כן', 'לא'
incomingBlockWebhook string Temporarily out of service. קבל התראות על הוספת צ'אט לרשימת אנשי הקשר החסומים, גרסאות אפשריות: 'כן', 'לא'
incomingCallWebhook string קבל התראות על סטטוסים של שיחות נכנסות, גרסאות אפשריות: 'כן', 'לא'

Applying settings

To receive notifications regarding the statuses of sending/delivery/read receipts of messages sent from a mobile phone, it is necessary to enable the following settings:

  • outgoingMessageWebhook
  • outgoingWebhook

To receive notifications about the statuses of an incoming call, it is necessary to enable the following settings:

  • incomingCallWebhook
  • incomingWebhook

To receive notifications about polls and poll updates, it is necessary to enable the following settings:

  • For messages sent via the API: outgoingAPIMessageWebhook and pollMessageWebhook
  • For messages sent from the phone: outgoingMessageWebhook and pollMessageWebhook
  • For notifications about incoming polls and poll responses: incomingWebhook and pollMessageWebhook

If your phone and linked devices are turned off, you need to enable the setting:

  • keepOnlineStatus to set the Online status for your account and send the message status delivered

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

{
    "wid": "11001234567@c.us",
    "countryInstance": "",
    "typeAccount": "",
    "webhookUrl": "https://mysite.com/webhook/green-api/",
    "webhookUrlToken": "",
    "delaySendMessagesMilliseconds": 5000,
    "markIncomingMessagesReaded": "no",
    "markIncomingMessagesReadedOnReply": "no",
    "sharedSession": "no",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "outgoingAPIMessageWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no", //The notification is temporarily out of work
    "statusInstanceWebhook": "no",
    "stateWebhook": "no",
    "enableMessagesHistory": "no",
    "keepOnlineStatus": "no",
    "pollMessageWebhook": "no",
    "incomingBlockWebhook": "yes", //The notification is temporarily out of work
    "incomingCallWebhook": "yes"
}

שגיאות GetSettings#

לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות במקטע

טקסט תגובה לדוגמה#

import requests

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

payload = {}
headers= {}

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

print(response.text.encode('utf8'))
<?php
//The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
$url = "{{apiUrl}}/waInstance{{idInstance}}/getSettings/{{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;
?>
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getSettings/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getSettings/")
    .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("/getSettings/")
    .append({{apiTokenInstance}});

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

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

{$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.greenapi.com/waInstance' + ID_INSTANCE + '/getSettings/' + 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.