CallsHangUp#
גרסת בטא
הפונקציונליות נמצאת בגרסת בטא. הפונקציות עשויות להשתנות ועלולות לפעול באופן לא יציב. ייתכן שבעתיד תיגבה תשלום נוסף עבור הפונקציונליות.
ניתן לבקש גישה לפונקציונליות דרך התמיכה הטכנית של GREEN-API
השיטה מיועדת לסיום השיחה הנוכחית.
תגובה 200 OK פירושה רק שהסוכן קיבל את הפקודה. ניתן לעקוב אחר מצב השיחה באמצעות הסטטוסים בהתראות CallsRtc.
בקשה#
כדי לסיים את השיחה, יש לבצע בקשה לכתובת:
POST
{{apiUrl}}/waInstance{{idInstance}}/callsHangUp/{{apiTokenInstance}}
לקבלת פרמטרי הבקשה apiUrl, idInstance ו-apiTokenInstance, עיינו בסעיף לפני שמתחילים.
תגובה#
במקרה של הצלחה, השיטה מחזירה 200 OK ואת מזהה השיחה בגוף התגובה.
שדות התגובה#
| שדה | סוג | תיאור |
|---|---|---|
callId | string | מזהה השיחה |
דוגמה לגוף התגובה#
{
"callId": "89EBA9EA7847F8044CE47B6FADB7002F"
}
שגיאות#
לרשימת השגיאות המשותפות לכל השיטות, עיינו בסעיף שגיאות נפוצות
| קוד HTTP | גוף השגיאה | תיאור |
|---|---|---|
| 400 | שגיאה של סוכן השיחות | |
| 404 | המופע לא נמצא | |
| 409 | {"message": "no active call"} | אין שיחה פעילה — אין מה לסיים |
| 500 | {"message": "Hang up error: ..."} | שגיאה בעת סיום השיחה |
דוגמאות קוד#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/callsHangUp/{{apiTokenInstance}}"
payload = {}
headers = {}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text.encode('utf8'))
curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/callsHangUp/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/callsHangUp/")
.append({{apiTokenInstance}});
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, null, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/callsHangUp/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.asString();
System.out.println(response);