נקודות קצה של קמפיינים

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

  • אובייקט Campaign מייצג קמפיין יחיד בפלטפורמה.

  • אובייקט Contact מייצג איש קשר ספציפי בקמפיין מסוים.

נקודות הקצה של הקמפיינים מאפשרות למשתמשים להוסיף, לעדכן ולמחוק אנשי קשר של קמפיין קיים. נקודות הקצה הזמינות כוללות:

סטטוס איש הקשר בקמפיין

השדה 'סטטוס' יכול להיות באחד מהמצבים הבאים:

סטטוס איש הקשר בקמפיין תיאור
בקרוב איש הקשר הבא לחיוג.
חיוג מתבצעת כרגע חיוג לאיש הקשר.
בהמתנה השיחה לאיש קשר מסוים ממתינה בתור.
מחובר השיחה מועברת לנציג.
סיימתי השיחה הסתיימה.
הועבר השיחה הועברה.
הועברה והסתיימה השיחה הועברה ואז הסתיימה.
לא נאסף לא התקבל מענה ממשתמש הקצה או שלא הייתה אפשרות להגיע למשתמש הקצה.
לא הצלחנו ליצור קשר השיחה לא הגיעה לאיש הקשר.
ננטש על ידי איש הקשר בתצוגה מקדימה, משתמש הקצה מנתק את השיחה לפני שהיא מתחברת לנציג. בשיחות פרוגרסיביות וגם בשיחות חיזויות, משתמש הקצה מנתק את השיחה תוך 5 שניות אחרי החיבור לסוכן.
דילגת על הפעולה השיחה עם הלקוח נפסקה על ידי הנציג והיא תהיה זמינה לחיבור עם נציג אחר.
דילוג וסגירה בתצוגה המקדימה, הסוכן מדלג על איש קשר וסוגר אותו. איש הקשר הזה לא ייכלל יותר בקמפיין הזה.
מספר לא תקין איש קשר עם מספר טלפון לא תקין.
שגיאה של חברת התובלה השגיאה הזו נובעת מהספק.
ננטש על ידי החייגן השיחה עם איש הקשר ננטשה על ידי מערכת החיוג.
השיחה לדואר הקולי הסתיימה במצב 'חזוי', החייגן קובע שמשתמש הקצה הוא מכונה (כלומר, תא קולי).
שגיאה כללית בחייגן השיחה נכשלה בגלל שגיאה בחייגן.
חיוג חוזר מתוזמן סטטוס זמני. החיוג החוזר מתוזמן לעתיד.
Do Not Call המספר היה ברשימת המספרים שאסור להתקשר אליהם.
מספר יוצא לא תקין איש קשר עם מספר יוצא לא תקין.
מספר טלפון חסום איש קשר עם מספר בינלאומי לא תקין או חסום.

הוספה של איש קשר יחיד לקמפיין

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

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contacts

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "name": "string",
    "email": "customer@somedomain.com",
    "phone_number": "+1 111-111-1111",
    "outbound_number": "+1 760-867-5309",
    "external_unique_id": "UID_123456"
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

הוספה של איש קשר יחיד לקמפיין

בדוגמה הזו מוסבר איך להוסיף איש קשר למזהה קמפיין ספציפי.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id מספר שלם המזהה של הקמפיין שאליו רוצים להוסיף את איש הקשר

Body:

{
    "name": "string",
    "email": "customer@somedomain.com",
    "phone_number": "+1 111-111-1111",
    "outbound_number": "+1 760-867-5309",
    "external_unique_id": "UID_123456"
}
תשובה
{
    "valid_contacts": [
        {
            "name": "string",
            "email": "customer@somedomain.com",
            "phone_number": "+1 111-111-1111",
            "outbound_number": "+1 760-867-5309",
            "external_unique_id": "UID_123456"
        }
    ],
    "invalid_contacts": []
}

קוד הסטטוס: 200

