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

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

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

• אובייקט של איש קשר: מייצג אנשי קשר ספציפיים בקמפיין מסוים

כדי להבין אילו שדות עשויים להכיל פרטים אישיים מזהים, אפשר לעיין במודל הבא:

[
   {
      "campaign_type" : "default",
      "id" : 67,
      "external_campaign_id" : null,
      "max_abandonment_percent" : 3,
      "max_redial_count" : 3,
      "mode" : "preview",
      "name" : "string",
      "overdial_adjustment_multiplier" : 1,
      "queue" : {
         "deleted" : false,
         "hidden" : false,
         "id" : 60,
         "menu_type" : "ivr_menu",
         "name" : "string",
         "output_msg" : null,
         "parent_id" : 59,
         "position" : 4
      },
      "redial_interval_minutes" : 120,
      "status" : "dialing",
      "target_number_to_process" : 1000,
      "created_at" : "2023-04-01T23:23:43.000Z",
      "starts_at" : "2023-04-01T23:28:08.000Z",
      "ends_at" : null,
      "updated_at" : "2023-04-01T23:28:08.000Z",
      "contact_stats" : {
         "Abandoned by Contact" : 0,
         "Abandoned by Dialer" : 0,
         "Average Redials per Number" : 0,
         "Carrier Error" : 0,
         "Completed" : 50,
         "Connected" : 0,
         "Contacts" : 1000,
         "Dialer General Error" : 0,
         "Dialing" : 0,
         "Do Not Call" : 0,
         "Finished" : 40,
         "Invalid Number or Name" : 0,
         "Invalid outbound number" : 0,
         "Not Picked Up" : 0,
         "Not Reached to Contact" : 0,
         "Not reached" : 10,
         "Not yet reached" : 960,
         "Queued" : 0,
         "Reached" : 0,
         "Redial Scheduled" : 0,
         "Redials" : 0,
         "Remaining" : 950,
         "Running" : 0,
         "Skipped" : 0,
         "Skipped & Closed" : 10,
         "Transferred" : 0,
         "Transferred and Finished" : 0,
         "Upcoming" : 950,
         "Voicemail Hung Up" : 0
      }
   }
]

השדה 'סטטוס הקמפיין'

השדה status יכול להיות באחד מהמצבים הבאים:

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

שדה מצב הקמפיין

השדה mode יכול לקבל את הערכים הבאים:

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

השדה 'סוג הקמפיין'

השדה campaign_type יכול לקבל כל אחד מהערכים הבאים:

סוג הקמפיין	תיאור
ברירת מחדל	אנשי הקשר בקמפיין הם מקובצי CSV שהועלו על ידי משתמשים.
external_list	אנשי הקשר לקמפיין מגיעים משירותים חיצוניים או משירותים של צד שלישי.

רשימת קמפיינים

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

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

דוגמאות נוספות לבקשות ולתשובות:

בקשה לדוגמה: רשימת קמפיינים

שאילתה: אין

Body: None

דוגמה לתגובה: רשימת קמפיינים

[
    {
        "campaign_type": "default",
        "id": 67,
        "external_campaign_id": null,
        "max_abandonment_percent": 3,
        "max_redial_count": 3,
        "mode": "preview",
        "name": "string",
        "overdial_adjustment_multiplier": 1,
        "queue": {
            "deleted": false,
            "hidden": false,
            "id": 60,
            "menu_type": "ivr_menu",
            "name": "string",
            "output_msg": null,
            "parent_id": 59,
            "position": 4
        },
        "redial_interval_minutes": 120,
        "status": "dialing",
        "target_number_to_process": 1000,
        "created_at": "2023-04-01T23:23:43.000Z",
        "starts_at": "2023-04-01T23:28:08.000Z",
        "ends_at": null,
        "updated_at": "2023-04-01T23:28:08.000Z",
        "contact_stats": {
            "Abandoned by Contact": 0,
            "Abandoned by Dialer": 0,
            "Average Redials per Number": 0,
            "Carrier Error": 0,
            "Completed": 50,
            "Connected": 0,
            "Contacts": 1000,
            "Dialer General Error": 0,
            "Dialing": 0,
            "Do Not Call": 0,
            "Finished": 40,
            "Invalid Number or Name": 0,
            "Invalid outbound number": 0,
            "Not Picked Up": 0,
            "Not Reached to Contact": 0,
            "Not reached": 10,
            "Not yet reached": 960,
            "Queued": 0,
            "Reached": 0,
            "Redial Scheduled": 0,
            "Redials": 0,
            "Remaining": 950,
            "Running": 0,
            "Skipped": 0,
            "Skipped & Closed": 10,
            "Transferred": 0,
            "Transferred and Finished": 0,
            "Upcoming": 950,
            "Voicemail Hung Up": 0
        }
    }
]

