Skip to content

SetSettings#

Test Postman Apidog

השיטה מיועדת להגדרת ההגדרות של המופע.

בעת קריאה לשיטה זו, המופע מופעל מחדש.

ההגדרות מוחלות תוך 5 דקות לאחר הקריאה לשיטה setSettings.

לאחר יצירת המופע, כל ההגדרות מושבתות כברירת מחדל.

בקשה#

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

POST
{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}

לקבלת פרמטרי הבקשה apiUrl, idInstance ו-apiTokenInstance, עיינו בסעיף לפני תחילת העבודה.

פרמטרי הבקשה#

ניתן לציין רק חלק מהפרמטרים. יש לציין לפחות פרמטר אחד.

פרמטר סוג חובה תיאור
webhookUrl string לא כתובת URL לשליחת התראות. כדי להשבית את קבלת ההתראות, יש לציין מחרוזת ריקה. בעת קבלת התראות בטכנולוגיית HTTP API, השדה חייב להיות ריק. תיאור אופן הפעולה של השדה.
webhookUrlToken string לא אסימון (token) לגישה לשרת ההתראות שלכם. אם אינו נדרש, יש לציין מחרוזת ריקה. תיאור אופן הפעולה של השדה.
delaySendMessagesMilliseconds integer לא מרווח שליחת ההודעות במילישניות.
ערך מינימלי: 500 ms (0.5 שניות)
ערך מקסימלי: 600000 ms (10 דקות).
מומלץ להגדיר מרווח שאינו עולה על 300000 ms (5 דקות).
markIncomingMessagesReaded string לא סימון הודעות נכנסות כנקראו, ערכים אפשריים: yes, no. המערכת מתעלמת מההגדרה אם markIncomingMessagesReadedOnReply מוגדר ל-'yes'.
markIncomingMessagesReadedOnReply string לא סימון הודעות נכנסות כנקראו בעת שליחת הודעה דרך ה-API, ערכים אפשריים: yes, no. אם מוגדר ל-'yes', המערכת מתעלמת מההגדרה markIncomingMessagesReaded.
sharedSession string לא לא בשימוש
countryInstance string לא לא בשימוש
outgoingWebhook string לא קבלת התראות על סטטוסים של הודעות יוצאות, ערכים אפשריים: yes, no. לא ניתן להשבית את הסטטוסים noAccount ו-failed, ויש לממש את הטיפול בהתראה זו.
outgoingMessageWebhook string לא קבלת התראות על הודעות שנשלחו מהטלפון, ערכים אפשריים: yes, no
outgoingAPIMessageWebhook string לא קבלת התראות על הודעות שנשלחו דרך ה-API, ערכים אפשריים: yes, no. בעת שליחת הודעה לחשבון WhatsApp שאינו קיים, ההתראה לא תגיע.
stateWebhook string לא קבלת התראות על שינוי מצב ההרשאה של המופע, ערכים אפשריים: yes, no
incomingWebhook string לא קבלת התראות על הודעות וקבצים נכנסים, ערכים אפשריים: yes, no
deviceWebhook string לא לא פועל זמנית. קבלת התראות על המכשיר (הטלפון) ועל רמת הסוללה, ערכים אפשריים: yes, no
statusInstanceWebhook string לא לא בשימוש
enableMessagesHistory string לא לא בשימוש
keepOnlineStatus string לא הגדרת הסטטוס 'מקוון' (online) לחשבון
pollMessageWebhook string לא קבלת התראות על סקרים, ערכים אפשריים: yes, no
incomingBlockWebhook string לא לא פועל זמנית. קבלת התראות על חסימות נכנסות של צ'אטים, ערכים אפשריים: yes, no
incomingCallWebhook string לא קבלת התראות על שיחות נכנסות, ערכים אפשריים: yes, no
editedMessageWebhook string לא קבלת התראות על הודעות שנערכו: yes, no
deletedMessageWebhook string לא קבלת התראות על הודעות שנמחקו: yes, no
catalogWebhook string לא קבלת התראות על הודעות עם מוצר ועם הזמנה, ערכים אפשריים: yes, no. ברירת המחדל: no
autoTyping integer לא חישוב אוטומטי של זמן הקלדת ההודעה בהתאם לערך שהוגדר. הערך קובע את מהירות הקלדת ההודעה, מ-5 עד 50 תווים בשנייה. מקבל ערכים מ-0 עד 10. הערך 0 – מהירות ההקלדה האוטומטית מושבתת, 1 – 5 תווים בשנייה, 5 – 25 תווים בשנייה, 10 – 50 תווים בשנייה. אם בעת שליחת ההודעה צוין הפרמטר typingTime, הוא מקבל עדיפות. מידע נוסף על ההגדרה מופיע במאמר
linkPreview string לא הפרמטר קובע את הצגת התצוגה המקדימה של קישורים בשיטות שליחת הודעות. תצוגה מקדימה של הקישור לא תתווסף אם גודל הקובץ עולה על 2MB. ערכים אפשריים: yes, no
enableLidMode string לא עבודה עם מזהי צ'אט בפורמט @lid. כדי להחיל את ההגדרה, יש להפעיל מחדש את המופע ולאחר מכן להתחבר שוב באמצעות סריקת קוד ה-QR. מידע נוסף על עבודה עם @lid. ברירת המחדל: no. ערכים אפשריים: yes, no
incomingMessageStatusWebhook string לא קבלת אישור קריאה עבור הודעה נכנסת מהטלפון (מכשיר מקושר); ערכים אפשריים: yes, no. למידע נוסף על אופן השימוש בהגדרה זו ועל המגבלות הקשורות אליה, אנא עיינו בשאלות הנפוצות

החלת ההגדרות

כדי לקבל התראות על סטטוסי השליחה, המסירה והקריאה של הודעות שנשלחו מהטלפון, יש להפעיל את ההגדרות:

  • outgoingMessageWebhook
  • outgoingWebhook

כדי לקבל התראות על סטטוסים של שיחה נכנסת, יש להפעיל את ההגדרות:

  • incomingCallWebhook
  • incomingWebhook

ההגדרה pollMessageWebhook פועלת רק כאשר מופעלים הפרמטרים הבאים:

  • outgoingAPIMessageWebhook – עבור הודעות שנשלחו דרך ה-API
  • outgoingMessageWebhook – עבור הודעות שנשלחו מהטלפון
  • incomingWebhook – עבור הודעות נכנסות

אם הטלפון והמכשירים המקושרים כבויים, יש להפעיל את ההגדרה:

  • keepOnlineStatus – כדי להגדיר לחשבון את הסטטוס Online ולשלוח את סטטוס ההודעה delivered

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

  • editedMessageWebhook
  • deletedMessageWebhook

דוגמה כללית לגוף הבקשה#

{
    "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",
    "editedMessageWebhook": "no",
    "deletedMessageWebhook": "no",
    "catalogWebhook": "no",
    "autoTyping" : 0,
    "linkPreview": "no",
    "enableLidMode": "no",
    "incomingMessageStatusWebhook": "no"
}

תגובה#

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

פרמטר סוג תיאור
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