Obtener la lista de todas las plantillas
Actualmente esta interfaz no admite paginación y devuelve el contenido resumido de todas las plantillas. Se ha omitido principalmente el contenido detallado; si necesita obtener el contenido, utilice la interfaz de detalles.
Dirección de la llamada
GET https://otp.api.engagelab.cc/v1/template-configs
Autenticación de llamadas
Consulte Autenticación de llamadas para saber cómo autenticar la API.
Solicitud
Parámetros de la solicitud
Ninguno
Ejemplo de solicitud
Encabezados de la solicitud
GET /v1/template-configs HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/template-configs 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
Sin campos de envoltorio externos; devuelve directamente un array JSON.
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
},
"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
},
"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
},
"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
},
"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 |










