Une campagne fait référence à une fonctionnalité d'appel automatique sortant qui contacte séquentiellement une liste de contacts, lance des appels sortants et met chaque contact en relation avec un agent disponible. Les points de terminaison de campagne permettent d'accéder aux données associées aux campagnes, ce qui permet de récupérer des objets de campagne et de contact.
Objet de campagne : représente une seule campagne au sein de la plate-forme.
Objet de contact : représente les contacts individuels d'une campagne spécifique.
Consultez le modèle suivant pour déterminer les champs susceptibles de contenir des informations personnelles :
[
{
"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
}
}
]
Champ "État de la campagne"
Le champ status peut prendre l'une des valeurs suivantes :
| État de la campagne | Description |
|---|---|
| créé | Une campagne est créée, mais n'a pas encore commencé à passer des appels sortants. |
| (lancé) | Une campagne a commencé à passer des appels sortants, mais n'a pas encore commencé à composer le numéro (conversation). |
| Appel… | Une campagne passe des appels sortants. |
| pause | Une campagne a été mise en veille par un agent ou un responsable. |
| terminés | Une campagne a effectué tous ses appels. |
Champ "Mode de la campagne"
Le champ mode peut prendre l'une des valeurs suivantes :
| Mode de la campagne | Description |
|---|---|
| bêta | Pour une campagne bêta, un agent se connecte à un utilisateur final ou choisit l'action à effectuer pour un contact donné. Dans une campagne bêta, le contact ou l'utilisateur final est connu. |
| prédictif | Pour une campagne prédictive, un agent est mis en relation avec un appel de réservation. Nous activons la détection automatique pour cet appel, ce qui nous indique si la réponse à un appel sortant provient d'une personne ou d'une machine (par exemple, une messagerie vocale), et ne mettons l'agent en relation qu'avec une personne. |
| progressiste | Pour une campagne progressive, le composeur se connecte d'abord au premier agent disponible. Une fois la connexion établie, le composeur appelle et met en relation l'agent avec le premier contact disponible (un contact qui n'a pas encore été appelé pour une campagne donnée). |
Champ "Type de campagne"
Le champ campaign_type peut prendre l'une des valeurs suivantes :
| Type de campagne | Description |
|---|---|
| par défaut | Les contacts de la campagne proviennent de fichiers CSV importés par l'utilisateur. |
| external_list | Les contacts de la campagne proviennent de services externes ou tiers. |
Liste des campagnes
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Autres exemples de requêtes/réponses :
Exemple de requête : Liste des campagnes
Requête : Aucune
Corps : Aucun
Exemple de réponse : Liste des campagnes
[
{
"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
}
}
]
Code d'état : 200
Pour une seule campagne
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Autres exemples de requêtes/réponses :
Exemple de requête : Pour une seule campagne
Requête :
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| campaign_id | TRUE | Integer | ID de la campagne que vous souhaitez récupérer |
Corps : Aucun
Exemple de réponse : Pour une seule campagne
{
"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
}
}
Code d'état : 200
Liste de contacts
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| campaign_id | TRUE | Integer | ID de la campagne pour laquelle vous souhaitez obtenir les contacts |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Autres exemples de requêtes/réponses :
Exemple de requête : Liste de contacts
Requête :
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| campaign_id | TRUE | Integer | ID de la campagne pour laquelle vous souhaitez obtenir les contacts |
Corps : Aucun
Exemple de réponse : Liste de contacts
[
{
"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"
}
]
Code d'état : 200