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

# Lista telefonnummersida

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

Hämta en sida med telefonnummer

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) — Antal telefonnummer per sida
- `search` (string, optional, nullable) — Filtrera efter telefonnummer-ID, etikett eller telefonnummer. Ett telefonnummer-ID måste matcha exakt. Matchning av etikett och telefonnummer är en delsträng utan hänsyn till versaler eller gemener.
- `label` (string, optional, nullable) — Filtrera efter etikett. Matchningen är en delsträng utan hänsyn till versaler eller gemener.
- `phone_number` (string, optional, nullable) — Filtrera efter telefonnummer
- `provider` (enum, optional, nullable) — Filtrera efter telefonileverantör
  - Allowed values: `twilio`, `sip_trunk`, `exotel`
- `supports_outbound` (boolean, optional, nullable) — Filtrera efter om telefonnumret kan ringa utgående samtal
- `agent_id` (string, optional, nullable) — Filtrera efter tilldelat agent-ID
- `branch_id` (string, optional, nullable) — Filtrera efter tilldelat gren-ID
- `sort_by` (enum, optional, nullable) — Fältet att sortera resultaten efter
  - Allowed values: `label`, `phone_number`
- `sort_direction` (enum, optional) — Riktningen för att sortera resultaten
  - Allowed values: `asc`, `desc`
- `cursor` (string, optional, nullable) — Används för att hämta nästa sida. Markören returneras i svaret.

## Response

### 200

Lyckat svar

- `phone_numbers` (list of GetPhoneNumbersPageResponseModelPhoneNumbersItems, required) — Telefonnumren på den här sidan
- `next_cursor` (string, optional, nullable) — Skicka det här värdet som `cursor` för att hämta nästa sida. Null när det inte finns fler resultat.
- `has_more` (boolean, optional, default: false) — Om det finns fler tillgängliga resultat

## Errors

### 422 Unprocessable Entity Error

Valideringsfel

- `detail` (list of ValidationError, optional)

## Types

### GetPhoneNumbersPageResponseModelPhoneNumbersItems

- `provider`: `exotel` (GetPhoneNumberExotelResponseModel)
  - `label` (string, required) — Etikett för telefonnumret
  - `phone_number` (string, required) — Telefonnummer
  - `phone_number_id` (string, required) — ID:t för telefonnumret
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agenten som är tilldelad telefonnumret
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder inkommande samtal
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder utgående samtal
- `provider`: `sip_trunk` (GetPhoneNumberSIPTrunkResponseModel)
  - `label` (string, required) — Etikett för telefonnumret
  - `livekit_stack` (enum, required, default: standard) — Typ av Livekit-stack som används för det här numret.
    - Allowed values: `standard`, `static`
  - `phone_number` (string, required) — Telefonnummer
  - `phone_number_id` (string, required) — ID:t för telefonnumret
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agenten som är tilldelad telefonnumret
  - `inbound_trunk` (GetPhoneNumberInboundSIPTrunkConfigResponseModel, optional, nullable) — Konfiguration av inkommande SIP-trunk, om den är konfigurerad.
  - `outbound_trunk` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable) — Konfiguration av utgående SIP-trunk, om den är konfigurerad.
  - `store_sip_messages` (boolean, optional, default: true) — Om SIP-meddelanden för det här telefonnumret ska lagras.
  - `provider_config` (GetPhoneNumberOutboundSIPTrunkConfigResponseModel, optional, nullable, deprecated) — Konfigurationsuppgifter för SIP Trunk för ett telefonnummer
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder inkommande samtal
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder utgående samtal
- `provider`: `twilio` (GetPhoneNumberTwilioResponseModel)
  - `label` (string, required) — Etikett för telefonnumret
  - `phone_number` (string, required) — Telefonnummer
  - `phone_number_id` (string, required) — ID:t för telefonnumret
  - `assigned_agent` (PhoneNumberAgentInfo, optional, nullable) — Agenten som är tilldelad telefonnumret
  - `supports_inbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder inkommande samtal
  - `supports_outbound` (boolean, optional, default: true, deprecated) — Det här fältet är inaktuellt och kommer att tas bort i framtiden. Anger om det här telefonnumret stöder utgående samtal

### ValidationError

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

### PhoneNumberAgentInfo

- `agent_id` (string, required) — Agentens ID
- `agent_name` (string, required) — Agentens namn
- `environment` (string, optional, nullable) — Miljö att använda för att lösa miljövariabler vid samtal till detta nummer.
- `branch_id` (string, optional, nullable) — Agentgren som ska användas för samtal till det här numret.

### GetPhoneNumberInboundSIPTrunkConfigResponseModel

- `allowed_addresses` (list of string, required) — Lista över IP-adresser som får använda trunken. Varje objekt i listan kan vara en enskild IP-adress eller en Classless Inter-Domain Routing-notation som representerar ett CIDR-block.
- `allowed_numbers` (list of string, required, nullable) — Lista över telefonnummer som får använda trunken.
- `media_encryption` (enum, required, default: allowed)
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Om autentiseringsuppgifter är konfigurerade
- `username` (string, optional, nullable) — Användarnamn för SIP trunk (om tillgängligt)
- `remote_domains` (list of string, optional, nullable) — Domäner för fjärranslutna SIP-servrar som används för att validera TLS-certifikat.
- `attributes_to_headers` (map from string to string, optional) — Mappning av dynamiska variabelnamn till rubriknamn för attributes_to_headers

### GetPhoneNumberOutboundSIPTrunkConfigResponseModel

Konfigurationsuppgifter för SIP Trunk för ett telefonnummer

- `address` (string, required) — Värdnamn eller IP-adress som SIP INVITE skickas till
- `transport` (enum, required, default: auto) — Protokoll att använda för SIP-transport
  - Allowed values: `auto`, `udp`, `tcp`, `tls`
- `media_encryption` (enum, required, default: allowed) — Om media ska krypteras (datalager).
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Om autentiseringsuppgifter är konfigurerade
- `headers` (map from string to string, optional) — SIP-rubriker för INVITE-begäran
- `attributes_to_headers` (map from string to string, optional) — Mappning av dynamiska variabelnamn till rubriknamn för attributes_to_headers
- `username` (string, optional, nullable) — Användarnamn för SIP trunk (om tillgängligt)
- `has_outbound_trunk` (boolean, optional, default: false) — Om en utgående LiveKit SIP-trunk är konfigurerad
- `enabled_codecs` (list of enum, optional) — Mediekodekar som erbjuds i SDP för utgående samtal. Om fältet är tomt erbjuds alla kodekar som stöds.
  - 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()
```