קבלת אנשי קשר לקמפיין

פרמטר חובה סוג הנתונים הגדרה
campaign_id TRUE מספר שלם המזהה של הקמפיין שממנו רוצים לאחזר את אנשי הקשר.

נקודת קצה (endpoint):

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contacts

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id מספר שלם המזהה של הקמפיין שאליו רוצים להוסיף את איש הקשר

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

קבלת אנשי קשר לקמפיין

בדוגמה הבאה אפשר לראות איך מאחזרים את אנשי הקשר של מזהה הקמפיין שצוין.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id מספר שלם מזהה הקמפיין של הקמפיין שאליו רוצים לשלוח שאילתה
תשובה
[
  {
      "name": "string",
      "email": "customer@somedomain.com",
      "phone_number": "+1 111-111-1111",
      "outbound_number": "+1 760-867-5309",
      "external_unique_id": "UID_123456"
  }
]

קוד הסטטוס: 200

ייבוא של כמה אנשי קשר לקמפיין

פרמטר חובה סוג הנתונים הגדרה
קובץ TRUE String קובץ json שמכיל את אנשי הקשר שרוצים להוסיף לקמפיין.
campaign_id TRUE מספר שלם המזהה של הקמפיין שאליו רוצים להוסיף את אנשי הקשר.

נקודת קצה (endpoint):

Method: POST
Type: FORM DATA
URL: https://{​subdomain}​.{​domain}​/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contacts/import

כותרות:

מפתח ערך תיאור
סוג התוכן multipart/form-data

Body:

'FORM DATA'

תוכן הקובץ:

[
  {
      "name": "string",
      "email": "customer@somedomain.com",
      "phone_number": "+1 111-111-1111",
      "outbound_number": "+1 760-867-5309",
      "external_unique_id": "UID_123456"
  }
]

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

ייבוא של כמה אנשי קשר מקובץ

בדוגמה הזו מוצג איך מוסיפים אנשי קשר לקמפיין על סמך קובץ שנשלח לנקודת הקצה. הקובץ מתפרסם כנתוני טופס.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן multipart/form-data

שאילתה:

מפתח ערך תיאור
campaign_id מספר שלם מזהה הקמפיין שאליו רוצים להוסיף את אנשי הקשר

תוכן הקובץ:

[
  {
      "name": "string",
      "email": "customer@somedomain.com",
      "phone_number": "+1 111-111-1111",
      "outbound_number": "+1 760-867-5309",
      "external_unique_id": "UID_123456"
  }
]
תשובה

None

קוד סטטוס: 202 (Accepted)

תעסוקה

פרמטר חובה סוג הנתונים הגדרה
job_id TRUE מספר שלם מזהה המשימה שרוצים לאחזר
campaign_id TRUE מספר שלם מזהה הקמפיין שאליו משויך מזהה המשרה.

נקודת קצה (endpoint):

Method: GET
Type:
URL: https://{​{subdomain}​}.{​{domain}​}/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contacts/jobs/{job_id}

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

המשימה הושלמה

בדוגמה הבאה אפשר לראות איך מאחזרים את העבודה ומזהים אם היא הושלמה בהצלחה.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id 1 מזהה הקמפיין שאליו שייכת המשימה
job_id 530 מזהה המשימה שרוצים לבדוק את הסטטוס שלה
תשובה
{
    "id": 530,
    "status": "completed",
    "type": "Jobs::Bulk::Campaign::ParentJob"
}

קוד הסטטוס: 200

הייבוא עדיין מתבצע

בדוגמה הבאה אפשר לראות איך מאחזרים את העבודה ומזהים אם הייבוא עדיין מתבצע.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id 1 מזהה הקמפיין שאליו שייכת המשימה
job_id 530 מזהה המשימה שרוצים לבדוק את הסטטוס שלה
תשובה
{
    "id": 530,
    "status": "in_progress",
    "type": "Jobs::Bulk::Campaign::ParentJob"
}