קוד הסטטוס: 200

קמפיין יחיד

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

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

דוגמאות נוספות לבקשות ולתשובות:

בקשה לדוגמה: קמפיין יחיד

שאילתה:

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

Body: None

דוגמה לתגובה: קמפיין יחיד

{
    "campaign_type": "default",
    "id": 67,
    "external_campaign_id": null,
    "max_abandonment_percent": 3,
    "max_redial_count": 3,
    "mode": "preview",
    "name": "string",
    "overdial_adjustment_multiplier": 1,
    "queue": {
        "deleted": false,
        "hidden": false,
        "id": 60,
        "menu_type": "ivr_menu",
        "name": "string",
        "output_msg": null,
        "parent_id": 59,
        "position": 4
    },
    "redial_interval_minutes": 120,
    "status": "dialing",
    "target_number_to_process": 1000,
    "created_at": "2023-04-01T23:23:43.000Z",
    "starts_at": "2023-04-01T23:28:08.000Z",
    "ends_at": null,
    "updated_at": "2023-04-01T23:28:08.000Z",
    "contact_stats": {
        "Abandoned by Contact": 0,
        "Abandoned by Dialer": 0,
        "Average Redials per Number": 0,
        "Carrier Error": 0,
        "Completed": 50,
        "Connected": 0,
        "Contacts": 1000,
        "Dialer General Error": 0,
        "Dialing": 0,
        "Do Not Call": 0,
        "Finished": 40,
        "Invalid Number or Name": 0,
        "Invalid outbound number": 0,
        "Not Picked Up": 0,
        "Not Reached to Contact": 0,
        "Not reached": 10,
        "Not yet reached": 960,
        "Queued": 0,
        "Reached": 0,
        "Redial Scheduled": 0,
        "Redials": 0,
        "Remaining": 950,
        "Running": 0,
        "Skipped": 0,
        "Skipped & Closed": 10,
        "Transferred": 0,
        "Transferred and Finished": 0,
        "Upcoming": 950,
        "Voicemail Hung Up": 0
    }
}

קוד הסטטוס: 200

רשימת אנשי קשר

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

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

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

דוגמאות נוספות לבקשות ולתשובות:

בקשה לדוגמה: רשימת אנשי קשר

שאילתה:

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

Body: None

דוגמה לתגובה: רשימת אנשי קשר

[
    {
        "assigned_call_id": 32001,
        "assigned_participant_id": 54321,
        "campaign_id": 240,
        "created_at": "2023-04-01T17:15:38.000Z",
        "id": 16312,
        "name": "string",
        "outbound_number": null,
        "priority": null,
        "status": "Upcoming",
        "unique_id": "string",
        "updated_at": "2023-04-01T17:15:38.000Z"
    },
    {
        "assigned_call_id": 32002,
        "assigned_participant_id": 54330,
        "campaign_id": 240,
        "created_at": "2023-04-01T17:15:38.000Z",
        "id": 16313,
        "name": "string",
        "outbound_number": null,
        "priority": null,
        "status": "Upcoming",
        "unique_id": "string",
        "updated_at": "2023-04-01T17:15:38.000Z"
    }
]

קוד הסטטוס: 200