Eine Kampagne bezieht sich auf eine Funktion für automatische ausgehende Anrufe, mit der eine Liste von Kontakten nacheinander erreicht wird. Es werden ausgehende Anrufe initiiert und jeder Kontakt wird mit einem verfügbaren Agenten verbunden. Über Kampagnenendpunkte kann auf kampagnenbezogene Daten zugegriffen werden. So können Kampagnen- und Kontaktobjekte abgerufen werden.
Kampagnenobjekt: stellt eine einzelne Kampagne auf der Plattform dar
Kontaktobjekt: stellt einzelne Kampagnenkontakte in einer bestimmten Kampagne dar
Im folgenden Modell sehen Sie, welche Felder personenbezogene Daten enthalten können:
[
{
"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
}
}
]
Feld „Kampagnenstatus“
Das Feld status kann einen der folgenden Status haben:
| Kampagnenstatus | Beschreibung |
|---|---|
| erstellt | Eine Kampagne wurde erstellt, aber es wurden noch keine ausgehenden Anrufe getätigt. |
| begonnen | Eine Kampagne hat mit ausgehenden Anrufen begonnen, aber es wurde noch keine Verbindung hergestellt (Unterhaltung). |
| wird gewählt | Bei einer Kampagne werden ausgehende Anrufe getätigt. |
| Pausieren | Eine Kampagne wurde von einem Agenten oder Manager pausiert. |
| finished | Bei einer Kampagne wurden alle Anrufe getätigt. |
Feld „Kampagnenmodus“
Das Feld mode kann einen der folgenden Werte haben:
| Kampagnenmodus | Beschreibung |
|---|---|
| Vorschau | Bei einer Vorschaukampagne stellt ein Agent eine Verbindung zu einem Endnutzer her oder wählt eine Aktion für einen bestimmten Kontakt aus. Bei einer Vorschaukampagne ist der Kontakt oder Endnutzer bekannt. |
| vorhersagend | Bei einer vorhersagenden Kampagne wird ein Agent mit einem Reservierungsanruf verbunden. Wir aktivieren die Erkennung von Maschinen für diesen Anruf, um zu ermitteln, ob die Antwort auf einen ausgehenden Anruf von einer Person oder einer Maschine (z. B. einer Voicemail) stammt. Der Agent wird nur mit einer Person verbunden. |
| progressiv | Bei einer progressiven Kampagne stellt der Dialer zuerst eine Verbindung zum ersten verfügbaren Agenten her. Nach der Verbindung ruft der Dialer den ersten verfügbaren Kontakt an (einen Kontakt, der für eine bestimmte Kampagne noch nicht angerufen wurde) und stellt die Verbindung zum Agenten her. |
Feld „Kampagnentyp“
Das Feld campaign_type kann einen der folgenden Werte haben:
| Kampagnentyp | Beschreibung |
|---|---|
| Standard | Kampagnenkontakte stammen aus vom Nutzer hochgeladenen CSV-Dateien. |
| external_list | Kampagnenkontakte stammen aus externen Diensten oder Diensten von Drittanbietern. |
Kampagnenliste
Endpunkt:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Weitere Beispielanfragen und ‑antworten:
Beispielanfrage: Kampagnenliste
Suchanfrage: Keine
Text: Keine
Beispielantwort: Kampagnenliste
[
{
"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
}
}
]
Statuscode: 200
Einzelne Kampagne
Endpunkt:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Weitere Beispielanfragen und ‑antworten:
Beispielanfrage: Einzelne Kampagne
Suchanfrage:
| Parameter | Erforderlich | Datentyp | Definition |
|---|---|---|---|
| campaign_id | TRUE | Ganzzahl | Die ID der Kampagne, die Sie abrufen möchten |
Text: Keine
Beispielantwort: Einzelne Kampagne
{
"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
}
}
Statuscode: 200
Kontaktliste
| Parameter | Erforderlich | Datentyp | Definition |
|---|---|---|---|
| campaign_id | TRUE | Ganzzahl | Die ID der Kampagne, für die Sie die Kontakte abrufen möchten |
Endpunkt:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Weitere Beispielanfragen und ‑antworten:
Beispielanfrage: Kontaktliste
Suchanfrage:
| Parameter | Erforderlich | Datentyp | Definition |
|---|---|---|---|
| campaign_id | TRUE | Ganzzahl | Die ID der Kampagne, für die Sie die Kontakte abrufen möchten |
Text: Keine
Beispielantwort: Kontaktliste
[
{
"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"
}
]
Statuscode: 200