קוד הסטטוס: 200

משימה שנכשלה

בדוגמה הבאה אפשר לראות איך מאחזרים את העבודה ומזהים אם העבודה נכשלה.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

שאילתה:

מפתח ערך תיאור
campaign_id 1 מזהה הקמפיין שאליו שייכת המשימה
job_id 523 מזהה המשימה שרוצים לבדוק את הסטטוס שלה
תשובה
{
    "error_details": "NativePowerDial::ContactService::DuplicateContactPhoneOnCampaign",
    "error_message": "Internal Error",
    "id": 523,
    "status": "failed",
    "type": "Jobs::Bulk::Campaign::StartImport"
}

קוד הסטטוס: 200

עדכון של איש קשר יחיד

פרמטר חובה סוג הנתונים הגדרה
campaign_id TRUE מספר שלם מזהה הקמפיין שאליו משויך מזהה המשרה.

נקודת קצה (endpoint):

Method: PATCH
Type: RAW
URL: https://{​{subdomain}​}.{​{domain}​}/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contact

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "contact_id": 16312,
    "name": "string",
    "email": "customer@somedomain.com",
    "phone_number": "+1 111-111-1111",
    "external_unique_id": "UID_123456"
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

עדכון של איש קשר בקמפיין

בדוגמה הזו מוסבר איך לעדכן איש קשר שנמצא בקמפיין ספציפי.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "contact_id": 7,
    "name": "Bob Smith",
    "email": "customer@somedomain.com",
    "phone_number": "+1 111-111-1111",
    "external_unique_id": "UID_123456"
}
תשובה
{
    "id": 7,
    "name": "Bob Smith",
    "campaign_id": 6,
    "assigned_call_id": null,
    "assigned_participant_id": null,
    "outbound_number": "+1-(201)-471-6992",
    "priority": null,
    "created_at": "2024-08-05T14:51:49.000Z",
    "updated_at": "2024-08-05T21:01:16.000Z",
    "status": "Upcoming",
    "user_custom_metadata": {
        "NAME (REQUIRED)": "Bob Smith",
        "PHONE (REQUIRED)": "+1 111-111-1111",
        "EMAIL (REQUIRED)": "customer@somedomain.com"
    }
}

קוד הסטטוס: 200

הסרה של איש קשר בודד

פרמטר חובה סוג הנתונים הגדרה
campaign_id TRUE מספר שלם מזהה הקמפיין שאליו משויך מזהה המשרה.

נקודת קצה (endpoint):

Method: DELETE
Type: RAW
URL: https://{​{subdomain}​}.{​{domain}​}/apps/api/v1/outbound_dialer/campaigns/{campaign_id}/contact

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "contact_id": integer,
    "phone_number": "string",
    "external_unique_id": "string"
}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

הסרה של איש קשר באמצעות מזהה איש הקשר

בדוגמה הזו מוסבר איך להסיר איש קשר מקמפיין על סמך מזהה איש הקשר.

בקשה

כותרות:

מפתח ערך תיאור
סוג התוכן application/json

Body:

{
    "contact_id": 7,
}

שאילתה:

מפתח ערך תיאור
campaign_id 1 מזהה הקמפיין שאליו שייכת המשימה
תשובה
{
    "id": 7,
    "name": "Bob Smith",
    "campaign_id": 6,
    "assigned_call_id": null,
    "assigned_participant_id": null,
    "outbound_number": "+1-(201)-471-6992",
    "priority": null,
    "created_at": "2024-08-05T14:51:49.000Z",
    "updated_at": "2024-08-05T21:01:16.000Z",
    "status": "Upcoming",
    "user_custom_metadata": {
        "NAME (REQUIRED)": "Bob Smith",
        "PHONE (REQUIRED)": "+1 111-111-1111",
        "EMAIL (REQUIRED)": "customer@somedomain.com"
    }
}

קוד הסטטוס: 200