CallsDial#
מגבלות זמניות
ניתן לחבר את התוכנית Ultra, לשיחות ללא הגבלה, רק עבור instances חדשים. לשאלות בנוגע לחיבור לתוכנית ולתנאים נוספים, אנא פנו לתמיכה הטכנית של GREEN-API או לצ׳אט באתר.
כרגע זמינות רק שיחות אישיות.
השיטה מיועדת להתחלת שיחה יוצאת.
תגובה 200 OK פירושה רק שהסוכן קיבל את הפקודה. ניתן לעקוב אחר מצב השיחה באמצעות הסטטוסים בהתראות CallsRtc.
בקשה#
כדי להתחיל שיחה יוצאת, יש לבצע בקשה לכתובת:
POST
{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}
לקבלת פרמטרי הבקשה apiUrl, idInstance ו-apiTokenInstance, עיינו בסעיף לפני שמתחילים.
פרמטרים של גוף הבקשה#
| פרמטר | סוג | חובה | תיאור |
|---|---|---|---|
chatId | string | כן | מזהה הצ'אט של הצד השני, לדוגמה 79001234567@c.us או 120650379300963@lid |
דוגמה לגוף הבקשה#
{
"chatId": "79001234567@c.us"
}
{
"chatId": "120650379300963@lid"
}
תגובה#
במקרה של הצלחה, השיטה מחזירה 200 OK ואת מזהה השיחה בגוף התגובה.
שדות התגובה#
| שדה | סוג | תיאור |
|---|---|---|
callId | string | מזהה השיחה |
דוגמה לגוף התגובה#
{
"callId": "89EBA9EA7847F8044CE47B6FADB7002F"
}
שגיאות#
לרשימת השגיאות המשותפות לכל השיטות, עיינו בסעיף שגיאות נפוצות
| קוד HTTP | גוף השגיאה | תיאור |
|---|---|---|
| 400 | {"message": "chatId must look like 79001234567@c.us or 123456789012345@lid"} | chatId אינו תואם לפורמט הנדרש |
| 404 | המופע לא נמצא | |
| 500 | {"message": "Dial error: ..."} | שגיאת חיוג בצד של WhatsApp |
| 503 | {"message": "call refused: call_failed"} | WhatsApp דחה את השיחה, השיחה לא התחילה |
דוגמאות קוד#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}"
payload = {
"chatId": "79001234567@c.us"
}
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload, headers=headers)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/callsDial/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "79001234567@c.us"
}'