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

# Riprendi una campagna outbound

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

Riprendi una campagna in uscita in pausa, incluse le chiamate trattenute da un elemento di attenzione.

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

Risposta riuscita

- `campaign_id` (string, required)
- `call_name` (string, required) — Il nome della campagna.
- `agent_id` (string, required)
- `channel_config` (CampaignResponseChannelConfig, required)
- `status` (enum, required) — `attention` indica che un elemento di attenzione aperto trattiene alcune chiamate della campagna, mentre le altre procedono. `stopping` indica che le chiamate in coda vengono annullate e quelle già avviate si stanno concludendo.
  - Allowed values: `active`, `paused`, `stopping`, `stopped`, `completed`, `failed`, `attention`
- `policy` (CampaignPolicySnapshot, required) — La policy adottata dalla campagna al momento della creazione.
- `variant` (enum, required)
  - Allowed values: `simple`, `advanced`
- `source` (enum, required, nullable) — Se la campagna è stata creata nell'app o tramite l'API.
  - Allowed values: `ui`, `api`
- `outcome` (CampaignResponseOutcome, required, nullable) — Il risultato considerato un successo per le chiamate della campagna.
- `created_at_unix` (integer, required)
- `scheduled_time_unix` (integer, required, nullable) — Quando la campagna inizia a chiamare; non impostato per iniziare al momento della creazione.
- `updated_at_unix` (integer, required)
- `branch_id` (string, required, nullable) — Il ramo dell'agente usato dalla campagna per le chiamate.
- `environment` (string, required, nullable) — L'ambiente in cui vengono risolte le variabili d'ambiente dell'agente.
- `target_concurrency_limit` (integer, required, nullable) — Il numero massimo di chiamate che la campagna effettua contemporaneamente.
- `channel` (enum, required)
  - Allowed values: `phone`, `whatsapp`
- `mode` (enum, required)
  - Allowed values: `voice`, `message`
- `counts` (CampaignSummaryCounts, required)
- `agent_name` (string, required, default: )

## Errors

### 422 Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### CampaignResponseChannelConfig

- `channel`: `phone` (PhoneChannelConfig)
  - `agent_phone_number_id` (string, required) — Il numero di telefono da cui chiamare.
  - `mode_config` (PhoneVoiceConfig-Output, optional)
- `channel`: `whatsapp` (WhatsAppChannelConfig)
  - `mode_config` (WhatsAppChannelConfigModeConfig, required)
  - `whatsapp_phone_number_id` (string, required) — Il numero di telefono WhatsApp da cui effettuare chiamate o inviare messaggi.

### CampaignPolicySnapshot

La policy adottata dalla campagna al momento della creazione, strutturata come una `policy` inviata.

- `timezone` (string, required)
- `retry` (RetryPolicy, required)
- `calling_periods` (list of CallingPeriodPolicy, required)
- `data_collection` (DataCollectionPolicy, required)
- `followup_context` (FollowupContextPolicy, required) — Quali variabili dinamiche `campaign__` ricevono le chiamate di follow-up.

### CampaignResponseOutcome

Il risultato considerato un successo per le chiamate della campagna.

- `type`: `data_collection` (DataCollectionOutcome)
  - `data_collection_id` (string, required) — L'elemento di raccolta dati dell'agente impostato da una chiamata riuscita.
  - `equals` (list of CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems, required) — Valori considerati un successo, tutti del tipo dell'elemento.
- `type`: `evaluation_criteria` (EvaluationCriterionOutcome)
  - `criteria_id` (string, required) — Il criterio di valutazione dell'agente soddisfatto da una chiamata riuscita.

### CampaignSummaryCounts

- `leads` (integer, required)
- `terminal_leads` (integer, required) — Lead che non verranno più chiamati.
- `open_attention` (integer, required) — Elementi di attenzione non ancora risolti.
- `delivery` (RecipientDeliveryCounts, optional, nullable) — Numero di messaggi che hanno raggiunto ogni fase; impostato quando si ottiene una singola campagna di messaggi.

### ValidationError

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

### PhoneVoiceConfig-Output

