Skip to main content
POST
Provision a Phone Number
Notas de seguridad y comportamiento
  • El límite del cliente es un número incluido más los cupos pagados, con una excepción superior para operaciones.
  • Adquirir un número del operador externo puede iniciar facturación recurrente del proveedor.
  • Si se omite phone_number y el pool está vacío, la compra posterior no recibe un número específico y ninguna prueba define un fallback exitoso.
  • La mutación devuelve un registro amplio del proveedor que puede incluir columnas internas y no tiene una proyección pública estable.
  • No envíes sms_workflow_id. La solicitud publicada lo omite de forma intencional porque el runtime no valida ese campo por tenant.
  • La asignación predeterminada efectiva es un número incluido más los cupos adicionales pagados; no asumas un valor predeterminado de tres.

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json
country_code
string
requerido

Required; uppercased downstream. The handler does not enforce two-letter ISO syntax.

Minimum string length: 1
phone_number
string | null

Specific number to buy/claim. Omit to attempt an atomic pool claim.

workflow_id
string<uuid> | null

Owned workflow to bind for voice. Empty/non-string becomes client scope.

label
string

Provider-friendly label; downstream truncates to 64 characters.

Maximum string length: 64
sms_enabled
boolean
predeterminado:false

Only literal true requests SMS. Safe creation may leave SMS unbound.

Respuesta

Successful response.

success
enum<boolean>
requerido
Opciones disponibles:
true
number
object
requerido

Full retell_phone_numbers row returned by INSERT/UPDATE RETURNING *. This is not a stable public projection.

Última modificación el 8 de septiembre de 2026