CallsRtc#

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

• השרת מדווח מה קורה בשיחה: החל חיוג, התקבלה שיחה נכנסת, השיחה התחילה, השיחה הסתיימה;
• האפליקציה והשרת מתאמים ביניהם את העברת השמע בטכנולוגיית WebRTC.

יש לפתוח את החיבור לפני שקוראים לשיטה כלשהי של שיחות, ולהשאיר אותו פתוח לאורך כל השיחה. השיטות callsDial, callsAccept, callsReject ו-callsHangUp מחזירות 200 OK. מה קורה בשיחה בהמשך ניתן לראות רק מההודעות בחיבור זה.

חיבור#

כדי לקבל הודעות על שיחות, יש ליצור חיבור websocket לכתובת:

{{apiUrl}}/waInstance{{idInstance}}/callsRtc/{{apiTokenInstance}}

הכתובת זהה לכתובת של שאר השיטות, רק הסכמה שונה: במקום https מציינים wss.

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

פורמט ההודעות#

ההודעות מועברות בפורמט JSON. בכל הודעה יש שדה type, ושאר השדות תלויים בערכו: מלבד type, הודעה מכילה לכל היותר שדה נתונים אחד, ובחלק מההודעות אין שדה כזה כלל. מערכי ההודעות בשני הכיוונים שונים — אין פורמט אחיד לשני הצדדים.

הודעות מהשרת#

הודעות מהאפליקציה#

הודעה מסוג stop נשלחת ללא שדות נוספים — {"type": "stop"} — ומשמעותה שהאפליקציה אינה מעבירה עוד שמע.

מצב השיחה#

האובייקט state מתאר מה קורה כעת בשיחה.

האובייקט info#

סיבות לסיום שיחה#

ערך השדה reason הוא ההסבר של השרת לסיבה שבגללה השיחה הסתיימה. ערכים ידועים:

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

שגיאות#

השרת מדווח על שגיאה בהודעה מסוג error, וטקסט השגיאה נמצא בשדה message.

{
    "type": "error",
    "message": "no active call"
}

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

דוגמאות להודעות#

החל חיוג בשיחה יוצאת:

{
    "type": "state",
    "state": {
        "state": "out-call"
    }
}

השיחה הסתיימה כי היא נותקה:

{
    "type": "state",
    "state": {
        "state": "idle",
        "reason": "hangup"
    }
}

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

{
    "type": "stop"
}