> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Obter uma campanha de chamadas ativas

GET https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/{campaign_id}

Obtenha uma campanha ativa e suas contagens de leads.

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/campaigns/get

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Path parameters

- `campaign_id` (string, required)

## Response

### 200

Resposta bem-sucedida

- `campaign_id` (string, required)
- `call_name` (string, required) — O nome da campanha.
- `agent_id` (string, required)
- `channel_config` (CampaignResponseChannelConfig, required)
- `status` (enum, required) — `attention` significa que um item de atenção em aberto retém algumas chamadas da campanha enquanto as demais prosseguem. `stopping` significa que as chamadas na fila são canceladas e as chamadas já realizadas estão sendo concluídas.
  - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention`
- `policy` (CampaignPolicySnapshot, required) — A política usada pela campanha quando foi criada.
- `variant` (enum, required)
  - Allowed values: `simple`, `advanced`
- `created_at_unix` (integer, required)
- `updated_at_unix` (integer, required)
- `channel` (enum, required)
  - Allowed values: `phone`, `whatsapp`
- `mode` (enum, required)
  - Allowed values: `voice`, `message`
- `counts` (CampaignSummaryCounts, required)
- `agent_name` (string, required, default: )
- `source` (enum, optional) — Se a campanha foi criada no app ou pela API.
  - Allowed values: `ui`, `api`
- `outcome` (CampaignResponseOutcome, optional) — O resultado considerado bem-sucedido para as chamadas da campanha.
- `scheduled_time_unix` (integer, optional) — Quando a campanha começa a fazer chamadas; deixe sem definir para iniciar assim que for criada.
- `branch_id` (string, optional) — A ramificação do agente usada pela campanha para chamar.
- `environment` (string, optional) — O ambiente no qual as variáveis de ambiente do agente são resolvidas.
- `target_concurrency_limit` (integer, optional) — O número máximo de chamadas que a campanha realiza ao mesmo tempo.

## Errors

### 422 Outbound Campaigns Get Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### CampaignResponseChannelConfig

- `channel`: `phone`
  - `agent_phone_number_id` (string, required) — O número de telefone usado para realizar a chamada.
  - `mode_config` (PhoneVoiceConfigOutput, optional)
- `channel`: `whatsapp`
  - `mode_config` (WhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — O número de telefone do WhatsApp usado para fazer chamadas ou enviar mensagens.

### CampaignPolicySnapshot

A política usada pela campanha quando foi criada, estruturada como uma `policy` enviada.

- `timezone` (string, required)
- `retry` (RetryPolicy, required)
- `calling_periods` (list of CallingPeriodPolicy, required)
- `data_collection` (DataCollectionPolicy, required)
- `followup_context` (FollowupContextPolicy, required) — Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

### CampaignSummaryCounts

- `leads` (integer, required)
- `terminal_leads` (integer, required) — Leads que não receberão mais chamadas.
- `open_attention` (integer, required) — Itens de atenção ainda não resolvidos.
- `delivery` (RecipientDeliveryCounts, optional) — Quantidade de mensagens que chegou a cada estágio; definido ao obter uma campanha de mensagens.

### CampaignResponseOutcome

- `type`: `data_collection`
  - `data_collection_id` (string, required) — O item de coleta de dados do agente que uma chamada bem-sucedida define.
  - `equals` (list of DataCollectionOutcomeEqualsItem, required) — Valores considerados bem-sucedidos, todos do tipo do item.
- `type`: `evaluation_criteria`
  - `criteria_id` (string, required) — O critério de avaliação do agente atendido por uma chamada bem-sucedida.

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### PhoneVoiceConfigOutput

- `ringing_timeout_secs` (integer, optional, default: 60) — Por quantos segundos o destinatário deve tocar antes de desistir. Isso também estará sujeito às limitações do próprio provedor.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Se deve gravar a chamada usando a gravação de chamadas da Twilio. Ignorado para provedores que não são da Twilio. As gravações são armazenadas na sua conta Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional) — Configuração da detecção de secretária eletrônica (AMD) no nível da operadora da Twilio. Omita ou defina como null para desativá-la. Ignorada para provedores que não são Twilio e para chamadas recebidas. O resultado é entregue como seu próprio evento de webhook `answering_machine_detection`, que exige que esse evento esteja ativado nas configurações de webhook do espaço de trabalho ou do agente; ele não faz parte da conversa nem do webhook pós-chamada. A detecção é executada de forma assíncrona, portanto nunca atrasa o início da conversa, e o resultado pode chegar em qualquer momento durante a chamada -- com `detect_message_end`, até mesmo após seu encerramento. A Twilio cobra separadamente pelo AMD.
- `mode` ("voice", optional)

### WhatsAppChannelConfigModeConfig

- `mode`: `message`
  - `template` (WhatsAppTemplate, required) — O modelo da Meta conforme foi aprovado no envio.
- `mode`: `voice`
  - `whatsapp_call_permission_request_template_language_code` (string, required) — O código de idioma desse modelo.
  - `whatsapp_call_permission_request_template_name` (string, required) — O modelo aprovado que pede permissão ao contato para ligar.

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Quanto tempo aguardar antes de uma nova tentativa curta.
- `max_short_retries` (integer, optional, default: 1) — Novas tentativas permitidas por uma janela de chamada após uma chamada com falha. Quando esgotadas, a próxima tentativa aguarda a janela seguinte, que começa do zero.
- `max_total_calls` (integer, optional, default: 6) — O número máximo de chamadas que um lead recebe, incluindo a primeira.
- `max_callbacks` (integer, optional, default: 2) — O número máximo de retornos de chamada a atender para um número.
- `max_redirects` (integer, optional, default: 2) — O número máximo de vezes que um lead atende a uma solicitação para ligar para outro número.
- `interval_placement` (enum, optional, default: start) — Em que ponto de uma janela de chamadas posterior uma chamada adiada será realizada: no `start`, em um horário `random` ou com `rotate` de `rotate_step_seconds` após o ponto em que a última chamada nessa janela falhou.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Quanto o posicionamento `rotate` desloca cada chamada. Usado somente por `rotate`.
- `max_consecutive_failures_per_number` (integer, optional) — Quantidade de chamadas consecutivas para um número que podem falhar antes de o lead passar para o próximo número listado ou encerrar, caso não haja outro. Uma chamada atendida ou um redirecionamento para um novo número reinicia a contagem. Se não for definido, apenas `max_total_calls` será aplicado.

### CallingPeriodPolicy

- `weekdays` (list of integer, required)
- `intervals` (list of CallingIntervalPolicy, required) — Janelas em cada um desses dias. Elas não podem se sobrepor em nenhum dia.

### DataCollectionPolicy

- `callback_time` (string, optional)
- `redirect_phone_number` (string, optional)
- `stop` (string, optional)
- `mappings` (map from string to string, optional) — Copia os resultados da coleta de dados para variáveis dinâmicas usadas em chamadas posteriores: cada chave é um ID de item de coleta de dados e seu valor é o nome da variável.

### FollowupContextPolicy

Quais variáveis dinâmicas `campaign__` as chamadas de acompanhamento recebem.

- `call_type` (boolean, optional, default: true) — Passe o tipo de chamada como `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Passe o ID da última conversa como `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Passe o resumo da última conversa como `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Passe a transcrição da última conversa como `campaign__previous_transcript`.

