איך מפעילים שיחה מיידית דרך API
בקשה אחת מפעילה שיחה יוצאת של הסוכן למספר אחד, מיד. לשליחת לידים רבים עדיף רשימת חיוג שמתמלאת דרך API.
צרו מפתח API עם ההרשאה calls:place
העתיקו את מזהה הסוכן
המזהה מופיע בכתובת של עמוד הסוכן, אחרי
agents/.שלחו בקשת POST עם מזהה הסוכן ומספר הטלפון
בקשה לדוגמה
curl -X POST 'https://platform.direnium.com/api/v1/calls' \
-H 'Authorization: Bearer <API-KEY>' \
-H 'Content-Type: application/json' \
-d '{
"agentId": "<AGENT-ID>",
"to": "+9725XXXXXXXX",
"variables": { "first_name": "Dana", "car_model": "Mazda 3" },
"idempotencyKey": "lead-48213-call-1"
}'| שדה | תיאור |
|---|---|
agentId | מזהה הסוכן שיתקשר. |
to | מספר הטלפון של הלקוח, רצוי בפורמט בינלאומי. |
variables | ערכים למשתנים שבתסריט, לפי שם המשתנה. |
idempotencyKey | מזהה משלכם לבקשה. בקשה חוזרת עם אותו מזהה מחזירה את אותה שיחה ולא מחייגת שוב. |
תשובה: 201
{
"id": "<CALL-ID>",
"status": "dialing",
"to": "+9725XXXXXXXX",
"createdAt": "<ISO-TIME>"
}שם של כל ערך ב-variables חייב להיות זהה לשם של משתנה בתסריט. ראו איך מעבירים פרטים מה-API לסוכן.
אילו שגיאות אפשר לקבל?
400: שדה חסר, או מספר טלפון לא תקין או ליעד שלא נתמך.401: המפתח חסר או שגוי.403: למפתח אין את ההרשאה, הסוכן כבוי, נגמרו הדקות, או שהלקוח ביקש שלא יפנו אליו.404: הסוכן לא נמצא, או שאין לו שיחות יוצאות.409: כבר חויג למספר הזה לפני רגע.422: מחוץ לשעות הפעילות של הסוכן. התשובה כוללתnextOpenAt, המועד הבא שבו אפשר להתקשר.429: יותר מדי בקשות בדקה.
איך יודעים מה קרה בשיחה?
שמרו את ה-id שחזר. כשהשיחה מסתיימת נשלח האירוע voice.call_completed ל-Webhook שלכם, ואפשר גם לשלוף את השיחה, התמליל וההקלטה.