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

# Importar número de telefone

POST https://api.elevenlabs.io/v1/convai/phone-numbers
Content-Type: application/json

Importar número de telefone da configuração do provedor (Twilio, Exotel ou tronco SIP)

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/phone-numbers/create

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

### Body (application/json)

This endpoint expects a PhoneNumbersCreateRequestBody.

- `PhoneNumbersCreateRequestBody`
  - `provider`: `twilio`
    - `label` (string, required) — Rótulo do número de telefone
    - `phone_number` (string, required) — Número de telefone
    - `sid` (string, required) — SID da conta Twilio (começa com `AC`) ou SID da chave de API (começa com `SK`)
    - `token` (string, required) — Segredo associado a `sid`: o token de autenticação da conta para um SID de conta ou o segredo da chave de API para um SID de chave de API
    - `account_auth_token` (string, optional) — Token de autenticação da conta Twilio, necessário para importações de chaves de API validarem assinaturas de webhook de entrada
    - `agent_id` (string, optional) — ID do agente ao qual atribuir o número de telefone
    - `enable_sms` (boolean, optional, default: true) — Encaminhe SMS recebidos para a ElevenLabs. Ativado por padrão; defina como false para ignorar a configuração de SMS em números que não oferecem suporte.
    - `region_config` (RegionConfigRequest, optional) — Configuração de região adicional do Twilio
    - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas recebidas
    - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas efetuadas
  - `provider`: `exotel`
    - `account_sid` (string, required) — SID da conta Exotel
    - `api_key` (string, required) — Chave de API da Exotel
    - `api_subdomain` (enum, required) — Host da API Exotel específico da região
      - Allowed values: `api.in.exotel.com`, `api.exotel.com`
    - `api_token` (string, required) — Token de API da Exotel
    - `app_id` (string, required) — Identificador do applet Exotel usado em Calls/connect
    - `label` (string, required) — Rótulo do número de telefone
    - `phone_number` (string, required) — Número de telefone
    - `agent_id` (string, optional) — ID do agente ao qual atribuir o número de telefone
    - `applet_url` (string, optional) — Substituição opcional da URL completa do applet. O padrão é a URL start_voice da Exotel derivada do SID da conta e do ID do app.
    - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas recebidas
    - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas efetuadas
  - `provider`: `sip_trunk`
    - `label` (string, required) — Rótulo do número de telefone
    - `phone_number` (string, required) — Número de telefone
    - `agent_id` (string, optional) — ID do agente ao qual atribuir o número de telefone
    - `inbound_trunk_config` (InboundSipTrunkConfigRequestModel, optional)
    - `outbound_trunk_config` (OutboundSipTrunkConfigRequestModel, optional)
    - `supports_inbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas recebidas
    - `supports_outbound` (boolean, optional, default: true, deprecated) — Este campo está obsoleto e será removido no futuro. Indica se este número de telefone aceita chamadas efetuadas

## Response

### 200

Resposta bem-sucedida

- `phone_number_id` (string, required) — ID da entidade de telefone

## Errors

### 422 Phone Numbers Create Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### RegionConfigRequest

- `region_id` (enum, required) — ID da região
  - Allowed values: `us1`, `ie1`, `au1`
- `token` (string, required) — Token de autenticação para esta região
- `edge_location` (enum, required) — Localização de edge para esta região
  - Allowed values: `ashburn`, `dublin`, `frankfurt`, `sao-paulo`, `singapore`, `sydney`, `tokyo`, `umatilla`, `roaming`

### InboundSipTrunkConfigRequestModel

- `allowed_addresses` (list of string, optional) — Lista de endereços IP autorizados a usar o tronco. Cada item da lista pode ser um endereço IP individual ou uma notação Classless Inter-Domain Routing que representa um bloco CIDR.
- `allowed_numbers` (list of string, optional) — Lista de números de telefone autorizados a usar o tronco.
- `media_encryption` (enum, optional, default: allowed) — Se a mídia deve ser criptografada (camada de dados).
  - Allowed values: `disabled`, `allowed`, `required`
- `credentials` (SipTrunkCredentialsRequestModel, optional) — Credenciais opcionais de autenticação digest (nome de usuário/senha).
- `remote_domains` (list of string, optional) — Domínios de servidores SIP remotos usados para validar certificados TLS.
- `attributes_to_headers` (map from string to string, optional) — Mapeamento do nome da variável dinâmica para o nome do cabeçalho em attributes_to_headers

### OutboundSipTrunkConfigRequestModel

- `address` (string, required) — Nome do host ou IP para o qual o SIP INVITE é enviado.
- `transport` (enum, optional, default: auto) — Protocolo a usar para transporte SIP (camada de sinalização).
  - Allowed values: `auto`, `udp`, `tcp`, `tls`
- `media_encryption` (enum, optional, default: allowed) — Se a mídia deve ser criptografada (camada de dados).
  - Allowed values: `disabled`, `allowed`, `required`
- `headers` (map from string to string, optional) — Cabeçalhos SIP X-* para solicitação INVITE. Esses cabeçalhos são enviados como estão e podem ajudar a identificar esta chamada.
- `attributes_to_headers` (map from string to string, optional) — Mapeamento do nome da variável dinâmica para o nome do cabeçalho em attributes_to_headers
- `credentials` (SipTrunkCredentialsRequestModel, optional) — Credenciais opcionais de autenticação digest (nome de usuário/senha). Se não forem fornecidas, a autenticação ACL será assumida.
- `enabled_codecs` (list of enum, optional) — Codecs de mídia que devem ser oferecidos no SDP para chamadas de saída. Se estiver vazio, todos os codecs compatíveis serão oferecidos.
  - Allowed values: `G722/8000`, `PCMU/8000`, `PCMA/8000`

### ValidationError

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

### SipTrunkCredentialsRequestModel

- `username` (string, required) — Nome de usuário do tronco SIP
- `password` (string, optional) — Senha do tronco SIP — se não for especificada, permanecerá inalterada

### ValidationErrorLocItem

## Examples

**Request**

```json
{
  "provider": "twilio",
  "label": "label",
  "phone_number": "phone_number",
  "sid": "sid",
  "token": "token"
}
```

**Response**

```json
{
  "phone_number_id": "phone_number_id"
}
```

**SDK Code**

```python
import requests

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

