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

# Ottieni la configurazione della campagna outbound

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

Ottieni la configurazione delle campagne in uscita del workspace: la policy predefinita adottata dalle nuove campagne e gli override per agente.

Reference: https://elevenlabs.io/docs/eleven-agents/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

Risposta riuscita

- `version` (integer, required) — Aumenta a ogni sostituzione; invialo come `expected_version`.
- `config` (CampaignConfigOutput, required)

## Errors

### 422 Config Get Request Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### CampaignConfigOutput

- `policy` (PolicyConfigOutput, optional) — La policy adottata dalle campagne, salvo che ne impostino una propria.
- `agent_policies` (map from string to AgentPolicyOverrideOutput, optional) — Override di `policy`, indicizzati per ID dell'agente.
- `whatsapp_voice_policy` (AgentPolicyOverrideOutput, optional) — Override per le campagne vocali WhatsApp, applicati tra la policy del workspace e gli override di un agente. Le sezioni omesse seguono le impostazioni predefinite integrate di WhatsApp Voice.

### ValidationError

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

### PolicyConfigOutput

- `timezone` (string, optional, default: UTC) — Fuso orario IANA in cui vengono interpretati i periodi di chiamata.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — Le finestre settimanali in cui è possibile effettuare chiamate.
- `data_collection` (DataCollectionConfig, optional) — Gli elementi di raccolta dati dell'agente che guidano le chiamate di follow-up. Ognuno usa per impostazione predefinita l'elemento integrato per il proprio scopo; `null` lo disattiva.
- `followup_context` (FollowupContextPolicy, optional) — Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up.

### AgentPolicyOverrideOutput

Ogni sezione impostata qui sostituisce l'intera sezione corrispondente della policy.

- `timezone` (string, optional)
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional)
- `data_collection` (DataCollectionConfig, optional) — Gli elementi di raccolta dati dell'agente che guidano le chiamate di follow-up. Ognuno usa per impostazione predefinita l'elemento integrato per il proprio scopo; `null` lo disattiva.
- `followup_context` (FollowupContextPolicy, optional) — Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up.

### ValidationErrorLocItem

- string
- integer

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Tempo di attesa prima di un breve tentativo successivo.
- `max_short_retries` (integer, optional, default: 1) — Tentativi successivi consentiti da una finestra di chiamata dopo una chiamata non riuscita. Una volta esauriti, il tentativo successivo attende la finestra seguente, che riparte da zero.
- `max_total_calls` (integer, optional, default: 6) — Il numero massimo di chiamate ricevute da un lead, inclusa la prima.
- `max_callbacks` (integer, optional, default: 2) — Il numero massimo di richiamate da rispettare per un singolo numero.
- `max_redirects` (integer, optional, default: 2) — Il numero massimo di volte in cui un lead segue una richiesta di chiamare un altro numero.
- `interval_placement` (enum, optional, default: start) — Where in a later calling window a pushed-back call lands: at its `start`, at a `random` time, or `rotate`d `rotate_step_seconds` past where the last call in that window failed.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Di quanto il posizionamento `rotate` sposta ogni chiamata. Usato solo da `rotate`.
- `max_consecutive_failures_per_number` (integer, optional) — Numero di chiamate consecutive a un numero che possono non riuscire prima che il lead passi al numero successivo nell'elenco o termini, se non ce ne sono altri. Una chiamata risposta o un reindirizzamento a un nuovo numero riavvia il conteggio. Se non impostato, rimane solo `max_total_calls`.

### CallingPeriod

- `weekdays` (list of integer, required) — Giorni in cui si applicano gli intervalli, da `0` (lunedì) a `6` (domenica).
- `intervals` (list of CallingIntervalPolicy, required) — Finestre per ciascuno di quei giorni. Non possono sovrapporsi in nessun giorno.

### DataCollectionConfig

Gli elementi di raccolta dati dell'agente che guidano le chiamate di follow-up. Ognuno usa per impostazione predefinita l'elemento integrato per il proprio scopo; `null` lo disattiva.

- `callback_time` (string, optional) — L'elemento contenente quando il contatto ha chiesto di essere richiamato.
- `redirect_phone_number` (string, optional) — L'elemento contenente un altro numero su cui il contatto ha chiesto di essere chiamato.
- `stop` (string, optional) — L'elemento che è true quando il contatto ha chiesto di non essere chiamato di nuovo.
- `mappings` (map from string to string, optional) — Copia i risultati della raccolta dati nelle variabili dinamiche per le chiamate successive: ogni chiave è un ID dell'elemento di raccolta dati e il relativo valore è il nome della variabile.

### FollowupContextPolicy

Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up.

- `call_type` (boolean, optional, default: true) — Passa il tipo di chiamata come `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Passa l'ID dell'ultima conversazione come `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Passa il riepilogo dell'ultima conversazione come `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Passa la trascrizione dell'ultima conversazione come `campaign__previous_transcript`.

### CallingIntervalPolicy

- `start` (string, required) — Ora di inizio locale, nel formato `HH:MM`.
- `end` (string, required) — Ora di fine locale, nel formato `HH:MM`; `24:00` termina a mezzanotte.

## Examples

**Response**

```json
{
  "version": 1,
  "config": {
    "policy": {
      "timezone": "timezone",
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ]
    },
    "agent_policies": {
      "key": {}
    },
    "whatsapp_voice_policy": {
      "timezone": "timezone",
      "calling_periods": [
        {
          "weekdays": [
            1
          ],
          "intervals": [
            {
              "start": "start",
              "end": "end"
            }
          ]
        }
      ]
    }
  }
}
```

**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()
```