Plantillas y mensajes
Cómo se arma el texto que recibe el usuario en la verificación OTP y en las llamadas de voz.
Mensajes OTP
El endpoint POST /v2/otp arma el texto del código según el canal:
| Canal | Texto |
|---|---|
sms / voice | Tu message personalizado, o el texto default si no envías uno. |
whatsapp | Plantilla oficial fija de WhatsApp (no personalizable). |
El texto default es:
{{code}} es tu codigo de verificacion de {{company}}. No lo compartas.
Dos variables se reemplazan automáticamente:
| Variable | Se reemplaza por |
|---|---|
{{company}} | El valor que mandas en el parámetro company. |
{{code}} | El código de verificación generado. |
Mensaje personalizado
Envía tu propio texto en el parámetro message. Reglas:
- Debe incluir ambos placeholders:
{{code}}y{{company}}. - Solo caracteres del alfabeto GSM-7 (el estándar de SMS): sin emojis y evitando símbolos poco comunes.
- Máximo 160 caracteres ya con el código y la empresa sustituidos (un SMS de una sola parte).
Si el mensaje incumple una regla, la API responde 400 con error: otp_message_invalid y el detalle exacto en hint (qué placeholder falta, qué caracteres no son válidos o por cuántos caracteres te pasaste).
{
"phone_number": "5512345678",
"country_code": "52",
"company": "Mi Empresa",
"message": "{{code}} es tu clave de acceso a {{company}}. Expira en 10 minutos."
}
¿Vienes de la API anterior? El parámetro template (letras a–n) y formal_tone ya no existen en v2: el texto default cubre el caso general y message cubre cualquier personalización. Consulta la tabla de migración.
Plantillas de voz
Aplican a /voice/send (llamadas de voz independientes del flujo OTP). El parámetro template acepta una letra de la a a la k. Cada guion se reproduce con voz durante la llamada.
| Letra | Tipo | Guion |
|---|---|---|
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 de voz es especial: con ella defines un mensaje propio en voice_message (máximo 160 caracteres). Las demás (a–j) usan guiones fijos.