payload = {
    "provider": "twilio",
    "label": "label",
    "phone_number": "phone_number",
    "sid": "sid",
    "token": "token"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/phone-numbers';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"provider":"twilio","label":"label","phone_number":"phone_number","sid":"sid","token":"token"}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"provider\": \"twilio\",\n  \"label\": \"label\",\n  \"phone_number\": \"phone_number\",\n  \"sid\": \"sid\",\n  \"token\": \"token\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"twilio\",\n  \"label\": \"label\",\n  \"phone_number\": \"phone_number\",\n  \"sid\": \"sid\",\n  \"token\": \"token\"\n}"

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.post("https://api.elevenlabs.io/v1/convai/phone-numbers")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"twilio\",\n  \"label\": \"label\",\n  \"phone_number\": \"phone_number\",\n  \"sid\": \"sid\",\n  \"token\": \"token\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/convai/phone-numbers', [
  'body' => '{
  "provider": "twilio",
  "label": "label",
  "phone_number": "phone_number",
  "sid": "sid",
  "token": "token"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/phone-numbers");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"provider\": \"twilio\",\n  \"label\": \"label\",\n  \"phone_number\": \"phone_number\",\n  \"sid\": \"sid\",\n  \"token\": \"token\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "provider": "twilio",
  "label": "label",
  "phone_number": "phone_number",
  "sid": "sid",
  "token": "token"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/phone-numbers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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