Skip to main content
Cada alcance desbloquea un tipo de operación de número virtual. Conceda solo lo que su integración necesita.

​
Cómo enviar la clave

Recomendado
Alternativo
Cada clave API pertenece a un espacio de trabajo. No puede acceder a otro espacio de trabajo con la misma clave.

​
Combinaciones comunes

Solo consultar

phone_numbers:read

Consultar y configurar

phone_numbers:read, phone_numbers:update

Solo configurar entrante

phone_numbers:update

Flujo completo

phone_numbers:read, phone_numbers:update, phone_numbers:create, phone_numbers:delete
Lista de alcances vacía al crear = acceso ADMIN (todo). En producción, restrija siempre.
Contratar vía API: POST /v1/phone-numbers/orders con alcance phone_numbers:create (PIX o tarjeta). Perfil regulatório, carga y envío de documentos también vía API.

​
Alcances disponibles

  • Listar números contratados del espacio de trabajo (GET /v1/phone-numbers)
  • Obtener un número por id (GET /v1/phone-numbers/:id)
  • Buscar números disponibles (GET /v1/phone-numbers/available)
  • Config y precio (GET /v1/phone-numbers/config)
  • Detalle del pedido (GET /v1/phone-numbers/orders/:orderId)
Actualizar configuración de un número (PATCH /v1/phone-numbers/:id): etiqueta, acción de voz entrante (inboundVoiceAction), desvío, TTS, grabación, etc.
Crear pedido (POST /v1/phone-numbers/orders), perfil regulatório, carga/envío de documentos, selección de número sustituto.
Liberar número (DELETE /v1/phone-numbers/:id) — soft-delete con RELEASED en el proveedor.

​
Relación con la API de Voz

Para iniciar llamadas con el número, use alcances de voz (voice:call, voice:read, …). Los alcances de esta página aplican solo a /v1/phone-numbers.

​
Errores de autenticación

Verifique Authorization: Bearer sk_... y que la clave no se haya eliminado en el panel.
Confirme que la clave tiene phone_numbers:read, phone_numbers:update, phone_numbers:create o phone_numbers:delete según la ruta.

​
Próximos pasos