Skip to main content
GET
/
phone-numbers
/
settings
Configurações do Número
curl --request GET \
  --url https://apis.vectalk.com.br/api/phone-numbers/settings \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.vectalk.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Requer token de instância associado ao número de telefone. O número é resolvido automaticamente pelo token — não é necessário informar o phone-number-id.

​
Obter Configurações

​
Parâmetros

​
Query

​
include_sip_credentials
boolean
default:"false"
Quando true, inclui as credenciais SIP (senha) na resposta. Requer permissões adicionais.

​
Exemplo de Requisição

curl --request GET \
  --url https://apis.vectalk.com.br/api/phone-numbers/settings \
  --header 'Authorization: Bearer {seu_token}'

​
Resposta

{
  "calling": {
    "status": "NOT_SET",
    "call_icon_visibility": "NOT_SET",
    "callback_permission_status": "NOT_SET"
  },
  "storage_configuration": {
    "status": "DEFAULT"
  }
}

​
Campos da Resposta

CampoTipoDescrição
callingobjectConfigurações de chamadas — veja Configurações de Chamadas para detalhes completos
payload_encryption.statusstringenabled ou disabled
payload_encryption.client_encryption_key_fingerprintstringFingerprint da chave (quando habilitado)
payload_encryption.cloud_encryption_keystringChave de criptografia da cloud (quando habilitado)
storage_configuration.statusstringDEFAULT ou IN_COUNTRY_STORAGE_ENABLED
storage_configuration.data_localization_regionstringRegião de armazenamento (quando in-country storage habilitado)
O campo password nos servidores SIP só é retornado quando include_sip_credentials=true.

​
Atualizar Configurações

POST /phone-numbers/settings Apenas uma seção de feature pode ser enviada por requisição.

​
Seções Disponíveis

SeçãoDescrição
callingConfigurações de chamadas (status, SIP, vídeo, ícone, SRTP) — veja detalhes
payload_encryptionCriptografia de payload
storage_configurationConfiguração de armazenamento de dados
user_identity_changeNotificações de mudança de identidade do usuário

​
Exemplos

​
Habilitar Chamadas

curl --request POST \
  --url https://apis.vectalk.com.br/api/phone-numbers/settings \
  --header 'Authorization: Bearer {seu_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "calling": {
      "status": "enabled",
      "call_icon_visibility": "DEFAULT"
    }
  }'

​
Habilitar SIP

curl --request POST \
  --url https://apis.vectalk.com.br/api/phone-numbers/settings \
  --header 'Authorization: Bearer {seu_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "calling": {
      "status": "enabled",
      "sip": {
        "status": "enabled"
      },
      "srtp_key_exchange_protocol": "DTLS"
    }
  }'

​
Habilitar Criptografia de Payload

curl --request POST \
  --url https://apis.vectalk.com.br/api/phone-numbers/settings \
  --header 'Authorization: Bearer {seu_token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "payload_encryption": {
      "status": "enabled",
      "client_encryption_key": "BASE64_ENCODED_PUBLIC_KEY"
    }
  }'

​
Resposta

{
  "success": true
}