JavaScript WhatsApp API Calls Client Library#
גרסת בטא
הפונקציונליות נמצאת בגרסת בטא. הפונקציות עשויות להשתנות ועלולות לפעול באופן לא יציב. ייתכן שבעתיד תיגבה תשלום נוסף עבור הפונקציונליות.
ניתן לבקש גישה לפונקציונליות דרך התמיכה הטכנית של GREEN-API
הספרייה JavaScript WhatsApp API Calls Client מאפשרת לקבל ולבצע שיחות קוליות ב-WhatsApp מאפליקציות JavaScript ו-TypeScript דרך ה-API של שירות GREEN-API. הודעות האיתות מועברות ב-WebSocket, והשמע — ב-WebRTC, ולכן השיחות פועלות ישירות בדפדפן ללא התקנת תוכנה נוספת. כדי להשתמש בספרייה, יש לקבל את טוקן ה-API ואת מזהה המופע בקונסולה.
ממה מורכבת הספרייה#
GreenApiVoipClient— לקוח לעבודה עם שיטות ה-REST לניהול שיחות: התחלה, קבלה, דחייה וסיום של שיחה. פרטי הגישה מועברים לבנאי (constructor) של הלקוח.CallsConnection— האובייקט שמחזירה השיטהconnectCalls(). הוא יוצר חיבור WebSocket לקבלת אירועים על מצב השיחות והתראות על שיחות נכנסות. זרם השמע של השיחה מועבר בנפרד ב-WebRTC.
היתרונות של WebRTC:
- זמינות בדפדפנים
- השהיה נמוכה (שברירי שנייה), sub-second latency
- בקרת עומס (congestion control)
- הצפנה מחייבת
הרשאה בקונסולה#
כדי לבצע ולקבל שיחות, המופע חייב להיות במצב מורשה. כדי לבצע הרשאה למופע, עברו לקונסולה וסרקו את קוד ה-QR באמצעות אפליקציית WhatsApp. הספרייה מטפלת בשיחות בלבד ואינה משתתפת בהרשאת המופע.
לקוח מוכן המבוסס על ספרייה זו#
במאגר הקוד נמצא טלפון תוכנה פעיל שנבנה ב-React. זהו מימוש הייחוס שממנו כדאי להתחיל: כל מה שמתואר בסעיף זה מיושם בו בצורה עובדת.
- לקוח React — מה הוא יודע לעשות, כיצד להפעיל אותו וכיצד הוא בנוי
- voip.green-api.com — דוגמה פרוסה שניתן לפתוח בדפדפן בלי להתקין דבר
כיצד לבנות לקוח משלכם#
הסעיפים שלהלן עוברים על האינטגרציה שלב אחר שלב — מהגדרת הסביבה ועד לטיפול בכל אירוע.
- הגדרת הסביבה ודף ה-HTML
- התקנה וייבוא של הספרייה
- כיצד לבצע אתחול והרשאה בלקוח
- העברת שמע: גשר שמע וזרמי מדיה
- טיפול במצבי שיחה
- כיצד ליצור שיחה יוצאת
- כיצד לטפל בשיחה נכנסת
- כיצד לסיים או לדחות שיחה
שפרו את הדוגמאות שלנו על ידי הוספת רכיבי ממשק משתמש, טיפול בשגיאות וכל לוגיקה מותאמת אחרת הנדרשת לבניית השירות הייחודי שלכם.
דוגמאות נוספות#
- לקוח JavaScript ללא framework (Vanilla) — אותן שיחות ללא framework, כדי לבחון את ה-API בנפרד
תיעוד#
- Calls API — שיטות ה-REST והחיבור שעליהם בנויה הספרייה: מצב השיחה, חיוג, קבלה, דחייה, סיום
- תיעוד השיטות של שירות GREEN-API — שאר השיטות של המופע, לדוגמה, קבלת רשימת אנשי הקשר
- תיאור הספרייה (README)
- מדריך שלב אחר שלב
מוצרי צד שלישי#
לספרייה עצמה אין תלויות בזמן ריצה. לקוח ה-React מהדוגמאות משתמש ב-React, Redux Toolkit, React Router, Ant Design, אייקוני MUI ו-libphonenumber-js.
רישיון#
ברישיון MIT.