- `ringing_timeout_secs` (integer, optional, default: 60) — Per quanti secondi far squillare il destinatario prima di interrompere. Tieni presente che sarà limitato anche dai vincoli del provider.
- `twilio_call_recording_enabled` (boolean, optional, default: false) — Indica se registrare la chiamata tramite la registrazione chiamate di Twilio. Ignorato per i provider diversi da Twilio. Le registrazioni vengono archiviate nel tuo account Twilio.
- `twilio_machine_detection` (TwilioMachineDetectionConfig, optional, nullable) — Configurazione per il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio. Ometti o imposta su null per disabilitarlo. Viene ignorata per i provider diversi da Twilio e per le chiamate in entrata. Il verdetto risultante viene inviato come evento webhook `answering_machine_detection` separato, che richiede l'abilitazione di tale evento nelle impostazioni webhook del workspace o dell'agente; non fa parte della conversazione né del webhook post-chiamata. Il rilevamento viene eseguito in modo asincrono, quindi non ritarda mai l'inizio della conversazione, e il verdetto può arrivare in qualsiasi momento durante la chiamata -- con `detect_message_end`, anche dopo la sua conclusione. Twilio fattura AMD separatamente.
- `mode` ("voice", optional, default: voice)

### WhatsAppChannelConfigModeConfig

- `mode`: `message` (WhatsAppMessageConfig)
  - `template` (WhatsAppTemplate, required) — Il template Meta come approvato al momento dell'invio.
- `mode`: `voice` (WhatsAppVoiceConfig)
  - `whatsapp_call_permission_request_template_language_code` (string, required) — Il codice lingua di quel template.
  - `whatsapp_call_permission_request_template_name` (string, required) — Il template approvato che chiede al contatto l'autorizzazione a chiamare.

### 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, nullable) — 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`.

### CallingPeriodPolicy

- `weekdays` (list of integer, required)
- `intervals` (list of CallingIntervalPolicy, required) — Finestre per ciascuno di quei giorni. Non possono sovrapporsi in nessun giorno.

### DataCollectionPolicy

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

### CampaignResponseOutcomeDiscriminatorMappingDataCollectionEqualsItems

- string
- integer
- double
- boolean

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

### ValidationErrorLocItems

- string
- integer

### TwilioMachineDetectionConfig

Come eseguire il rilevamento della segreteria telefonica (AMD) a livello di operatore di Twilio durante una chiamata.

- `mode` (enum, optional, default: enable) — Quanto deve essere approfondito il rilevamento. `enable` restituisce un verdetto non appena Twilio riesce a distinguere una persona da una macchina. `detect_message_end` attende anche la fine del messaggio di segreteria telefonica, producendo i verdetti `machine_end_*`, ma restituisce il risultato più tardi.
  - Allowed values: `enable`, `detect_message_end`
- `actions` (list of TwilioMachineDetectionRule, optional) — Azioni da eseguire sulla chiamata per ciascun verdetto AMD. Ogni azione può comparire al massimo in una regola, quindi elenca insieme tutti i relativi verdetti. I verdetti senza una regola lasciano la chiamata in corso.

### 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, nullable) — https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/

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

### TwilioMachineDetectionRule

Azione da eseguire su una chiamata in corso per i verdetti AMD specificati.

- `action` (enum, required)
  - Allowed values: `hang_up`
- `answered_by` (list of enum, required) — Verdetti che attivano l'azione.
  - Allowed values: `human`, `fax`, `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`

### WhatsAppTemplateComponent

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

### WhatsAppTemplateComponentButton

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

## Examples

**Response**

```json
{
  "campaign_id": "string",
  "call_name": "string",
  "agent_id": "string",
  "channel_config": {
    "channel": "phone",
    "agent_phone_number_id": "string",
    "mode_config": {
      "ringing_timeout_secs": 60,
      "twilio_call_recording_enabled": false,
      "twilio_machine_detection": {
        "mode": "enable",
        "actions": [
          {
            "action": "hang_up",
            "answered_by": [
              "human"
            ]
          }
        ]
      },
      "mode": "voice"
    }
  },
  "status": "active",
  "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
    }
  },
  "variant": "simple",
  "source": "ui",
  "outcome": {
    "type": "evaluation_criteria",
    "criteria_id": "string"
  },
  "created_at_unix": 1,
  "scheduled_time_unix": 1,
  "updated_at_unix": 1,
  "branch_id": "string",
  "environment": "string",
  "target_concurrency_limit": 1,
  "channel": "phone",
  "mode": "voice",
  "counts": {
    "leads": 1,
    "terminal_leads": 1,
    "open_attention": 1,
    "delivery": {
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "replied": 0,
      "failed": 0
    }
  },
  "agent_name": ""
}
```

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