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

# Obtenir la configuration de la campagne d'appels sortants

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

Récupère la configuration des campagnes sortantes du Workspace : la politique par défaut appliquée aux nouvelles campagnes et les remplacements par agent.

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

Réponse réussie

- `version` (integer, required) — Augmente à chaque remplacement ; envoyez-le en tant que `expected_version`.
- `config` (CampaignConfigOutput, required)

## Errors

### 422 Config Get Request Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### CampaignConfigOutput

- `policy` (PolicyConfigOutput, optional) — La stratégie appliquée par les campagnes, à moins qu’elles définissent la leur.
- `agent_policies` (map from string to AgentPolicyOverrideOutput, optional) — Remplacements de `policy`, indexés par ID d'agent.
- `whatsapp_voice_policy` (AgentPolicyOverrideOutput, optional) — Remplacements pour les campagnes téléphoniques WhatsApp, appliqués entre la politique du Workspace et les remplacements d'un agent. Les sections omises utilisent les valeurs par défaut intégrées de WhatsApp voice.

### ValidationError

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

### PolicyConfigOutput

- `timezone` (string, optional, default: UTC) — Fuseau horaire IANA utilisé pour interpréter les périodes d'appel.
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional) — Les plages hebdomadaires durant lesquelles les appels peuvent être effectués.
- `data_collection` (DataCollectionConfig, optional) — Éléments de collecte de données de l'agent qui orientent les appels de suivi. Chacun utilise par défaut l'élément intégré correspondant à son objectif ; `null` le désactive.
- `followup_context` (FollowupContextPolicy, optional) — Variables dynamiques `campaign__` attribuées aux appels de suivi.

### AgentPolicyOverrideOutput

Chaque section définie ici remplace l'intégralité de la section correspondante de la politique.

- `timezone` (string, optional)
- `retry` (RetryPolicy, optional)
- `calling_periods` (list of CallingPeriod, optional)
- `data_collection` (DataCollectionConfig, optional) — Éléments de collecte de données de l'agent qui orientent les appels de suivi. Chacun utilise par défaut l'élément intégré correspondant à son objectif ; `null` le désactive.
- `followup_context` (FollowupContextPolicy, optional) — Variables dynamiques `campaign__` attribuées aux appels de suivi.

### ValidationErrorLocItem

- string
- integer

### RetryPolicy

- `retry_delay_seconds` (integer, optional, default: 600) — Délai d'attente avant une courte nouvelle tentative.
- `max_short_retries` (integer, optional, default: 1) — Nouvelles tentatives autorisées par une plage d'appel après un appel échoué. Une fois épuisées, la tentative suivante attend la plage suivante, dont le compteur repart à zéro.
- `max_total_calls` (integer, optional, default: 6) — Nombre maximal d'appels qu'un prospect peut recevoir, premier appel inclus.
- `max_callbacks` (integer, optional, default: 2) — Nombre maximal de rappels à honorer pour un même numéro.
- `max_redirects` (integer, optional, default: 2) — Nombre maximal de fois qu'un prospect suit une demande d'appel vers un autre numéro.
- `interval_placement` (enum, optional, default: start) — Positionnement d’un appel reporté dans une plage d’appel ultérieure : à son `start`, à une heure `random`, ou à `rotate_step_seconds` secondes, avec `rotate`, après l’endroit où le dernier appel de cette plage a échoué.
  - Allowed values: `start`, `random`, `rotate`
- `rotate_step_seconds` (integer, optional, default: 900) — Décalage appliqué à chaque appel par le placement `rotate`. Utilisé uniquement par `rotate`.
- `max_consecutive_failures_per_number` (integer, optional) — Nombre d'appels successifs vers un même numéro pouvant échouer avant que le prospect passe au numéro suivant de sa liste, ou s'arrête s'il n'y en a pas. Un appel abouti ou une redirection vers un nouveau numéro réinitialise le compteur. S'il n'est pas défini, seul `max_total_calls` s'applique.

### CallingPeriod

- `weekdays` (list of integer, required) — Jours auxquels les intervalles s'appliquent, de `0` (lundi) à `6` (dimanche).
- `intervals` (list of CallingIntervalPolicy, required) — Plages horaires pour chacun de ces jours. Elles ne peuvent pas se chevaucher au cours d’une même journée.

### DataCollectionConfig

Éléments de collecte de données de l'agent qui orientent les appels de suivi. Chacun utilise par défaut l'élément intégré correspondant à son objectif ; `null` le désactive.

- `callback_time` (string, optional) — Élément indiquant quand le contact a demandé à être rappelé.
- `redirect_phone_number` (string, optional) — Élément contenant l'autre numéro auquel le contact a demandé à être appelé.
- `stop` (string, optional) — Élément qui est vrai lorsque le contact a demandé à ne plus être appelé.
- `mappings` (map from string to string, optional) — Copie les résultats de collecte de données dans des variables dynamiques pour les appels ultérieurs : chaque clé est un ID d'élément de collecte de données et sa valeur est le nom de la variable.

### FollowupContextPolicy

Variables dynamiques `campaign__` attribuées aux appels de suivi.

- `call_type` (boolean, optional, default: true) — Transmettez le type d'appel en tant que `campaign__call_type`.
- `previous_conversation_id` (boolean, optional, default: true) — Transmettez l'ID de la dernière conversation en tant que `campaign__previous_conversation_id`.
- `previous_summary` (boolean, optional, default: true) — Transmettez le résumé de la dernière conversation en tant que `campaign__previous_summary`.
- `previous_transcript` (boolean, optional, default: true) — Transmettez la transcription de la dernière conversation en tant que `campaign__previous_transcript`.

### CallingIntervalPolicy

- `start` (string, required) — Heure de début locale, au format `HH:MM`.
- `end` (string, required) — Heure de fin locale, au format `HH:MM` ; `24:00` correspond à minuit.

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