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

# Reprendre une campagne d'appels sortants

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

Reprend une campagne sortante en pause, y compris les appels bloqués par un élément d'attention.

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

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

Réponse réussie

- `campaign_id` (string, required)
- `call_name` (string, required) — Nom de la campagne.
- `agent_id` (string, required)
- `channel_config` (CampaignResponseChannelConfig, required)
- `status` (enum, required) — `attention` signifie qu'un élément d'attention ouvert bloque certains appels de la campagne, tandis que les autres se poursuivent. `stopping` signifie que les appels en attente sont annulés et que les appels déjà passés se terminent.
  - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention`
- `policy` (CampaignPolicySnapshot, required) — La stratégie adoptée par la campagne lors de sa création.
- `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) — Indique si la campagne a été créée dans l’application ou via l’API.
  - Allowed values: `ui`, `api`
- `outcome` (CampaignResponseOutcome, optional) — Le résultat considéré comme une réussite pour les appels de la campagne.
- `scheduled_time_unix` (integer, optional) — Date et heure auxquelles la campagne commence à appeler ; non défini pour démarrer dès sa création.
- `branch_id` (string, optional) — Branche de l'agent utilisée par la campagne pour les appels.
- `environment` (string, optional) — Environnement dans lequel les variables d'environnement de l'agent sont résolues.
- `target_concurrency_limit` (integer, optional) — Nombre maximal d'appels que la campagne passe simultanément.

## Errors

### 422 Outbound Campaigns Resume Request Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### CampaignResponseChannelConfig

- `channel`: `phone`
  - `agent_phone_number_id` (string, required) — Numéro de téléphone depuis lequel appeler.
  - `mode_config` (PhoneVoiceConfigOutput, optional)
- `channel`: `whatsapp`
  - `mode_config` (WhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — Le numéro de téléphone WhatsApp depuis lequel appeler ou envoyer un message.

### CampaignPolicySnapshot

La stratégie adoptée par la campagne lors de sa création, présentée comme une `policy` soumise.

- `timezone` (string, required)
- `retry` (RetryPolicy, required)
- `calling_periods` (list of CallingPeriodPolicy, required)
- `data_collection` (DataCollectionPolicy, required)
- `followup_context` (FollowupContextPolicy, required) — Variables dynamiques `campaign__` attribuées aux appels de suivi.

### CampaignSummaryCounts

- `leads` (integer, required)
- `terminal_leads` (integer, required) — Prospects qui ne seront plus appelés.
- `open_attention` (integer, required) — Éléments d'attention pas encore résolus.
- `delivery` (RecipientDeliveryCounts, optional) — Nombre de messages ayant atteint chaque étape ; défini lors de la récupération d'une campagne de messages.

### CampaignResponseOutcome

- `type`: `data_collection`
  - `data_collection_id` (string, required) — Élément de collecte de données de l'agent qu'un appel réussi définit.
  - `equals` (list of DataCollectionOutcomeEqualsItem, required) — Valeurs considérées comme des réussites, toutes du type de l’élément.
- `type`: `evaluation_criteria`
  - `criteria_id` (string, required) — Critère d'évaluation de l'agent auquel répond un appel réussi.

### ValidationError

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

### PhoneVoiceConfigOutput

- `ringing_timeout_secs` (integer, optional, default: 60) — Durée, en secondes, pendant laquelle faire sonner le destinataire avant d’abandonner. Cette durée est également limitée par les contraintes propres au fournisseur.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Indique s'il faut enregistrer l'appel à l'aide de l'enregistrement d'appels Twilio. Ignoré pour les fournisseurs autres que Twilio. Les enregistrements sont stockés dans votre compte Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional) — Configuration de la détection de répondeur au niveau opérateur (AMD) de Twilio. Omettez-la ou définissez-la sur null pour la désactiver. Elle est ignorée pour les fournisseurs autres que Twilio et pour les appels entrants. Le verdict obtenu est transmis dans son propre événement webhook `answering_machine_detection`, ce qui exige que cet événement soit activé dans les paramètres de webhook du Workspace ou de l'agent ; il ne fait pas partie de la conversation ni du webhook post-appel. La détection s'exécute de manière asynchrone et ne retarde donc jamais le début de la conversation, et le verdict peut arriver à tout moment pendant l'appel, avec `detect_message_end`, même après sa fin. Twilio facture l'AMD séparément.
- `mode` ("voice", optional)

### WhatsAppChannelConfigModeConfig

- `mode`: `message`
  - `template` (WhatsAppTemplate, required) — Modèle Meta tel qu'il a été approuvé lors de sa soumission.
- `mode`: `voice`
  - `whatsapp_call_permission_request_template_language_code` (string, required) — Code de langue de ce modèle.
  - `whatsapp_call_permission_request_template_name` (string, required) — Modèle approuvé qui demande au contact l'autorisation d'appeler.

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

### CallingPeriodPolicy

- `weekdays` (list of integer, required)
- `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.

### DataCollectionPolicy

- `callback_time` (string, optional)
- `redirect_phone_number` (string, optional)
- `stop` (string, optional)
- `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`.

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

Méthode d’exécution de la détection de répondeur au niveau de l’opérateur (AMD) de Twilio sur un appel.

- `mode` (enum, optional, default: enable) — Niveau de précision de la détection. `enable` renvoie un verdict dès que Twilio peut distinguer un humain d’une machine. `detect_message_end` attend également la fin du message d’accueil de la messagerie vocale, ce qui produit les verdicts `machine_end_*`, mais renvoie le résultat plus tard.
  - Allowed values: `enable`, `detect_message_end`
- `actions` (list of TwilioMachineDetectionRule, optional) — Actions à entreprendre lors de l’appel pour chaque verdict AMD. Chaque action ne peut figurer que dans une seule règle. Regroupez donc tous les verdicts correspondants. Les verdicts sans règle laissent l’appel se poursuivre.

### 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) — Heure de début locale, au format `HH:MM`.
- `end` (string, required) — Heure de fin locale, au format `HH:MM` ; `24:00` correspond à minuit.

### TwilioMachineDetectionRule

Action à entreprendre lors d’un appel en cours pour les verdicts AMD indiqués.

- `action` ("hang_up", required)
- `answered_by` (list of enum, required) — Verdicts qui déclenchent l’action.
  - 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/resume"

response = requests.post(url)

print(response.json())
```

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

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/resume"

	req, _ := http.NewRequest("POST", 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/resume")

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

request = Net::HTTP::Post.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.post("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/resume")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/resume");
var request = new RestRequest(Method.POST);
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/resume")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

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