Skip to main content
Cada escopo libera um tipo de operação em números virtuais. Use só o que sua integração precisa.

​
Como enviar a chave

Recomendado
Alternativo
A API Key pertence a um workspace. Você não acessa outro workspace com a mesma chave.

​
Combinações comuns

Só consultar

phone_numbers:read

Consultar e configurar

phone_numbers:read, phone_numbers:update

Só configurar entrada

phone_numbers:update

Fluxo completo

phone_numbers:read, phone_numbers:update
Lista de escopos vazia na criação = acesso ADMIN. Em produção, restrinja sempre.
Contratar (comprar) um número é pelo painel. A API consulta disponíveis, lista os do workspace e configura voz de entrada.

​
Escopos disponíveis

  • Listar números contratados do workspace (GET /v1/phone-numbers)
  • Consultar um número pelo id (GET /v1/phone-numbers/:id)
  • Buscar números disponíveis antes do checkout no painel (GET /v1/phone-numbers/available)
Atualizar configuração de um número (PATCH /v1/phone-numbers/:id): rótulo, ação de voz de entrada (inboundVoiceAction), encaminhamento, TTS, gravação, etc.

​
Relação com a Voice API

Para originar chamadas com o número, use escopos de Voz (voice:call, voice:read, …). Os escopos desta página valem apenas para /v1/phone-numbers.

​
Erros de autenticação

Confira Authorization: Bearer sk_... e se a chave não foi apagada no painel.
Verifique se a chave tem phone_numbers:read ou phone_numbers:update conforme a rota.

​
Próximos passos