Skip to content

Calls API#

גרסת בטא

הפונקציונליות נמצאת בגרסת בטא. הפונקציות עשויות להשתנות ועלולות לפעול באופן לא יציב.

לשאלות לגבי חיבור לתעריף ותנאים נוספים, נא לכתוב לכתובת support@green-api.com או בצ'אט באתר.

תעריף "שיחות" מספק ממשק REST API אוניברסלי לניהול שיחות WhatsApp נכנסות ויוצאות.

תוכן העניינים#

  1. יכולות
  2. הרשאת מופע לתעריף "שיחות"
  3. התחלה מהירה בעבודה עם שיחות
    3.1. תרחיש של שיחה יוצאת
    3.2. תרחיש של שיחה נכנסת
  4. שיטות לניהול שיחות
    4.1 שליטה בשיחה
    4.2 איתות שיחות
  5. ספרייה לדפדפן ודוגמה מוכנה

1. יכולות#

התעריף מאפשר לבצע ולקבל שיחות עם משתמשי WhatsApp. משך שיחה אחת אינו עולה על 90 דקות.

2. הרשאת מופע לתעריף "שיחות"#

כדי לעבוד עם תעריף "שיחות", יש לבצע הרשאה למופע. הרשאת המופע מתבצעת בקונסולה על ידי סריקת קוד QR באפליקציית המובייל WhatsApp Business או WhatsApp.

3. התחלה מהירה בעבודה עם שיחות#

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

מצב השיחה מגיע בחיבור זה בהודעה מסוג state ומקבל את הערכים idle (אין שיחה), inc-call (התקבלה שיחה נכנסת), out-call (מתבצעת שיחה יוצאת) ו-on-call (השיחה מתנהלת).

3.1. תרחיש של שיחה יוצאת#

  1. לפתוח את החיבור CallsRtc.
  2. להתחיל שיחה באמצעות השיטה CallsDial, ולציין את מזהה הצ'אט של הצד השני. תגובה 200 OK עם מזהה השיחה פירושה שהפקודה התקבלה; החיוג ניכר במעבר המצב ל-out-call.
  3. לקבל את רשימת השרתים באמצעות השיטה CallsGetIceServers ולשלוח בחיבור הצעה להעברת שמע — הודעה מסוג offer. יש לשלוח אותה רק לאחר שהשיטה callsDial הסתיימה.
  4. להמתין בחיבור לתשובת השרת — הודעה מסוג answer — ולהחליף הודעות מסוג ice-candidate. לאחר מכן השמע עובר בשני הכיוונים.
  5. כאשר הצד השני עונה לשיחה, המצב עובר ל-on-call.
  6. לסיים את השיחה באמצעות השיטה CallsHangUp. השיחה הסתיימה כאשר המצב עבר ל-idle; באותה הודעה השרת עשוי לציין את הסיבה בשדה reason.

3.2. תרחיש של שיחה נכנסת#

  1. לפתוח את החיבור CallsRtc.
  2. על שיחה נכנסת מדווח המצב inc-call. מי מתקשר — באובייקט info: שם נמצאים מזהה הצד השני, ואם WhatsApp העביר אותו, גם השם.
  3. לקבל את השיחה באמצעות השיטה CallsAccept או לדחות אותה באמצעות השיטה CallsReject. השרת מסמן את תחילת השיחה במעבר המצב ל-on-call.
  4. לאחר קבלת השיחה, לקבל את רשימת השרתים באמצעות השיטה CallsGetIceServers ולשלוח הצעה להעברת שמע — הודעה מסוג offer. גם בשיחה נכנסת, את ההצעה יוצרת האפליקציה שלכם ולא השרת.
  5. להמתין להודעה מסוג answer ולהחליף הודעות מסוג ice-candidate. לאחר מכן השמע עובר בשני הכיוונים.
  6. לסיים את השיחה באמצעות השיטה CallsHangUp — המצב יעבור ל-idle.

4. שיטות לניהול שיחות#

4.1 שליטה בשיחה#

4.2 איתות שיחות#

  • CallsRtc — מצב השיחה והעברת שמע

5. ספרייה לדפדפן ודוגמה מוכנה#

אם השיחות נדרשות בדפדפן, כל מה שתואר לעיל כבר מומש בספרייה @green-api/whatsapp-api-calls-client-js: היא מתחזקת את החיבור CallsRtc, קוראת לשיטות השליטה בשיחה ומעבירה שמע באמצעות WebRTC.