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

# Lister la page des numéros de téléphone

GET https://api.elevenlabs.io/v1/convai/v2/phone-numbers

Récupère une page de numéros de téléphone

Reference: https://elevenlabs.io/docs/api-reference/phone-numbers/list-v-2

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

- `page_size` (integer, optional, default: 100) — Nombre de numéros de téléphone par page
- `search` (string, optional, nullable) — Filtrer par ID de numéro de téléphone, libellé ou numéro de téléphone. L'ID de numéro de téléphone doit correspondre exactement ; la correspondance du libellé et du numéro de téléphone porte sur une sous-chaîne, sans distinction entre majuscules et minuscules.
- `label` (string, optional, nullable) — Filtrer par libellé. La correspondance porte sur une sous-chaîne, sans distinction entre majuscules et minuscules.
- `phone_number` (string, optional, nullable) — Filtrer par numéro de téléphone
- `provider` (enum, optional, nullable) — Filtrer par fournisseur de téléphonie
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `supports_outbound` (boolean, optional, nullable) — Filtrer selon que le numéro de téléphone peut émettre des appels sortants
- `agent_id` (string, optional, nullable) — Filtrer par ID d'agent attribué
- `branch_id` (string, optional, nullable) — Filtrer par ID de branche attribuée
- `sort_by` (enum, optional, nullable) — Le champ selon lequel trier les résultats
  - Allowed values: `label`, `phone_number`
- `sort_direction` (enum, optional) — L’ordre de tri des résultats
  - Allowed values: `asc`, `desc`
- `cursor` (string, optional, nullable) — Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

## Response

### 200

Réponse réussie

- `phone_numbers` (list of GetPhoneNumbersPageResponseModelPhoneNumbersItems, required) — Les numéros de téléphone sur cette page
- `next_cursor` (string, optional, nullable) — Transmettez cette valeur comme `cursor` pour récupérer la page suivante. Null lorsqu'il n'y a plus de résultats.
- `has_more` (boolean, optional, default: false) — Indique si d’autres résultats sont disponibles

## Errors

### 422 Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### GetPhoneNumbersPageResponseModelPhoneNumbersItems

- `provider`: `exotel` (GetPhoneNumberExotelResponseModel)
  - `label` (string, required) — Libellé du numéro de téléphone
  - `phone_number` (string, required) — Numéro de téléphone
  - `phone_number_id` (string, required) — L’ID du numéro de téléphone
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agent attribué au numéro de téléphone
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels entrants.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels sortants.
- `provider`: `sip_trunk` (GetPhoneNumberSIPTrunkResponseModel)
  - `label` (string, required) — Libellé du numéro de téléphone
  - `livekit_stack` (enum, required, default: standard) — Type de pile Livekit utilisé pour ce numéro.
    - Allowed values: `standard`, `static`
  - `phone_number` (string, required) — Numéro de téléphone
  - `phone_number_id` (string, required) — L’ID du numéro de téléphone
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agent attribué au numéro de téléphone
  - `inbound_trunk` (GetPhoneNumberInboundSIPTrunkConfigResponseModel, optional, nullable) — Configuration du trunk SIP entrant, s'il est configuré.
  - `outbound_trunk` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable) — Configuration du trunk SIP sortant, s'il est configuré.
  - `store_sip_messages` (boolean, optional, default: true) — Indique s'il faut stocker les messages SIP associés à ce numéro de téléphone.
  - `provider_config` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable, deprecated) — Détails de configuration du trunk SIP pour un numéro de téléphone
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels entrants.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels sortants.
- `provider`: `twilio` (GetPhoneNumberTwilioResponseModel)
  - `label` (string, required) — Libellé du numéro de téléphone
  - `phone_number` (string, required) — Numéro de téléphone
  - `phone_number_id` (string, required) — L’ID du numéro de téléphone
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agent attribué au numéro de téléphone
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels entrants.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Ce champ est obsolète et sera supprimé ultérieurement. Indique si ce numéro de téléphone prend en charge les appels sortants.

### ValidationError

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

### PhoneNumberAgentInfo

- `agent_id` (string, required) — L’ID de l’agent
- `agent_name` (string, required) — Le nom de l’agent
- `environment` (string, optional, nullable) — Environnement à utiliser pour résoudre les variables d'environnement lors des appels vers ce numéro.
- `branch_id` (string, optional, nullable) — Branche de l'agent à utiliser pour les appels vers ce numéro.

### GetPhoneNumberInboundSIPTrunkConfigResponseModel

- `allowed_addresses` (list of string, required) — Liste des adresses IP autorisées à utiliser le trunk. Chaque élément de la liste peut être une adresse IP individuelle ou une notation Classless Inter-Domain Routing représentant un bloc CIDR.
- `allowed_numbers` (list of string, required, nullable) — Liste des numéros de téléphone autorisés à utiliser le trunk.
- `media_encryption` (enum, required, default: allowed)
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Indique si les identifiants d’authentification sont configurés
- `username` (string, optional, nullable) — Nom d’utilisateur du trunk SIP, s’il est disponible
- `remote_domains` (list of string, optional, nullable) — Domaines des serveurs SIP distants utilisés pour valider les certificats TLS.
- `attributes_to_headers` (map from string to string, optional) — Mappage du nom de variable dynamique vers le nom d’en-tête pour attributes_to_headers

### GetPhoneNumberOutboundSIPTrunkConfigResponseModel

Détails de configuration du trunk SIP pour un numéro de téléphone

- `address` (string, required) — Nom d’hôte ou adresse IP auquel l’INVITE SIP est envoyé.
- `transport` (enum, required, default: auto) — Protocole à utiliser pour le transport SIP
  - Allowed values: `auto`, `udp`, `tcp`, `tls`
- `media_encryption` (enum, required, default: allowed) — Indique si les médias doivent être chiffrés ou non (couche de données).
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Indique si les identifiants d’authentification sont configurés
- `headers` (map from string to string, optional) — En-têtes SIP de la requête INVITE
- `attributes_to_headers` (map from string to string, optional) — Mappage du nom de variable dynamique vers le nom d’en-tête pour attributes_to_headers
- `username` (string, optional, nullable) — Nom d’utilisateur du trunk SIP, s’il est disponible
- `has_outbound_trunk` (boolean, optional, default: false) — Indique si un trunk SIP sortant LiveKit est configuré
- `enabled_codecs` (list of enum, optional) — Codecs multimédias proposés dans le SDP pour les appels sortants. Si vide, tous les codecs pris en charge sont proposés.
  - Allowed values: `G722/8000`, `PCMU/8000`, `PCMA/8000`

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "phone_numbers": [
    {
      "provider": "twilio",
      "label": "Customer Support",
      "phone_number": "+1234567890",
      "phone_number_id": "phone_123"
    }
  ],
  "next_cursor": "string",
  "has_more": false
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/v2/phone-numbers"

response = requests.get(url)

print(response.json())
```

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

	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/v2/phone-numbers")

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/v2/phone-numbers")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/v2/phone-numbers');

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

```csharp
using RestSharp;

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