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

# Atualizar número de telefone

PATCH https://api.elevenlabs.io/v1/convai/phone-numbers/{phone_number_id}
Content-Type: application/json

Atualiza o agente atribuído a um número de telefone

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

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

- `phone_number_id` (string, required) — O ID do número de telefone. Ele é retornado quando um número de telefone é importado.

### Body (application/json)

This endpoint expects an object.

- `agent_id` (string, optional)
- `label` (string, optional)
- `inbound_trunk_config` (InboundSipTrunkConfigRequestModel, optional)
- `outbound_trunk_config` (OutboundSipTrunkConfigRequestModel, optional)
- `livekit_stack` (enum, optional, default: standard)
  - Allowed values: `standard`, `static`
- `store_sip_messages` (boolean, optional)
- `environment` (string, optional) — Ambiente a ser usado para resolver variáveis de ambiente em chamadas para este número.
- `branch_id` (string, optional) — Ramificação do agente a ser usada nas chamadas para este número.

## Response

### 200

Resposta bem-sucedida

- `PhoneNumbersUpdateResponse`
  - `provider`: `twilio`
    - `label` (string, required) — Rótulo do número de telefone
    - `phone_number` (string, required) — Número de telefone
    - `phone_number_id` (string, required) — O ID do número de telefone
    - `assigned_agent` (PhoneNumberAgentInfo, optional) — O agente atribuído ao número de telefone
    - `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`
    - `label` (string, required) — Rótulo do número de telefone
    - `phone_number` (string, required) — Número de telefone
    - `phone_number_id` (string, required) — O ID do número de telefone
    - `assigned_agent` (PhoneNumberAgentInfo, optional) — O agente atribuído ao número de telefone
    - `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
    - `livekit_stack` (enum, required, default: standard) — Tipo de stack do Livekit usado para este número.
      - Allowed values: `standard`, `static`
    - `phone_number` (string, required) — Número de telefone
    - `phone_number_id` (string, required) — O ID do número de telefone
    - `assigned_agent` (PhoneNumberAgentInfo, optional) — O agente atribuído ao número de telefone
    - `inbound_trunk` (GetPhoneNumberInboundSipTrunkConfigResponseModel, optional) — Configuração do tronco SIP de entrada, se configurado.
    - `outbound_trunk` (GetPhoneNumberOutboundSipTrunkConfigResponseModel, optional) — Configuração do tronco SIP de saída, se configurado.
    - `store_sip_messages` (boolean, optional, default: true) — Se deve armazenar mensagens SIP deste número de telefone.
    - `provider_config` (GetPhoneNumberOutboundSipTrunkConfigResponseModel, optional, deprecated) — Detalhes de configuração do tronco SIP para um número de telefone
    - `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

## Errors

### 422 Phone Numbers Update Request Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

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

### PhoneNumberAgentInfo

- `agent_id` (string, required) — O ID do agente
- `agent_name` (string, required) — O nome do agente
- `environment` (string, optional) — Ambiente a ser usado para resolver variáveis de ambiente em chamadas para este número.
- `branch_id` (string, optional) — Ramificação do agente a ser usada nas chamadas para este número.

### GetPhoneNumberInboundSipTrunkConfigResponseModel

- `allowed_addresses` (list of string, required) — 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.
- `media_encryption` (enum, required, default: allowed)
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Se as credenciais de autenticação estão configuradas.
- `allowed_numbers` (list of string, optional) — Lista de números de telefone autorizados a usar o tronco.
- `username` (string, optional) — Nome de usuário do tronco SIP (se disponível)
- `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

### GetPhoneNumberOutboundSipTrunkConfigResponseModel

Detalhes de configuração do tronco SIP para um número de telefone

- `address` (string, required) — Nome do host ou IP para o qual o SIP INVITE é enviado
- `transport` (enum, required, default: auto) — Protocolo a usar para transporte SIP
  - Allowed values: `auto`, `udp`, `tcp`, `tls`
- `media_encryption` (enum, required, default: allowed) — Se a mídia deve ser criptografada (camada de dados).
  - Allowed values: `disabled`, `allowed`, `required`
- `has_auth_credentials` (boolean, required) — Se as credenciais de autenticação estão configuradas.
- `headers` (map from string to string, optional) — Cabeçalhos SIP para solicitação INVITE
- `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
- `username` (string, optional) — Nome de usuário do tronco SIP (se disponível)
- `has_outbound_trunk` (boolean, optional, default: false) — Se um tronco SIP de saída do LiveKit está configurado.
- `enabled_codecs` (list of enum, optional) — Codecs de mídia 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
{}
```

**Response**

```json
{
  "provider": "twilio",
  "label": "Customer Support",
  "phone_number": "+1234567890",
  "phone_number_id": "phone_123",
  "assigned_agent": {
    "agent_id": "F3Pbu5gP6NNKBscdCdwB",
    "agent_name": "My Agent",
    "environment": "environment",
    "branch_id": "branch_id"
  }
}
```

**SDK Code**

```python
import requests

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

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/phone-numbers/TeaqRRdTcIfIu2i7BYfT';
const options = {method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{}'};

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/TeaqRRdTcIfIu2i7BYfT"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", 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/TeaqRRdTcIfIu2i7BYfT")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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.patch("https://api.elevenlabs.io/v1/convai/phone-numbers/TeaqRRdTcIfIu2i7BYfT")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.elevenlabs.io/v1/convai/phone-numbers/TeaqRRdTcIfIu2i7BYfT', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/phone-numbers/TeaqRRdTcIfIu2i7BYfT");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/phone-numbers/TeaqRRdTcIfIu2i7BYfT")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```