Skip to main content
As configurações de chamadas são uma seção dentro das Configurações do Número. Aqui detalhamos todos os campos disponíveis.

​
Campos da Resposta (GET)

A seção calling retornada pelo GET /api/phone-numbers/settings:

​
Campos Obrigatórios

CampoTipoValoresDescrição
statusstringNOT_SET, enabled, disabledStatus das chamadas
call_icon_visibilitystringNOT_SET, DEFAULT, DISABLE_ALLVisibilidade do ícone de chamada
callback_permission_statusstringNOT_SET, enabled, disabledStatus do callback de permissão

​
Campos Opcionais (aparecem quando calling está habilitado)

CampoTipoValoresDescrição
ip_addressesobject—Endereços IP usados para chamadas
ip_addresses.defaultstring[]—Lista de IPs padrão
srtp_key_exchange_protocolstringNOT_SET, DTLS, SDESProtocolo de troca de chaves SRTP

​
SIP (sip)

CampoTipoDescrição
sip.statusstringenabled ou disabled
sip.serversarrayLista de servidores SIP configurados
sip.servers[].app_idstringID da aplicação (obrigatório)
sip.servers[].hostnamestringHostname do servidor SIP (obrigatório)
sip.servers[].portintegerPorta do servidor (opcional)
sip.servers[].passwordstringSenha SIP — só retornada com include_sip_credentials=true

​
Vídeo (video)

CampoTipoDescrição
video.statusstringenabled ou disabled

​
Áudio (audio)

CampoTipoDescrição
audio.statusstringenabled ou disabled

​
Horários de Chamada (call_hours)

CampoTipoDescrição
call_hours.statusstringenabled ou disabled
call_hours.timezonestringTimezone (ex: America/Sao_Paulo)
call_hours.day_of_week_startstringDia de início da semana

​
Ícones de Chamada (call_icons)

CampoTipoDescrição
call_icons.restrict_to_user_countriesstring[]Países onde o ícone de chamada é exibido (códigos ISO)

​
Restrições (restrictions)

CampoTipoDescrição
restrictions.restrictionsarrayLista de restrições ativas
restrictions.restrictions[].typestringTipo da restrição
restrictions.restrictions[].expirationintegerTimestamp Unix de expiração

​
Campos para Atualização (POST)

Ao enviar POST /api/phone-numbers/settings com a seção calling:
​
calling.status
string
required
enabled ou disabled — habilita ou desabilita chamadas.
​
calling.call_icon_visibility
string
DEFAULT ou DISABLE_ALL — controla visibilidade do ícone de chamada.
​
calling.video
object
​
calling.sip
object
​
calling.srtp_key_exchange_protocol
string
Protocolo de troca de chaves SRTP: DTLS ou SDES.

​
Exemplos

​
Habilitar Chamadas com 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",
      "call_icon_visibility": "DEFAULT",
      "sip": {
        "status": "enabled"
      },
      "srtp_key_exchange_protocol": "DTLS"
    }
  }'

​
Desabilitar 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": "disabled"
    }
  }'

​
Obter Configurações com Credenciais SIP

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

​
Resposta (calling não configurado)

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

​
Resposta (calling habilitado com SIP)

{
  "calling": {
    "status": "enabled",
    "call_icon_visibility": "DEFAULT",
    "ip_addresses": {
      "default": ["157.240.0.1", "157.240.0.2"]
    },
    "callback_permission_status": "enabled",
    "srtp_key_exchange_protocol": "DTLS",
    "sip": {
      "status": "enabled",
      "servers": [
        {
          "app_id": "12345",
          "hostname": "sip.whatsapp.com",
          "port": 5060,
          "password": "sip_password_here"
        }
      ]
    },
    "video": {
      "status": "disabled"
    },
    "audio": {
      "status": "enabled"
    },
    "call_hours": {
      "status": "disabled"
    },
    "restrictions": {
      "restrictions": []
    }
  },
  "storage_configuration": {
    "status": "DEFAULT"
  }
}