למי המדריך הזה

שיטת ה-Webhook בתוסף קליק2קול מחברת את החיוג למערכת שלכם: בכל קליק על מספר נשלחת בקשת HTTP לכתובת שתגדירו. המדריך מתאר את מבנה הבקשה והתגובה הנדרשת, למי שמחבר מרכזייה, CRM או מערכת חיוג משלו.

הבקשה

  • שיטה: POST
  • Content-Type: application/json
  • כתובת: הכתובת שהגדרתם בהגדרות התוסף (https בלבד)
  • Headers: בנוסף ל-Content-Type נשלחים גם ה-Headers המותאמים שהגדרתם

גוף הבקשה (JSON) כולל תמיד את שדות הבסיס:

{
  "captured": "054-746-9859",
  "stripped": "0547469859",
  "source": "extra-click2call-ext:click",
  "ts": 1718000000000
}

שדות הבסיס:

  • captured - המספר כפי שזוהה בעמוד (טקסט גולמי).
  • stripped - המספר ללא תווים שאינם ספרות.
  • source - מקור החיוג: extra-click2call-ext:click (קליק על מספר), :context-menu (קליק ימני), :popup (חיוג ידני מהתוסף), :test (שיחת בדיקה).
  • ts - חותמת זמן במילישניות.

שדות מותאמים

אפשר להוסיף לגוף הבקשה שדות JSON נוספים, וכן Headers מותאמים. בערכים אפשר לשלב את הסימונים {captured}, {stripped}, {source} ו-{ts}, שיוחלפו בערכים בפועל בעת השליחה - כך, למשל, שדה בשם to בערך {stripped} יישלח עם המספר. שדות הבסיס תמיד נכללים ולא ניתן לדרוס אותם.

התגובה הנדרשת

מה שקובע אם השיחה הצליחה הוא קוד ה-HTTP:

  • 2xx - הצלחה.
  • כל קוד אחר - כישלון.

אופציונלי, אם תחזירו גוף JSON התוסף יכול להציג ממנו טקסט למשתמש:

  • "message" - הודעה שתוצג למשתמש (בהצלחה או בכישלון).
  • "error" - הודעת שגיאה שתוצג בכישלון.
  • "success": false - מסמן כישלון גם אם קוד ה-HTTP תקין. שימושי אם המערכת שלכם תמיד מחזירה 200.

אלה כל השדות שהתוסף קורא מהתגובה - אין פרמטרים נוספים שאפשר להחזיר כדי לשנות את התנהגות התוסף.

דוגמה לתגובת הצלחה (קוד 200):

{
  "message": "השיחה הועברה למרכזייה"
}

התוסף יציג את ה-"message" כאישור. גם תשובת 200 ללא גוף כלל נחשבת הצלחה.

דוגמה לתגובת כישלון (קוד 503):

{
  "error": "הקו תפוס או לא מחובר"
}

התוסף יציג למשתמש את הטקסט שב-"error".

הרשאת גישה לכתובת

כדי שהתוסף יוכל לשלוח בקשה לכתובת שלכם יש לאשר גישה אליה בהגדרות התוסף, בכפתור "אישור גישה לכתובת". הכתובת חייבת להיות https.

בדיקה מהירה

לפני החיבור למערכת האמיתית מומלץ להפנות את ה-Webhook ל-webhook.site: פותחים כתובת ייעודית, מדביקים אותה בהגדרות התוסף, ולוחצים על מספר - webhook.site יציג בדיוק את הבקשה שנשלחה, כולל הכותרות והגוף.

חזרה למדריך ההתקנה

להגדרת התוסף וכל שיטות החיוג ראו את מדריך ההתקנה וההגדרה.