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

# 列出外呼活动通话记录

GET https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/{campaign_id}/calls

列出外呼活动的呼叫，按最新优先排序：首次联系、重试、回拨和重定向，以及它们是排队中、进行中还是已完成。

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

### Path parameters

- `campaign_id` (string, required)

### Query parameters

- `page_size` (integer, optional, default: 100) — 最多返回的项目数。
- `lead_id` (string, optional, nullable) — 仅此潜在客户的呼叫。
- `status` (enum, optional, nullable) — 仅此状态的呼叫。
  - Allowed values: `queued`, `submitted`, `completed`, `cancelled`, `attention`
- `call_result` (list of enum, optional, nullable) — 仅以这些结果之一结束的呼叫。
  - Allowed values: `answered`, `voicemail`, `busy`, `no_answer`, `failed`
- `stage` (enum, optional, nullable) — 仅此投递阶段的消息。仅适用于消息活动。
  - Allowed values: `queued`, `sent`, `delivered`, `read`, `replied`, `failed`
- `cursor` (string, optional, nullable) — 用于获取下一页。响应中会返回游标。

## Response

### 200

成功响应

- `calls` (list of CallView, required)
- `next_cursor` (string, required, nullable)
- `has_more` (boolean, required)

## Errors

### 422 Unprocessable Entity Error

验证错误。

- `detail` (list of ValidationError, optional)

## Types

### CallView

- `intent_id` (string, required)
- `lead_id` (string, required)
- `intent_type` (enum, required) — 潜在客户的首次呼叫为 `initial`，其他为 `retry`、`callback` 或 `redirect`。
  - Allowed values: `initial`, `retry`, `callback`, `redirect`
- `cold_attempt` (integer, required, nullable) — 首次呼叫为 `1`，每次重试加 `+1`；回拨、重定向及其重试不设置此值。
- `status` (enum, required) — `submitted` 呼叫已提交进行拨号；`attention` 呼叫因待处理项而暂停。
  - Allowed values: `queued`, `submitted`, `completed`, `cancelled`, `attention`
- `phone_number` (string, required)
- `scheduled_time_unix` (integer, required) — 计划发起呼叫的时间。
- `conversation_id` (string, required, nullable)
- `outcome` (enum, required, nullable) — 呼叫结束后设置的最终拨号状态。
  - Allowed values: `pending`, `dispatched`, `initiated`, `in_progress`, `completed`, `failed`, `cancelled`, `voicemail`
- `call_result` (enum, required, nullable) — 呼叫的结束方式。
  - Allowed values: `answered`, `voicemail`, `busy`, `no_answer`, `failed`
- `outcome_at_unix` (integer, required, nullable) — 呼叫结束时间。
- `decision_disposition` (enum, required, nullable) — 活动在呼叫后执行的操作，例如将重试或回拨加入队列，或结束该潜在客户。
  - Allowed values: `completed`, `retry_queued`, `callback_queued`, `redirect_queued`, `attention`, `cancelled`, `do_not_call`, `suppressed`, `window_suspended`, `attempt_ceiling_reached`, `callback_ceiling_reached`, `redirect_ceiling_reached`, `callback_time_invalid`, `redirect_number_invalid`, `couldnt_process`, `suppressed_do_not_call`, `suppressed_after_stop`, `permission_not_granted`, `permission_declined`, `permission_request_blocked`, `permission_expired`
- `collected_dynamic_variables` (map from string to any, optional) — 此次呼叫复制到潜在客户动态变量、供后续呼叫使用的数据收集结果，已隐去密钥。
- `delivery` (LeadDeliveryView, optional, nullable) — 消息的投递状态；在消息活动中设置。

### ValidationError

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

### LeadDeliveryView

- `status` (enum, required)
  - Allowed values: `pending`, `dispatched`, `initiated`, `in_progress`, `completed`, `failed`, `cancelled`, `voicemail`
- `stage` (enum, required) — 消息到达的最远阶段；发送失败时为 `failed`。
  - Allowed values: `queued`, `sent`, `delivered`, `read`, `replied`, `failed`
- `sent_at_unix` (integer, required, nullable)
- `delivered_at_unix` (integer, required, nullable)
- `read_at_unix` (integer, required, nullable)
- `replied_at_unix` (integer, required, nullable)
- `failed_at_unix` (integer, required, nullable)
- `error_message` (string, required, nullable) — 消息未能送达联系人的原因。

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "calls": [
    {
      "intent_id": "string",
      "lead_id": "string",
      "intent_type": "initial",
      "cold_attempt": 1,
      "status": "queued",
      "phone_number": "string",
      "scheduled_time_unix": 1,
      "conversation_id": "string",
      "outcome": "pending",
      "call_result": "answered",
      "outcome_at_unix": 1,
      "decision_disposition": "completed",
      "collected_dynamic_variables": {},
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": 1,
        "delivered_at_unix": 1,
        "read_at_unix": 1,
        "replied_at_unix": 1,
        "failed_at_unix": 1,
        "error_message": "string"
      }
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/calls"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/calls';
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/campaigns/campaign_id/calls"

	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/campaigns/campaign_id/calls")

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/campaigns/campaign_id/calls")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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