### RecipientDeliveryCounts

- `sent` (integer, optional, default: 0)
- `delivered` (integer, optional, default: 0)
- `read` (integer, optional, default: 0)
- `replied` (integer, optional, default: 0)
- `failed` (integer, optional, default: 0)

### DataCollectionOutcomeEqualsItem

- string
- integer
- double
- boolean

### ValidationErrorLocItem

- string
- integer

### TwilioMachineDetectionConfig

Como executar a detecção de secretária eletrônica (AMD) no nível da operadora do Twilio em uma chamada.

- `mode` (enum, optional, default: enable) — O quão completa deve ser a detecção. `enable` retorna um veredito assim que o Twilio consegue distinguir uma pessoa de uma máquina. `detect_message_end` também aguarda o fim da saudação da caixa postal, o que gera os vereditos `machine_end_*`, mas retorna um resultado mais tarde.
  - Allowed values: `enable`, `detect_message_end`
- `actions` (list of TwilioMachineDetectionRule, optional) — Ações a realizar na chamada para cada veredito AMD. Cada ação pode aparecer em no máximo uma regra, portanto liste todos os vereditos correspondentes juntos. Vereditos sem uma regra mantêm a chamada em andamento.

### WhatsAppTemplate

- `name` (string, required)
- `language` (string, required) — https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages
- `components` (list of WhatsAppTemplateComponent, required)
- `parameter_format` (enum, optional, default: POSITIONAL)
  - Allowed values: `POSITIONAL`, `NAMED`
- `category` (string, optional) — https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/

### CallingIntervalPolicy

- `start` (string, required) — Horário local de início, como `HH:MM`.
- `end` (string, required) — Horário local de término, como `HH:MM`; `24:00` termina à meia-noite.

### TwilioMachineDetectionRule

Ação a realizar em uma chamada em andamento para os vereditos AMD especificados.

- `action` ("hang_up", required)
- `answered_by` (list of enum, required) — Vereditos que acionam a ação.
  - Allowed values: `human`, `fax`, `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`

### WhatsAppTemplateComponent

- `type` (string, required)
- `format` (string, optional)
- `text` (string, optional)
- `buttons` (list of WhatsAppTemplateComponentButton, optional)

### WhatsAppTemplateComponentButton

- `type` (string, required)
- `text` (string, optional)
- `url` (string, optional)

## Examples

**Response**

```json
{
  "campaign_id": "campaign_id",
  "call_name": "call_name",
  "agent_id": "agent_id",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "agent_phone_number_id",
    "mode_config": {
      "ringing_timeout_secs": 1,
      "twilio_call_recording_enabled": true,
      "mode": "voice"
    }
  },
  "status": "active",
  "policy": {
    "timezone": "timezone",
    "retry": {
      "retry_delay_seconds": 1,
      "max_short_retries": 1,
      "max_total_calls": 1,
      "max_callbacks": 1,
      "max_redirects": 1,
      "interval_placement": "start",
      "rotate_step_seconds": 1,
      "max_consecutive_failures_per_number": 1
    },
    "calling_periods": [
      {
        "weekdays": [
          1
        ],
        "intervals": [
          {
            "start": "start",
            "end": "end"
          }
        ]
      }
    ],
    "data_collection": {
      "callback_time": "callback_time",
      "redirect_phone_number": "redirect_phone_number",
      "stop": "stop",
      "mappings": {
        "key": "value"
      }
    },
    "followup_context": {
      "call_type": true,
      "previous_conversation_id": true,
      "previous_summary": true,
      "previous_transcript": true
    }
  },
  "variant": "simple",
  "created_at_unix": 1,
  "updated_at_unix": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 1,
      "delivered": 1,
      "read": 1,
      "replied": 1,
      "failed": 1
    }
  },
  "agent_name": "agent_name",
  "source": "ui",
  "outcome": {
    "type": "data_collection",
    "data_collection_id": "data_collection_id",
    "equals": [
      "equals"
    ]
  },
  "scheduled_time_unix": 1,
  "branch_id": "branch_id",
  "environment": "environment",
  "target_concurrency_limit": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```