Obtener detalles de la plantilla
Dirección de la llamada
GET https://otp.api.engagelab.cc/v1/template-configs/{templateId}
Autenticación de llamadas
Consulte Autenticación de llamadas para saber cómo autenticar la API.
Solicitud
Parámetros de la solicitud
El {templateId} de la URL representa el ID de la plantilla que se va a obtener; dicho ID lo define el propio llamante al usar la interfaz de creación de plantillas.
Ejemplo de solicitud
Encabezados de la solicitud
GET /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/template-configs/{templateId} HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Este bloque de código se muestra en una ventana flotante
Cuerpo de la solicitud
Ninguno
Respuesta
Parámetros de la respuesta
Devuelve un objeto JSON con la información de configuración detallada de la plantilla.
Ejemplo de respuesta
Respuesta exitosa
{
"template_id": "test-template-1", // ID de plantilla personalizado, único dentro de la aplicación
"description": "Plantilla de prueba 1", // Descripción de esta plantilla
"send_channel_strategy": "whatsapp|sms", // Estrategia de envío de la plantilla; admite whatsapp/sms/voice/email; una estrategia combinada usa el carácter | para indicar el reenvío en caso de fallo
"brand_name": "Nombre de marca", // Nombre de marca; se usa como firma en el contenido de las plantillas de algunos países o regiones (por ejemplo, en el canal SMS algunos países o regiones exigen registrar una firma)
"verify_code_config": { // Configuración del código de verificación; sirve para configurar el código de verificación generado automáticamente; se devuelve cuando la plantilla incluye el tipo de código de verificación
"verify_code_type": 1, // Tipo de código de verificación; rango de valores [1,7]
"verify_code_len": 6, // Longitud del código de verificación; rango de valores [4,10]
"verify_code_ttl": 1 // Periodo de validez del código de verificación; rango de valores [1,10]; cuando la estrategia incluye whatsapp el valor solo puede ser 1, 5 o 10
},
"whatsapp_config": { // Configuración de la estrategia de whatsapp; se devuelve cuando la estrategia de envío incluye whatsapp
"template_type": 1 // Tipo de plantilla de whatsapp; actualmente solo se admite la plantilla predeterminada, es decir, valor fijo 1
},
"sms_config": { // Configuración de la estrategia de sms; se devuelve cuando la estrategia de envío incluye sms
"template_type": 2, // Tipo de plantilla de sms; valores: 1-plantilla predeterminada/2-plantilla personalizada
"template_parts": 1, // Número estimado de fragmentos facturables de la plantilla de sms; si la plantilla es demasiado larga, el precio concreto = número de fragmentos facturables * precio unitario
"template_custom_config": { // Configuración de la plantilla personalizada de sms; válida cuando el tipo de plantilla de sms es la personalizada
"custom_sub_type": "authentication", // Tipo de plantilla personalizada; valores: authentication-código de verificación/marketing-marketing/utility-notificación
"custom_content": "xxx" // Contenido de la plantilla personalizada; si el subtipo es authentication (código de verificación) debe incluir la variable {{code}}
}
},
"voice_config": { // Configuración de la estrategia de voice; se devuelve cuando la estrategia de envío incluye voice
"template_type": 1 // Tipo de plantilla de voice; actualmente solo se admite la plantilla predeterminada, es decir, valor fijo 1
},
"email_config": { // Configuración de la estrategia de email; se devuelve cuando la estrategia de envío incluye email
"template_name": "Nombre de la plantilla de email", // Nombre de la plantilla de email
"template_custom_configs": [{ // Configuración de la plantilla personalizada de email; válida cuando el tipo de plantilla de email es la personalizada; tenga en cuenta que es un array de objetos, que se diferencian principalmente por language para configurar varias
"language": "default", // Idioma; default es el predeterminado; al enviar el mensaje se puede hacer coincidir distinto contenido de plantilla según el parámetro language
"pre_from_name": "test", // Nombre del remitente preestablecido
"pre_from_mail": "test@test.com", // Correo del remitente preestablecido
"pre_subject": "test", // Asunto del correo preestablecido
"template_content": "Contenido preestablecido de la plantilla de correo, obligatorio; variables personalizadas como {{self}}, el código de verificación es {{code}}", // Contenido del correo; admite HTML; las variables deben encerrarse entre dos llaves {{}}
"pre_param_map": { // Valores predeterminados de las variables del contenido del correo; es decir, si al enviar no se especifica el valor de una variable, se usa el valor predeterminado indicado a continuación para sustituirla; se declara como pares clave-valor
"self": "Este es el valor preestablecido de la variable self"
}
}]
},
"pwa_config": { // Configuración relacionada con pwa; solo se devuelve cuando existe configuración de pwa
"pwa_platform": "xx", // Plataforma pwa utilizada
"pwa_code": "xx" // code de la plataforma pwa utilizada
},
"created_time": 1234567890, // Hora de creación de esta plantilla, en formato de marca de tiempo, con precisión de segundos
"status": 1, // Estado de la plantilla; valores: 1-pendiente de revisión/2-aprobada/3-rechazada
"audit_remark": "xx" // Observación de la revisión; por lo general, cuando se rechaza la revisión, puede consultar este campo para ver el motivo del rechazo
}
{
"template_id": "test-template-1", // ID de plantilla personalizado, único dentro de la aplicación
"description": "Plantilla de prueba 1", // Descripción de esta plantilla
"send_channel_strategy": "whatsapp|sms", // Estrategia de envío de la plantilla; admite whatsapp/sms/voice/email; una estrategia combinada usa el carácter | para indicar el reenvío en caso de fallo
"brand_name": "Nombre de marca", // Nombre de marca; se usa como firma en el contenido de las plantillas de algunos países o regiones (por ejemplo, en el canal SMS algunos países o regiones exigen registrar una firma)
"verify_code_config": { // Configuración del código de verificación; sirve para configurar el código de verificación generado automáticamente; se devuelve cuando la plantilla incluye el tipo de código de verificación
"verify_code_type": 1, // Tipo de código de verificación; rango de valores [1,7]
"verify_code_len": 6, // Longitud del código de verificación; rango de valores [4,10]
"verify_code_ttl": 1 // Periodo de validez del código de verificación; rango de valores [1,10]; cuando la estrategia incluye whatsapp el valor solo puede ser 1, 5 o 10
},
"whatsapp_config": { // Configuración de la estrategia de whatsapp; se devuelve cuando la estrategia de envío incluye whatsapp
"template_type": 1 // Tipo de plantilla de whatsapp; actualmente solo se admite la plantilla predeterminada, es decir, valor fijo 1
},
"sms_config": { // Configuración de la estrategia de sms; se devuelve cuando la estrategia de envío incluye sms
"template_type": 2, // Tipo de plantilla de sms; valores: 1-plantilla predeterminada/2-plantilla personalizada
"template_parts": 1, // Número estimado de fragmentos facturables de la plantilla de sms; si la plantilla es demasiado larga, el precio concreto = número de fragmentos facturables * precio unitario
"template_custom_config": { // Configuración de la plantilla personalizada de sms; válida cuando el tipo de plantilla de sms es la personalizada
"custom_sub_type": "authentication", // Tipo de plantilla personalizada; valores: authentication-código de verificación/marketing-marketing/utility-notificación
"custom_content": "xxx" // Contenido de la plantilla personalizada; si el subtipo es authentication (código de verificación) debe incluir la variable {{code}}
}
},
"voice_config": { // Configuración de la estrategia de voice; se devuelve cuando la estrategia de envío incluye voice
"template_type": 1 // Tipo de plantilla de voice; actualmente solo se admite la plantilla predeterminada, es decir, valor fijo 1
},
"email_config": { // Configuración de la estrategia de email; se devuelve cuando la estrategia de envío incluye email
"template_name": "Nombre de la plantilla de email", // Nombre de la plantilla de email
"template_custom_configs": [{ // Configuración de la plantilla personalizada de email; válida cuando el tipo de plantilla de email es la personalizada; tenga en cuenta que es un array de objetos, que se diferencian principalmente por language para configurar varias
"language": "default", // Idioma; default es el predeterminado; al enviar el mensaje se puede hacer coincidir distinto contenido de plantilla según el parámetro language
"pre_from_name": "test", // Nombre del remitente preestablecido
"pre_from_mail": "test@test.com", // Correo del remitente preestablecido
"pre_subject": "test", // Asunto del correo preestablecido
"template_content": "Contenido preestablecido de la plantilla de correo, obligatorio; variables personalizadas como {{self}}, el código de verificación es {{code}}", // Contenido del correo; admite HTML; las variables deben encerrarse entre dos llaves {{}}
"pre_param_map": { // Valores predeterminados de las variables del contenido del correo; es decir, si al enviar no se especifica el valor de una variable, se usa el valor predeterminado indicado a continuación para sustituirla; se declara como pares clave-valor
"self": "Este es el valor preestablecido de la variable self"
}
}]
},
"pwa_config": { // Configuración relacionada con pwa; solo se devuelve cuando existe configuración de pwa
"pwa_platform": "xx", // Plataforma pwa utilizada
"pwa_code": "xx" // code de la plataforma pwa utilizada
},
"created_time": 1234567890, // Hora de creación de esta plantilla, en formato de marca de tiempo, con precisión de segundos
"status": 1, // Estado de la plantilla; valores: 1-pendiente de revisión/2-aprobada/3-rechazada
"audit_remark": "xx" // Observación de la revisión; por lo general, cuando se rechaza la revisión, puede consultar este campo para ver el motivo del rechazo
}
Este bloque de código se muestra en una ventana flotante
Respuesta de error
{
"code": 4001,
"message": "config not exist"
}
{
"code": 4001,
"message": "config not exist"
}
Este bloque de código se muestra en una ventana flotante
Códigos de error
| Código de error | http code | Descripción |
|---|---|---|
| 1000 | 500 | Error interno |
| 2001 | 401 | Error de autenticación; no se incluyó un token correcto |
| 2002 | 401 | Error de autenticación; el token ha expirado o ha sido deshabilitado |
| 2004 | 403 | Sin permiso para llamar a esta API |
| 4001 | 400 | La plantilla no existe |










