> 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/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, nullable) — केवल वे लीड जिनकी ID, यूज़र ID या फ़ोन नंबर में यह टेक्स्ट शामिल है।
- `status` (enum, optional, nullable) — जिन लीड को अभी भी कॉल की जा रही है उनके लिए `in_progress`, और जिन लीड को दोबारा कॉल नहीं की जाएगी उनके लिए `finished`।
  - Allowed values: `in_progress`, `finished`
- `disposition` (list of enum, optional, nullable) — केवल वे लीड जो इनमें से किसी एक तरीके से पूरी हुईं।
  - 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, nullable) — अगला पेज फ़ेच करने के लिए इस्तेमाल होता है। रिस्पॉन्स में cursor लौटाया जाता है।

## Response

### 200

सफल रिस्पॉन्स

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

## Errors

### 422 Unprocessable Entity Error

वैलिडेशन एरर

- `detail` (list of ValidationError, optional)

## Types

### LeadView

- `lead_id` (string, required)
- `recipient_id` (string, required, nullable) — अभियान बनाते समय इस प्राप्तकर्ता को दी गई `id`।
- `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) — तब सेट होता है जब संपर्क ने कॉल न करने को कहा, लीड हटा दी गई, या अभियान रोक दिया गया। लीड को फिर कॉल नहीं किया जाता।
- `terminal_disposition` (enum, required, nullable) — लीड को दोबारा कॉल क्यों नहीं की जाएगी; जब तक की जा सकती है, यह सेट नहीं होता।
  - 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, required, nullable) — लीड कैंपेन में कब शामिल हुई; पुरानी लीड्स के लिए यह सेट नहीं होता।
- `updated_at_unix` (integer, required)
- `dynamic_variables` (map from string to any, required) — लीड के लिए सबमिट किए गए डायनामिक वैरिएबल, जिनमें सीक्रेट छिपाए गए हैं।
- `overrides` (FlattenedConfigOverrides, required) — लीड के लिए सबमिट किए गए बातचीत ओवरराइड।
- `phone_numbers` (list of string, optional) — लीड के सूचीबद्ध नंबर, कॉलिंग क्रम में।
- `delivery` (LeadDeliveryView, optional, nullable) — लीड की नवीनतम मैसेज डिलीवरी; मैसेज अभियानों में सेट होती है।

### ValidationError

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

### FlattenedConfigOverrides

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

### 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
{
  "leads": [
    {
      "lead_id": "string",
      "recipient_id": "string",
      "phone_number": "string",
      "phone_numbers_index": 1,
      "user_id": "string",
      "attempt_count": 1,
      "failure_count": 1,
      "callback_count": 1,
      "redirect_count": 1,
      "do_not_call": true,
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "dynamic_variables": {},
      "overrides": {
        "language": "string",
        "first_message": "string",
        "prompt": "string",
        "voice_id": "string"
      },
      "phone_numbers": [
        "string"
      ],
      "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/leads"

response = requests.get(url)

print(response.json())
```

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

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

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")
  .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');

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

```csharp
using RestSharp;

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