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

# Listar página de números de teléfono

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

Obtiene una página de números de teléfono

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) — Número de números de teléfono por página
- `search` (string, optional, nullable) — Filtra por ID de número de teléfono, etiqueta o número de teléfono. El ID del número de teléfono debe coincidir exactamente; la coincidencia de etiqueta y número de teléfono es una subcadena sin distinción entre mayúsculas y minúsculas.
- `label` (string, optional, nullable) — Filtra por etiqueta. La coincidencia se realiza con una subcadena sin distinguir entre mayúsculas y minúsculas.
- `phone_number` (string, optional, nullable) — Filtra por número de teléfono
- `provider` (enum, optional, nullable) — Filtra por proveedor de telefonía
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `supports_outbound` (boolean, optional, nullable) — Filtra según si el número de teléfono puede realizar llamadas salientes
- `agent_id` (string, optional, nullable) — Filtra por ID de agente asignado
- `branch_id` (string, optional, nullable) — Filtra por ID de rama asignada
- `sort_by` (enum, optional, nullable) — El campo por el que se ordenarán los resultados
  - Allowed values: `label`, `phone_number`
- `sort_direction` (enum, optional) — La dirección para ordenar los resultados
  - Allowed values: `asc`, `desc`
- `cursor` (string, optional, nullable) — Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

## Response

### 200

Respuesta correcta.

- `phone_numbers` (list of GetPhoneNumbersPageResponseModelPhoneNumbersItems, required) — Los números de teléfono de esta página
- `next_cursor` (string, optional, nullable) — Pasa este valor como `cursor` para obtener la página siguiente. Null cuando no hay más resultados.
- `has_more` (boolean, optional, default: false) — Indica si hay más resultados disponibles

## Errors

### 422 Unprocessable Entity Error

Error de validación

- `detail` (list of ValidationError, optional)

## Types

### GetPhoneNumbersPageResponseModelPhoneNumbersItems

- `provider`: `exotel` (GetPhoneNumberExotelResponseModel)
  - `label` (string, required) — Etiqueta del número de teléfono
  - `phone_number` (string, required) — Número de teléfono
  - `phone_number_id` (string, required) — El ID del número de teléfono
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — El agente asignado al número de teléfono.
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas entrantes.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas salientes.
- `provider`: `sip_trunk` (GetPhoneNumberSIPTrunkResponseModel)
  - `label` (string, required) — Etiqueta del número de teléfono
  - `livekit_stack` (enum, required, default: standard) — Tipo de pila de Livekit utilizada para este número.
    - Allowed values: `standard`, `static`
  - `phone_number` (string, required) — Número de teléfono
  - `phone_number_id` (string, required) — El ID del número de teléfono
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — El agente asignado al número de teléfono.
  - `inbound_trunk` (GetPhoneNumberInboundSIPTrunkConfigResponseModel, optional, nullable) — Configuración del troncal SIP entrante, si está configurado.
  - `outbound_trunk` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable) — Configuración del troncal SIP saliente, si está configurado.
  - `store_sip_messages` (boolean, optional, default: true) — Si se almacenan los mensajes SIP de este número de teléfono.
  - `provider_config` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable, deprecated) — Detalles de configuración del troncal SIP para un número de teléfono
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas entrantes.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas salientes.
- `provider`: `twilio` (GetPhoneNumberTwilioResponseModel)
  - `label` (string, required) — Etiqueta del número de teléfono
  - `phone_number` (string, required) — Número de teléfono
  - `phone_number_id` (string, required) — El ID del número de teléfono
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — El agente asignado al número de teléfono.
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas entrantes.
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto y se eliminará en el futuro. Indica si este número de teléfono admite llamadas salientes.

### ValidationError

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

### PhoneNumberAgentInfo

- `agent_id` (string, required) — El ID del agente
- `agent_name` (string, required) — El nombre del agente
- `environment` (string, optional, nullable) — Entorno que se utilizará para resolver las variables de entorno en las llamadas a este número.
- `branch_id` (string, optional, nullable) — Rama del agente que se usará para las llamadas a este número.

### GetPhoneNumberInboundSIPTrunkConfigResponseModel

- `allowed_addresses` (list of string, required) — Lista de direcciones IP autorizadas para utilizar el troncal. Cada elemento de la lista puede ser una dirección IP individual o una notación de enrutamiento entre dominios sin clases que represente un bloque CIDR.
- `allowed_numbers` (list of string, required, nullable) — Lista de números de teléfono autorizados para utilizar el troncal.
- `media_encryption` (enum, required, default: allowed)
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Indica si se han configurado credenciales de autenticación.
- `username` (string, optional, nullable) — Nombre de usuario del troncal SIP (si está disponible)
- `remote_domains` (list of string, optional, nullable) — Dominios de servidores SIP remotos utilizados para validar certificados TLS.
- `attributes_to_headers` (map from string to string, optional) — Mapa del nombre de variable dinámica al nombre de encabezado para attributes_to_headers

### GetPhoneNumberOutboundSIPTrunkConfigResponseModel

Detalles de configuración del troncal SIP para un número de teléfono

- `address` (string, required) — Nombre de host o IP a la que se envía el SIP INVITE.
- `transport` (enum, required, default: auto) — Protocolo que se usará para el transporte SIP
  - Allowed values: `auto`, `udp`, `tcp`, `tls`
- `media_encryption` (enum, required, default: allowed) — Indica si se deben cifrar los archivos multimedia (capa de datos).
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Indica si se han configurado credenciales de autenticación.
- `headers` (map from string to string, optional) — Cabeceras SIP para la solicitud INVITE
- `attributes_to_headers` (map from string to string, optional) — Mapa del nombre de variable dinámica al nombre de encabezado para attributes_to_headers
- `username` (string, optional, nullable) — Nombre de usuario del troncal SIP (si está disponible)
- `has_outbound_trunk` (boolean, optional, default: false) — Indica si hay configurado un troncal SIP saliente de LiveKit.
- `enabled_codecs` (list of enum, optional) — Códecs multimedia que se ofrecen en el SDP para llamadas salientes. Si está vacío, se ofrecen todos los códecs compatibles.
  - Allowed values: `G722/8000`, `PCMU/8000`, `PCMA/8000`

### ValidationErrorLocItems

## 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()
```