Una campaña hace referencia a una función de marcado automático saliente que se comunica de forma secuencial con una lista de contactos, inicia llamadas salientes y conecta cada contacto con un agente disponible. Los extremos de la campaña proporcionan acceso a los datos relacionados con la campaña, lo que permite recuperar objetos de campaña y de contacto.
Objeto Campaign: Representa una sola campaña dentro de la plataforma.
Objeto de contacto: Representa los contactos individuales de la campaña dentro de una campaña específica.
Consulta el siguiente modelo para determinar qué campos podrían contener PII:
[
{
"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
}
}
]
Campo de estado de la campaña
El campo status puede tener cualquiera de los siguientes estados:
| Estado de la campaña | Descripción |
|---|---|
| creada | Se creó una campaña, pero aún no comenzó a realizar llamadas salientes. |
| comenzó | Una campaña que comenzó a realizar llamadas salientes no comenzó a marcar (conversación). |
| Llamando | Una campaña está marcando llamadas salientes. |
| pausar | Un agente o administrador detuvo una campaña. |
| finalizada | Se completaron todas las llamadas de una campaña. |
Campo de modo de campaña
El campo mode puede tener cualquiera de los siguientes valores:
| Modo Campaña | Descripción |
|---|---|
| vista previa | En una campaña de vista previa, un agente se conecta con un usuario final o elige qué acción tomar para un contacto determinado. En una campaña de vista previa, se conoce el contacto o el usuario final. |
| predictivo | En una campaña predictiva, se conecta a un agente con una llamada de reserva. Activamos la detección automática para esa llamada, lo que nos indica si la respuesta a una llamada saliente proviene de una persona o de una máquina (por ejemplo, un correo de voz), y solo conectamos al agente con una persona. |
| progresista/progresivo | En el caso de la campaña progresiva, el marcador primero se conectaría con el primer agente disponible. Una vez que se establece la conexión, el marcador llamará y entregará al agente el primer contacto disponible (un contacto al que aún no se llamó para una campaña determinada). |
Campo de tipo de campaña
El campo campaign_type puede tener cualquiera de los siguientes valores:
| Tipo de campaña | Descripción |
|---|---|
| predeterminado | Los contactos de la campaña provienen de archivos CSV subidos por el usuario. |
| external_list | Los contactos de la campaña provienen de servicios externos o de terceros. |
Lista de campañas
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Más ejemplos de solicitudes y respuestas:
Ejemplo de solicitud: Lista de campañas
Consulta: Ninguna
Cuerpo: Ninguno
Ejemplo de respuesta: Lista de campañas
[
{
"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
}
}
]
Código de estado: 200
Campaña única
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Más ejemplos de solicitudes y respuestas:
Solicitud de ejemplo: Una sola campaña
Consulta:
| Parámetro | Obligatorio | Tipo de datos | Definición |
|---|---|---|---|
| campaign_id | TRUE | Número entero | ID de la campaña que deseas recuperar |
Cuerpo: Ninguno
Ejemplo de respuesta: Una sola campaña
{
"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
}
}
Código de estado: 200
Lista de contactos
| Parámetro | Obligatorio | Tipo de datos | Definición |
|---|---|---|---|
| campaign_id | TRUE | Número entero | Es el ID de la campaña para la que deseas obtener los contactos. |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Más ejemplos de solicitudes y respuestas:
Ejemplo de solicitud: Lista de contactos
Consulta:
| Parámetro | Obligatorio | Tipo de datos | Definición |
|---|---|---|---|
| campaign_id | TRUE | Número entero | Es el ID de la campaña para la que deseas obtener los contactos. |
Cuerpo: Ninguno
Respuesta de ejemplo: Lista de contactos
[
{
"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"
}
]
Código de estado: 200