> 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.

# Obtener la configuración de la campaña saliente

GET https://api.elevenlabs.io/v1/convai/outbound-campaigns/config

Obtiene la configuración de campañas salientes del espacio de trabajo: la política predeterminada que adoptan las nuevas campañas y las anulaciones por agente.

Reference: https://elevenlabs.io/docs/api-reference/campaigns/config/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)

## Response

### 200

Respuesta correcta.

- `version` (integer, required) — Aumenta con cada sustitución; envíala como `expected_version`.
- `config` (CampaignConfig-Output, required)

## Errors

### 422 Unprocessable Entity Error

Error de validación

- `detail` (list of ValidationError, optional)

## Types

### CampaignConfig-Output

- `policy` (PolicyConfig-Output, optional) — La política que adoptan las campañas, salvo que establezcan la suya propia.
- `agent_policies` (map from string to AgentPolicyOverride-Output, optional) — Anulaciones de `policy`, indexadas por ID de agente.
- `whatsapp_voice_policy` (AgentPolicyOverride-Output, optional, nullable) — Anulaciones para campañas de voz de WhatsApp, aplicadas entre la política del espacio de trabajo y las anulaciones de un agente. Las secciones omitidas siguen los valores predeterminados integrados de voz de WhatsApp.

### ValidationError

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

### PolicyConfig-Output

- `timezone` (string, optional, default: UTC) — Zona horaria IANA en la que se interpretan los períodos de llamada.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — Las franjas horarias semanales en las que se pueden realizar llamadas.
- `data_collection` (DataCollectionConfig, optional) — Los elementos de recopilación de datos del agente que guían las llamadas de seguimiento. Cada uno usa de forma predeterminada el elemento integrado para su propósito; `null` lo desactiva.
- `followup_context` (FollowupContextPolicy, optional) — Qué variables dinámicas `campaign__` reciben las llamadas de seguimiento.

### AgentPolicyOverride-Output

Cada sección configurada aquí sustituye toda la sección correspondiente de la política.

- `timezone` (string, optional, nullable)
- `retry` (RetryPolicy, optional, nullable)
- `calling_periods` (list of CallingPeriod, optional, nullable)
- `data_collection` (DataCollectionConfig, optional, nullable) — Los elementos de recopilación de datos del agente que guían las llamadas de seguimiento. Cada uno usa de forma predeterminada el elemento integrado para su propósito; `null` lo desactiva.
- `followup_context` (FollowupContextPolicy, optional, nullable) — Qué variables dinámicas `campaign__` reciben las llamadas de seguimiento.

### ValidationErrorLocItems

- string
- integer

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Cuánto esperar antes de un reintento breve.
- `max_short_retries` (integer, optional, default: 1) — Reintentos que permite una franja de llamada tras una llamada fallida. Cuando se agotan, el siguiente reintento espera a la siguiente franja, que comienza de nuevo.
- `max_total_calls` (integer, optional, default: 6) — El número máximo de llamadas que recibe un contacto, incluida la primera.
- `max_callbacks` (integer, optional, default: 2) — El número máximo de devoluciones de llamada que se atenderán para un número.
- `max_redirects` (integer, optional, default: 2) — El número máximo de veces que un contacto sigue una solicitud para llamar a otro número.
- `interval_placement` (enum, optional, default: start) — En qué punto de una franja horaria posterior se realizará una llamada aplazada: en su `start`, en un momento `random` o con `rotate`, `rotate_step_seconds` después de donde falló la última llamada en esa franja.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Cuánto desplaza cada llamada la asignación `rotate`. Solo se usa con `rotate`.
- `max_consecutive_failures_per_number` (integer, optional, nullable) — Llamadas consecutivas a un número que pueden fallar antes de que el contacto pase al siguiente número de su lista o finalice si no hay otro. Una llamada contestada o una redirección a un número nuevo reinicia el recuento. Si no se establece, solo se aplica `max_total_calls`.

### CallingPeriod

- `weekdays` (list of integer, required) — Días en que se aplican los intervalos, de `0` (lunes) a `6` (domingo).
- `intervals` (list of CallingIntervalPolicy, required) — Franjas horarias en cada uno de esos días. No pueden solaparse en ningún día.

### DataCollectionConfig

Los elementos de recopilación de datos del agente que guían las llamadas de seguimiento. Cada uno usa de forma predeterminada el elemento integrado para su propósito; `null` lo desactiva.

- `callback_time` (string, optional, nullable, default: __system_data_collection_callback_time) — El elemento que indica cuándo el contacto solicitó una devolución de llamada.
- `redirect_phone_number` (string, optional, nullable, default: __system_data_collection_redirect_phone_number) — El elemento que contiene otro número al que el contacto solicitó que se le llamara.
- `stop` (string, optional, nullable, default: __system_data_collection_do_not_call) — El elemento que es true cuando el contacto solicitó no volver a recibir llamadas.
- `mappings` (map from string to string, optional) — Copia los resultados de recopilación de datos en variables dinámicas para llamadas posteriores: cada clave es un ID de elemento de recopilación de datos y su valor es el nombre de la variable.

### FollowupContextPolicy

Qué variables dinámicas `campaign__` reciben las llamadas de seguimiento.

- `call_type` (boolean, optional, default: true) — Pasa el tipo de llamada como `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Pasa el ID de la última conversación como `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Pasa el resumen de la última conversación como `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Pasa la transcripción de la última conversación como `campaign__previous_transcript`.

### CallingIntervalPolicy

- `start` (string, required) — Hora local de inicio, como `HH:MM`.
- `end` (string, required) — Hora local de finalización, como `HH:MM`; `24:00` finaliza a medianoche.

## Examples

**Response**

```json
{
  "version": 1,
  "config": {
    "policy": {
      "timezone": "UTC",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    },
    "agent_policies": {},
    "whatsapp_voice_policy": {
      "timezone": "string",
      "retry": {
        "retry_delay_seconds": 600,
        "max_short_retries": 1,
        "max_total_calls": 6,
        "max_callbacks": 2,
        "max_redirects": 2,
        "interval_placement": "start",
        "rotate_step_seconds": 900,
        "max_consecutive_failures_per_number": 1
      },
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "string",
              "end": "string"
            }
          ]
        }
      ],
      "data_collection": {
        "callback_time": "string",
        "redirect_phone_number": "string",
        "stop": "string",
        "mappings": {}
      },
      "followup_context": {
        "call_type": true,
        "previous_conversation_id": true,
        "previous_summary": true,
        "previous_transcript": true
      }
    }
  }
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/config';
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/config"

	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/config")

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/config")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/config");
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/config")! 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()
```