SetSettings#
השיטה מיועדת להגדרת הגדרות מופע.
כאשר שיטה זו מתבקשת, המופע מאותחל מחדש.. .
ההגדרות מוחלות תוך 5 דקות לאחר הפעלת שיטת setSettings
לאחר יצירת מופע, כל ההגדרות מבוטלות כברירת מחדל.
בקשה#
כדי להגדיר הגדרות מופע, עליך לבצע בקשה בכתובת:
לקבלת פרמטרי הבקשה 'apiUrl', 'idInstance' ו- 'apiTokenInstance', עיין ב לפני שתתחיל במקטע.
פרמטרים של בקשה#
מפרט סלקטיבי של פרמטרים מותר. יש לציין לפחות פרמטר אחד.
פרמטר | סוג | חובה | תיאור |
---|---|---|---|
webhookUrl | string | No | כתובת URL לשליחת התראות. אם נדרש להשבית קבלת הודעות, ציין מחרוזת ריקה. בעת קבלת התראות עם [HTTP API](../receiving/technology-http-api.mdטכנולוגיה, השדה חייב להיות ריק. Description of how the field works. |
webhookUrlToken | string | No | אסימון כדי לגשת לשרת ההודעות, אם אינו נדרש, ולאחר מכן ציין מחרוזת ריקה. Description of how the field works. |
delaySendMessagesMilliseconds | integer | No | Message sending delay הוא באלפיות השנייה. הערך המינימלי הוא 500 msec. ערך מרבי: 86400000 msec |
markIncomingMessagesReaded | string | No | סמן הודעות נכנסות כהודעות שנקראו או לא, וריאנטים אפשריים: 'כן', 'לא'. המערכת מתעלמת אם markIncomingMessagesReadedOnReply הוא 'כן' |
markIncomingMessagesReadedOnReply | string | No | סמן הודעות נכנסות כהודעות שנקראו בעת פרסום הודעה בצ'אט באמצעות API, גרסאות אפשריות: 'כן', 'לא'. אם הוא 'כן', המערכת מתעלמת מההגדרה markIncomingMessagesReaded. |
sharedSession | string | No | הוצאה משימוש |
countryInstance | string | No | הוצאה משימוש |
outgoingWebhook | string | No | קבל התראות על סטטוסים של שליחת/מסירה/קריאה של הודעות יוצאות, גרסאות אפשריות: 'כן',' לא'. noAccount and failed לא ניתן לבטל סטטוסים, יש צורך ליישם את העיבוד של הודעה זו. |
outgoingMessageWebhook | string | No | קבל התראות על הודעות שנשלחו מהטלפון, גרסאות אפשריות: 'כן', 'לא'` |
outgoingAPIMessageWebhook | string | No | קבל התראות על הודעות שנשלחו מ- API, גרסאות אפשריות: 'כן', 'לא'. בעת שליחת הודעה לחשבון WhatsApp שאינו קיים, ההודעה לא תגיע. |
stateWebhook | string | No | קבל הודעות על שינוי מצב הרשאת המופע, וריאנטים אפשריים: 'כן', 'לא' |
incomingWebhook | string | No | קבל התראות על הודעות וקבצים נכנסים, וריאנטים אפשריים: 'כן', 'לא' |
deviceWebhook | string | No | Temporarily not working. קבל התראות על המכשיר (טלפון) ורמת הסוללה, גרסאות אפשריות: 'כן', 'לא' |
statusInstanceWebhook | string | No | הוצאה משימוש |
enableMessagesHistory | string | No | הוצאה משימוש |
keepOnlineStatus | string | No | הגדרת סטטוס 'מקוון' עבור החשבון שלך |
pollMessageWebhook | string | No | קבל התראות על יצירת סקר והצבעה בסקר, גרסאות אפשריות: 'כן', 'לא' |
incomingBlockWebhook | string | No | Temporarily not working. קבל התראות על הוספת צ'אט לרשימת אנשי הקשר החסומים, וריאנטים אפשריים: 'כן', 'לא' |
incomingCallWebhook | string | No | קבל התראות על סטטוס שיחות נכנסות, וריאנטים אפשריים: 'כן', 'לא' |
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
The pollMessageWebhook
setting is activated only when the following parameters are enabled:
outgoingAPIMessageWebhook
for messages sent via the APIoutgoingMessageWebhook
for messages sent from the phoneincomingWebhook
for incoming messages
If your phone and linked devices are turned off, you need to enable the setting:
keepOnlineStatus
to set theOnline
status for your account and send the message statusdelivered
דוגמה כללית לגוף הבקשה#
{
"webhookUrl": "https://mysite.com/webhook/green-api/",
"webhookUrlToken": "",
"delaySendMessagesMilliseconds": 5000,
"markIncomingMessagesReaded": "no",
"markIncomingMessagesReadedOnReply": "no",
"outgoingWebhook": "yes",
"outgoingMessageWebhook": "yes",
"outgoingAPIMessageWebhook": "yes",
"incomingWebhook": "yes",
"deviceWebhook": "no", // The notification is temporarily out of work
"stateWebhook": "yes",
"keepOnlineStatus": "no",
"pollMessageWebhook": "no",
"incomingBlockWebhook": "yes", // The notification is temporarily out of work
"incomingCallWebhook": "yes"
}
תגובה#
פרמטרים של תגובה#
פרמטר | סוג | תיאור |
---|---|---|
saveSettings | boolean | סמן בדגל שההגדרות נשמרו |
שאילתות לדוגמה#
{
"saveSettings": true
}
SetSettings שגיאות#
לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות סָעִיף
בקשות לדוגמה#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}"
payload = "{\r\n\t\"webhookUrl\": \"https://mysite.ru\",\r\n\t\"delaySendMessagesMilliseconds\": 1000,\r\n\t\"markIncomingMessagesReaded\": \"no\",\r\n\t\"outgoingWebhook\": \"yes\",\r\n\t\"stateWebhook\": \"yes\",\r\n\t\"incomingWebhook\": \"yes\",\r\n\t\"deviceWebhook\": \"no\"\r\n}"
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data '{
"delaySendMessagesMilliseconds": 15000
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/setSettings/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"delaySendMessagesMilliseconds\": 15000}";
var requestEntity = new HttpEntity<>(jsonBody, headers);
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/setSettings/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"delaySendMessagesMilliseconds\": 15000}")
.asString();
System.out.println(response);
Sub SetSettings()
Dim url As String
Dim RequestBody 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}}/SetSettings/{{apiTokenInstance}}"
' parameters obtained by the GetSettings method that need to be changed
RequestBody = "{""webhookUrl"":"""",""delaySendMessagesMilliseconds"":""1000"",""markIncomingMessagesReaded"":""yes"",""outgoingWebhook"":""yes"",""stateWebhook"":""yes"",""incomingWebhook"":""yes"",""incomingBlockWebhook"":""yes""}"
Set http = CreateObject("MSXML2.XMLHTTP")
With http
.Open "POST", url, False
.setRequestHeader "Content-Type", "application/json"
.Send RequestBody
End With
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
' Range("A1").Value = response
Set http = Nothing
End Sub