> 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}/leads

列出外呼活动的潜在客户，每位收件人一条。

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/campaigns/leads/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) — 最多返回的项目数。
- `search` (string, optional) — 仅 ID、用户 ID 或电话号码包含此文本的潜在客户。
- `status` (enum, optional) — 仍在呼叫的潜在客户为 `in_progress`，不会再次呼叫的潜在客户为 `finished`。
  - Allowed values: `in_progress`, `finished`
- `disposition` (enum, optional) — 仅以这些方式之一完成的潜在客户。
  - Allowed values: `campaign_ended`, `removed`, `do_not_call`, `completed`, `cancelled`, `suppressed`, `attempt_ceiling_reached`, `callback_ceiling_reached`, `redirect_ceiling_reached`, `permission_not_granted`, `permission_declined`, `permission_request_blocked`, `permission_expired`, `callback_time_invalid`, `redirect_number_invalid`, `couldnt_process`
- `cursor` (string, optional) — 用于获取下一页。响应中会返回游标。

## Response

### 200

成功响应

- `leads` (list of LeadView, required)
- `has_more` (boolean, required)
- `next_cursor` (string, optional)

## Errors

### 422 Leads List Request Unprocessable Entity Error

验证错误。

- `detail` (list of ValidationError, optional)

## Types

### LeadView

- `lead_id` (string, required)
- `phone_number` (string, required) — 潜在客户下次呼叫要拨打的号码。当潜在客户转至其他列出的号码，或联系人要求改拨其他号码时，此号码会变更。
- `phone_numbers_index` (integer, required) — 正在呼叫的号码在 `phone_numbers` 中的位置。
- `user_id` (string, required) — 联系人的身份：`conversation_initiation_client_data` 中提交的 `user_id`，否则为潜在客户的电话号码。
- `attempt_count` (integer, required) — 已发起的呼叫，计入策略的 `max_total_calls`。
- `failure_count` (integer, required) — 向当前号码呼叫失败的次数；更换号码时重置。
- `callback_count` (integer, required) — 联系人请求的回拨。
- `redirect_count` (integer, required) — 联系人要求改用其他号码呼叫的次数。
- `do_not_call` (boolean, required) — 当联系人要求不再呼叫、潜在客户被移除或活动停止时设置。该潜在客户不会再被呼叫。
- `updated_at_unix` (integer, required)
- `dynamic_variables` (map from string to any, required) — 为潜在客户提交的动态变量，已隐去密钥。
- `overrides` (FlattenedConfigOverrides, required) — 为潜在客户提交的对话覆盖设置。
- `recipient_id` (string, optional) — 创建活动时分配给此收件人的 `id`。
- `phone_numbers` (list of string, optional) — 潜在客户列出的号码，按呼叫顺序排列。
- `terminal_disposition` (enum, optional) — 不再呼叫该潜在客户的原因；仍可能再次呼叫时不设置。
  - Allowed values: `campaign_ended`, `removed`, `do_not_call`, `completed`, `cancelled`, `suppressed`, `attempt_ceiling_reached`, `callback_ceiling_reached`, `redirect_ceiling_reached`, `permission_not_granted`, `permission_declined`, `permission_request_blocked`, `permission_expired`, `callback_time_invalid`, `redirect_number_invalid`, `couldnt_process`
- `created_at_unix` (integer, optional) — 潜在客户加入活动的时间；旧潜在客户未设置此项。
- `delivery` (LeadDeliveryView, optional) — 潜在客户最新的消息投递状态；在消息活动中设置。

### ValidationError

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

### FlattenedConfigOverrides

- `language` (string, optional)
- `first_message` (string, optional)
- `prompt` (string, optional)
- `voice_id` (string, optional)

### 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, optional)
- `delivered_at_unix` (integer, optional)
- `read_at_unix` (integer, optional)
- `replied_at_unix` (integer, optional)
- `failed_at_unix` (integer, optional)
- `error_message` (string, optional) — 消息未能送达联系人的原因。

### ValidationErrorLocItem

- string
- integer

## Examples

**Response**

```json
{
  "leads": [
    {
      "lead_id": "lead_id",
      "phone_number": "phone_number",
      "phone_numbers_index": 1,
      "user_id": "user_id",
      "attempt_count": 1,
      "failure_count": 1,
      "callback_count": 1,
      "redirect_count": 1,
      "do_not_call": true,
      "updated_at_unix": 1,
      "dynamic_variables": {
        "key": "value"
      },
      "overrides": {},
      "recipient_id": "recipient_id",
      "phone_numbers": [
        "phone_numbers"
      ],
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": null,
        "delivered_at_unix": null,
        "read_at_unix": null,
        "replied_at_unix": null,
        "failed_at_unix": null,
        "error_message": null
      }
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
```

**SDK Code**

```python
import requests

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

querystring = {"cursor":"cursor","disposition":"[\"campaign_ended\"]","page_size":"1","search":"search","status":"in_progress"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress';
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/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress"

	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/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress")

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/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress")
  .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/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress");
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/leads?cursor=cursor&disposition=%5B%22campaign_ended%22%5D&page_size=1&search=search&status=in_progress")! 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()
```