Enviar Llamada de Voz
Realiza una llamada telefónica con mensaje de voz usando plantillas TTS (Text-to-Speech).
post
/voice/sendConvierte una plantilla en una llamada de voz TTS. template selecciona el guion, company inserta el nombre de tu organización y code es el valor que se lee por voz: se dicta carácter por carácter, acepta letras y números, y debe tener entre 4 y 11 caracteres.
La plantilla k es la personalizada: requiere voice_message (máximo 160 caracteres; los caracteres fuera de letras, números, comas, puntos y espacios se eliminan automáticamente).
El catálogo de guiones de voz está en Plantillas de mensaje.
Cuerpo de la petición
application/json
numbersstringrequerido
Números de teléfono de los destinatarios, separados por coma. Ejemplo:
4771234567,4770987654country_codestringrequerido
Código de país. Por estandarización, siempre se debe enviar
52, que es el código correspondiente a México.templateenumrequerido
Letra de la plantilla de voz (de la
a a la k). Cada letra es un guion pregrabado que se reproduce durante la llamada; las variables company y code se rellenan solas. La plantilla k permite un mensaje propio con el parámetro voice_message. Consulta el guion de cada plantilla en Plantillas de mensaje.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, de 4 a 11 caracteres. Acepta letras y números; se dicta carácter por carácter durante la llamada. No aplica con la plantilla
k.voice_messagestring
Mensaje de voz personalizado (máximo 160 caracteres). Solo compatible con la plantilla
k, donde es obligatorio. Los caracteres fuera de letras, números, comas, puntos y espacios se eliminan automáticamente.Respuesta
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
▸ Ver atributos del elemento▾ Ocultar atributos del elemento
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, 1000 envíos de prueba por día en 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.
Además de los errores globales de autenticación (auth_*, ver Errores y límites), este endpoint puede responder:
Códigos de error
| Código | Cuándo ocurre | Qué hacer |
|---|---|---|
error_02 | Cualquier validación fallida: número, país, plantilla, code (4–11 caracteres), voice_message ausente o de más de 160, company de más de 40. | El message indica el campo exacto; corrígelo y reintenta. |
error_03 | Error interno al procesar la llamada. | Reintenta; si persiste, contacta a soporte con el request_id. |