מרכז ידע English כניסה למערכת
נושאים

איך מפעילים שיחה מיידית דרך API

עודכן 5 באוקטובר 2026 דקת קריאה

בקשה אחת מפעילה שיחה יוצאת של הסוכן למספר אחד, מיד. לשליחת לידים רבים עדיף רשימת חיוג שמתמלאת דרך API.

  1. צרו מפתח API עם ההרשאה calls:place

    איך יוצרים ומנהלים מפתחות API.

  2. העתיקו את מזהה הסוכן

    המזהה מופיע בכתובת של עמוד הסוכן, אחרי agents/.

  3. שלחו בקשת 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"
  }'
שדות הבקשה
שדהתיאור
agentIdstringחובהמזהה הסוכן שיתקשר.
tostringחובהמספר הטלפון של הלקוח, רצוי בפורמט בינלאומי.
variablesobjectרשותערכים למשתנים שבתסריט, לפי שם המשתנה.
idempotencyKeystringרשותמזהה משלכם לבקשה. בקשה חוזרת עם אותו מזהה מחזירה את אותה שיחה ולא מחייגת שוב.
תשובה: 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 שלכם, ואפשר גם לשלוף את השיחה, התמליל וההקלטה.

מאמרים נוספים בנושא

    ↑↓ניווט Enterפתיחה Escסגירה מחפש במאמרים בעברית · English