> 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 tous les appels par lots d'un Workspace.

GET https://api.elevenlabs.io/v1/convai/batch-calling/workspace

Récupère tous les appels par lot du Workspace actuel.

Reference: https://elevenlabs.io/docs/api-reference/batch-calling/list

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

### Query parameters

- `limit` (integer, optional, default: 100)
- `last_doc` (string, optional, nullable)
- `agent_id` (string, optional, nullable) — Filtre les appels par lot pour un seul agent.

## Response

### 200

Réponse réussie

- `batch_calls` (list of BatchCallResponse, required)
- `next_doc` (string, optional, nullable) — Le document suivant, utilisé pour paginer les appels par lots
- `has_more` (boolean, optional, default: false) — Indique s’il y a d’autres appels par lot à paginer

## Errors

### 422 Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### BatchCallResponse

- `id` (string, required)
- `phone_number_id` (string, required, nullable)
- `phone_provider` (enum, required, nullable)
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `whatsapp_params` (BatchCallWhatsAppParams, required, nullable)
- `name` (string, required)
- `agent_id` (string, required)
- `branch_id` (string, required, nullable)
- `environment` (string, required, nullable)
- `created_at_unix` (integer, required)
- `scheduled_time_unix` (integer, required)
- `timezone` (string, required, nullable)
- `total_calls_dispatched` (integer, required, default: 0)
- `total_calls_scheduled` (integer, required, default: 0)
- `total_calls_finished` (integer, required, default: 0)
- `last_updated_at_unix` (integer, required)
- `status` (enum, required)
  - Allowed values: `pending`, `in_progress`, `completed`, `failed`, `cancelled`
- `retry_count` (integer, required, default: 0)
- `telephony_call_config` (TelephonyCallConfig-Output, required)
- `target_concurrency_limit` (integer, required, nullable) — Nombre maximal d’appels simultanés pour ce lot. Lorsqu’il est défini, la distribution est régie par cette limite plutôt que par les pourcentages de capacité du Workspace ou de l’agent.
- `agent_name` (string, required)
- `branch_name` (string, required, nullable)

### ValidationError

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

### BatchCallWhatsAppParams

- `whatsapp_call_permission_request_template_name` (string, required)
- `whatsapp_call_permission_request_template_language_code` (string, required)
- `whatsapp_phone_number_id` (string, optional, nullable)

### TelephonyCallConfig-Output

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

### ValidationErrorLocItems

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

### TwilioMachineDetectionRule

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

- `action` (enum, required)
  - Allowed values: `hang_up`
- `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`

## Examples

**Response**

```json
{
  "batch_calls": [
    {
      "id": "string",
      "phone_number_id": "string",
      "phone_provider": "twilio",
      "whatsapp_params": {
        "whatsapp_call_permission_request_template_name": "string",
        "whatsapp_call_permission_request_template_language_code": "string",
        "whatsapp_phone_number_id": "string"
      },
      "name": "string",
      "agent_id": "string",
      "branch_id": "string",
      "environment": "string",
      "created_at_unix": 1,
      "scheduled_time_unix": 1,
      "timezone": "string",
      "total_calls_dispatched": 0,
      "total_calls_scheduled": 0,
      "total_calls_finished": 0,
      "last_updated_at_unix": 1,
      "status": "pending",
      "retry_count": 0,
      "telephony_call_config": {
        "ringing_timeout_secs": 60,
        "twilio_call_recording_enabled": false,
        "twilio_machine_detection": {
          "mode": "enable",
          "actions": [
            {
              "action": "hang_up",
              "answered_by": [
                "human"
              ]
            }
          ]
        }
      },
      "target_concurrency_limit": 1,
      "agent_name": "string",
      "branch_name": "string"
    }
  ],
  "next_doc": "string",
  "has_more": false
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/batch-calling/workspace"

response = requests.get(url)

print(response.json())
```

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

	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/batch-calling/workspace")

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

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/batch-calling/workspace');

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

```csharp
using RestSharp;

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