Uma campanha se refere a um recurso de discador automático de saída que entra em contato sequencialmente com uma lista de contatos, inicia chamadas de saída e conecta cada contato a um agente disponível. Os endpoints de campanha fornecem acesso a dados relacionados a campanhas, permitindo a recuperação de objetos de campanha e contato.
Objeto de campanha: representa uma única campanha na plataforma.
Objeto de contato: representa contatos individuais de uma campanha específica.
Consulte o modelo a seguir para determinar quais campos podem conter 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 status da campanha
O campo status pode estar em um dos seguintes estados:
| Status da campanha | Descrição |
|---|---|
| created | Uma campanha é criada, mas ainda não começou a fazer chamadas externas. |
| iniciada | Uma campanha começou a fazer chamadas de saída, mas não iniciou a discagem (conversa). |
| discando | Uma campanha está fazendo ligações. |
| pause | Uma campanha foi pausada por um agente ou gerente. |
| concluídas | Uma campanha concluiu todas as chamadas. |
Campo "Modo da campanha"
O campo mode pode ter qualquer um dos seguintes valores:
| Modo de campanha | Descrição |
|---|---|
| visualização | Em uma campanha de prévia, um agente se conecta a um usuário final ou escolhe qual ação tomar para um determinado contato. Em uma campanha de prévia, o contato ou usuário final é conhecido. |
| preditivo | Em uma campanha preditiva, um agente é conectado a uma chamada de reserva. Ativamos a detecção de máquina para essa chamada, que nos informa se a resposta a uma chamada externa é de um humano ou de uma máquina (por exemplo, uma caixa postal de voz), conectando o agente apenas a um humano. |
| progressista | Na campanha progressiva, o discador se conecta primeiro ao primeiro agente disponível. Ao se conectar, o discador ligaria e entregaria ao agente o primeiro contato disponível (um contato que ainda não foi chamado em uma determinada campanha). |
Campo "Tipo de campanha"
O campo campaign_type pode ter qualquer um dos seguintes valores:
| Tipo de campanha | Descrição |
|---|---|
| padrão | Os contatos da campanha são de arquivos CSV enviados pelo usuário. |
| external_list | Os contatos da campanha são de serviços externos ou de terceiros. |
Lista de campanhas
Endpoint
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Mais exemplos de solicitações/respostas:
Exemplo de solicitação: lista de campanhas
Consulta: nenhuma
Corpo: nenhum
Exemplo de resposta: lista de campanhas
[
{
"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 status:200
Uma campanha
Endpoint
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Mais exemplos de solicitações/respostas:
Exemplo de solicitação: campanha única
Consulta:
| Parâmetro | Obrigatório | Tipo de dados | Definição |
|---|---|---|---|
| campaign_id | TRUE | Número inteiro | O ID da campanha que você quer recuperar |
Corpo: nenhum
Exemplo de resposta: campanha única
{
"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 status:200
Lista de contatos
| Parâmetro | Obrigatório | Tipo de dados | Definição |
|---|---|---|---|
| campaign_id | TRUE | Número inteiro | O ID da campanha para a qual você quer receber os contatos |
Endpoint
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Mais exemplos de solicitações/respostas:
Exemplo de solicitação: lista de contatos
Consulta:
| Parâmetro | Obrigatório | Tipo de dados | Definição |
|---|---|---|---|
| campaign_id | TRUE | Número inteiro | O ID da campanha para a qual você quer receber os contatos |
Corpo: nenhum
Exemplo de resposta: lista de contatos
[
{
"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 status:200