Enviar Llamada de Voz

Realiza una llamada telefónica con mensaje de voz usando plantillas TTS (Text-to-Speech). Soporta GET y POST.

post/voice/send

Authorizations

apikeystringheaderrequired

Body

application/json

numbersstringrequired

Números de teléfono de los destinatarios, separados por coma. Ejemplo: `4771234567,4770987654`

country_codestringrequired

Código de país. Por estandarización, siempre se debe enviar `52` que es el código correspondiente a México.

templateenumrequired

Letra de la plantilla de voz a utilizar (a - k). Cada letra corresponde a un guion de voz pregrabado que se reproduce durante la llamada. Las variables `{{company}}` y `{{code}}` se reemplazan automáticamente. **Plantillas disponibles:** | Letra | Tipo de mensaje | |-------|----------------| | **a** | Verificación — "{{company}} tu código de verificación es: {{code}}" | | **b** | Validación de cuenta — "Ingresa el código en tu app de {{company}}: {{code}}" | | **c** | Activación — "El código {{code}} activa tu cuenta de {{company}}" | | **d** | Autenticación — "Código de autenticación para {{company}}: {{code}}" | | **e** | Activación alternativo — "Captura el código {{code}} para {{company}}" | | **f** | Código simple — "{{company}} tu código es: {{code}}" | | **g** | Confirmación — "Código de confirmación {{company}}: {{code}}" | | **h** | Verificación inverso — "{{code}} es tu código de {{company}}" | | **i** | Inicio de sesión — "{{code}} para iniciar sesión en {{company}}" | | **j** | Activación extendido — "Código de activación para {{company}}: {{code}}" | | **k** | Mensaje personalizado — Usa el parámetro `voice_message` para definir el texto (máx. 160 caracteres). | La plantilla **k** es especial: permite enviar un mensaje de voz completamente personalizado mediante el parámetro `voice_message`. El resto de plantillas (a-j) usan guiones fijos. Usa `formal_tone: true` para cambiar el trato de "tú" a "usted".

enum:abcdefghijk
sandboxenum

Modo de pruebas. `1` = sandbox (no descuenta créditos), `0` = producción. Por defecto `0`.

enum:01
companystring

Nombre de la compañía para personalizar el mensaje de voz.

codestring

Código de verificación a comunicar en la llamada.

voice_messagestring

Mensaje de voz personalizado (máximo 160 caracteres). Solo compatible con la plantilla `k`.

formal_toneboolean

Define el trato gramatical del mensaje. `false` = trato informal (tú). `true` = trato formal (usted). Por defecto `false`.

Response

200Llamada realizada exitosamente
successboolean
messagestring

Mensaje de estado

statusinteger
codestring

Código de respuesta

total_messagesinteger

Número de mensajes enviados

referencesarray<object>

IDs de referencia de los mensajes

▸ Show array item attributes▾ Hide array item attributes
referencestring

ID único de referencia del mensaje

numberstring

Número de teléfono del destinatario

creditnumber

Créditos consumidos

campaignIdinteger

ID de campaña (solo cuando showCampaignId=true)

400Error de validación o lógica de negocio
successboolean

Siempre `false` para respuestas de error

messagestring

Descripción del error en español

statusinteger

Código HTTP de la respuesta

codestring

Código de error estructurado (`{dominio}_{número}`). Identifica de forma única la causa del error para manejo programático.

401No autorizado — API Key no provista, inválida o expirada
successboolean

Siempre `false`

messagestring

Descripción del error de autenticación en español

statusinteger

Código HTTP

codestring

Código de error de autenticación (`auth_01`, `auth_05`, `auth_06`, `auth_07`, `auth_99`)

403Prohibido — La dirección IP no está autorizada para acceder (IP whitelist)
successboolean

Siempre `false`

messagestring

Descripción del error

statusinteger

Código HTTP

codestring

Código de error: `auth_04` (IP no autorizada en whitelist)

429Demasiadas peticiones — Límite de rate limit excedido (100 mensajes/segundo producción, 100/día sandbox)
successboolean

Siempre `false`

messagestring

Descripción del error

statusinteger

Código HTTP

codestring

Código de error de rate limit

500Error interno del servidor
successboolean

Siempre `false`

messagestring

Descripción del error

statusinteger

Código HTTP

codestring

Código de error interno

request_idstring· uuid

Identificador único de la petición. Inclúyelo al contactar a soporte.