Template API Interface - Streamline Your Messaging Solution

              
              Authorization: Basic ${base64_auth_string}

            

              
              POST /v1/messages  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "template_id": "test-template-1",       // ID de plantilla personalizada, único dentro de la aplicación
    "description": "Test Template 1",       // Descripción de la plantilla
    "send_channel_strategy": "whatsapp|sms",    // Estrategia de entrega de la plantilla; admite cuatro tipos: whatsapp/sms/voice/email. Utilizar | para indicar la estrategia de reserva (fallback) en orden
    "brand_name": "Brand Name",             // Nombre de marca; se utiliza como firma en el contenido de la plantilla para algunos países/regiones (p. ej., obligatorio para canales SMS en determinados países/regiones)
    "verify_code_config": {                 // Configuración del código de verificación; obligatoria cuando la plantilla incluye tipo de código de verificación
        "verify_code_type": 1,              // Tipo de código de verificación, rango [1,7]
        "verify_code_len": 6,               // Longitud del código de verificación, rango [4,10]
        "verify_code_ttl": 1                // Periodo de validez del código de verificación, rango [1,10]. Nota: Cuando la estrategia incluye whatsapp, el valor solo puede ser 1, 5 o 10
    },
    "whatsapp_config": {                    // Configuración de la estrategia de WhatsApp; efectiva cuando la estrategia de entrega incluye WhatsApp
        "template_type": 1,                 // Tipo de plantilla de WhatsApp; actualmente solo admite la plantilla predeterminada, valor fijo 1
        "template_default_config": {        // Configuración de la plantilla predeterminada de WhatsApp; efectiva para el tipo de plantilla predeterminada
            "contain_security": false,      // Indica si se incluyen recordatorios de seguridad
            "contain_expire": false         // Indica si se incluye contenido de caducidad
        }
    },
    "sms_config": {                         // Configuración de la estrategia de SMS; efectiva cuando la estrategia de entrega incluye SMS
        "template_type": 2,                 // Tipo de plantilla SMS; valores: 1-Plantilla predeterminada/2-Plantilla personalizada
        "template_default_config": {        // Configuración de la plantilla predeterminada de SMS; efectiva para el tipo de plantilla predeterminada
            "contain_security": false,      // Indica si se incluyen recordatorios de seguridad
            "contain_expire": false         // Indica si se incluye contenido de caducidad
        },
        "template_custom_config": {         // Configuración de plantilla personalizada de SMS; efectiva para el tipo de plantilla 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 plantilla personalizada. Nota: Para el tipo authentication, debe incluir la variable {{code}}
            "custom_country_codes": "HK,PH"         // Países/regiones de destino para la plantilla personalizada; se utiliza como referencia durante la revisión de la plantilla. Completar según sea necesario; de lo contrario, puede afectar a la entrega
        }
    },
    "voice_config": {                       // Configuración de la estrategia de voz; efectiva cuando la estrategia de entrega incluye Voice
        "template_type": 1,                 // Tipo de plantilla de voz; actualmente solo admite la plantilla predeterminada, valor fijo 1
        "template_default_config": {        // Configuración de la plantilla predeterminada de voz; efectiva para el tipo de plantilla predeterminada
            "contain_security": false,      // Indica si se incluyen recordatorios de seguridad
            "contain_expire": false         // Indica si se incluye contenido de caducidad
        }
    },
    "email_config": {                       // Configuración de la estrategia de correo electrónico; efectiva cuando la estrategia de entrega incluye Email
        "template_name": "Email Template Name",     // Nombre de la plantilla de correo electrónico
        "template_custom_configs": [{       // Configuración de plantilla personalizada de correo electrónico; nota: es un array de objetos, que se diferencian principalmente por idioma
            "language": "default",          // Idioma; default es el predeterminado. El contenido de la plantilla se puede asociar según el parámetro language durante la entrega
            "pre_from_name": "test",        // Nombre del remitente predefinido
            "pre_from_mail": "test@test.com",   // Correo del remitente predefinido
            "pre_subject": "test",          // Asunto del correo predefinido
            "template_content": "Preset email template content, required. Custom variables like {{self}}, verification code is {{code}}",    // Contenido del correo electrónico; admite HTML. Las variables deben ir entre llaves dobles {{}}
            "pre_param_map": {              // Valores predeterminados para las variables del contenido del correo. Si durante el envío no se especifican valores, estos valores predeterminados reemplazarán las variables. Se declaran como pares clave-valor; los valores deben ser cadenas
                "self": "This is the preset value for the self variable"
            }
        }]
    },
    "pwa_config": {                         // Configuración relacionada con PWA; opcional
        "pwa_platform": "xx",               // Plataforma PWA utilizada. Para valores específicos, contactar con el soporte técnico
        "pwa_code": "xx"                    // Código utilizado en la plataforma PWA
    }
}

            

              
              {
    "code": 0,
    "message": "success"
}

            

              
              {
    "code": 3003,
    "message": "not contains any channel config"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              DELETE /v1/template-configs/{templateId}  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "code": 0,
    "message": "success"
}

            

              
              {
    "code": 4001,
    "message": "config not exist"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              [{
    "template_id": "test-template-1",       // ID de plantilla personalizada, único dentro de la aplicación
    "description": "Test Template 1",       // Descripción de la plantilla
    "send_channel_strategy": "whatsapp|sms",    // Estrategia de entrega de la plantilla; admite whatsapp/sms/voice/email. Las estrategias combinadas utilizan el carácter "|" para indicar la estrategia de reserva (fallback)
    "brand_name": "Brand Name",             // Nombre de marca; se utiliza como firma en el contenido de la plantilla para determinados países/regiones (p. ej., obligatorio para canales SMS en algunos países/regiones)
    "verify_code_config": {                 // Configuración de códigos de verificación; se devuelve cuando la plantilla incluye tipos de código de verificación
        "verify_code_type": 1,              // Tipo de código de verificación, rango [1,7]
        "verify_code_len": 6,               // Longitud del código de verificación, rango [4,10]
        "verify_code_ttl": 1                // Periodo de validez del código de verificación, rango [1,10]. Nota: 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 entrega incluye whatsapp
        "template_type": 1                  // Tipo de plantilla de Whatsapp; actualmente solo admite plantillas predeterminadas, valor fijo 1
    },
    "sms_config": {                         // Configuración de la estrategia de SMS; se devuelve cuando la estrategia de entrega incluye SMS
        "template_type": 2,                 // Tipo de plantilla SMS; valores: 1-plantilla predeterminada/2-plantilla personalizada
        "template_parts": 1                 // Partes de facturación estimadas para la plantilla SMS. Si la plantilla es demasiado larga, el precio específico = partes de facturación * precio unitario
    },
    "voice_config": {                       // Configuración de la estrategia de voz; se devuelve cuando la estrategia de entrega incluye voice
        "template_type": 1                  // Tipo de plantilla de voz; actualmente solo admite plantillas predeterminadas, valor fijo 1
    },
    "email_config": {                       // Configuración de la estrategia de correo electrónico; se devuelve cuando la estrategia de entrega incluye email
        "template_name": "Email Template Name" // Nombre de la plantilla de correo electrónico
    },
    "pwa_config": {                         // Configuración relacionada con PWA; se devuelve cuando existe configuración de PWA
        "pwa_platform": "xx",               // Plataforma PWA utilizada
        "pwa_code": "xx"                    // Código utilizado en la plataforma PWA
    },
    "created_time": 1234567890,             // Fecha/hora de creación de la plantilla, en formato timestamp, con precisión de segundos
    "status": 1,                            // Estado de la plantilla; valores: 1-Pendiente de revisión/2-Aprobada/3-Rechazada
    "audit_remark": "xx"                    // Observaciones de auditoría; se utilizan normalmente para ver motivos de rechazo cuando la revisión se rechaza
},...]

            

              
              {
    "code": 4001,
    "message": "config not exist"
}

            

              
              Authorization: Basic ${base64_auth_string}

            

              
              GET /v1/template-configs/custom-template-id  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

              
              {
    "template_id": "test-template-1",       // ID de plantilla personalizada, único dentro de la aplicación
    "description": "Test Template 1",       // Descripción de la plantilla
    "send_channel_strategy": "whatsapp|sms",    // Estrategia de entrega de la plantilla; admite whatsapp/sms/voice/email. Las estrategias combinadas utilizan el carácter "|" para indicar la estrategia de reserva (fallback)
    "brand_name": "Brand Name",             // Nombre de marca; se utiliza como firma en el contenido de la plantilla para determinados países/regiones (p. ej., obligatorio para canales SMS en algunos países/regiones)
    "verify_code_config": {                 // Configuración de códigos de verificación; se devuelve cuando la plantilla incluye tipos de código de verificación
        "verify_code_type": 1,              // Tipo de código de verificación, rango [1,7]
        "verify_code_len": 6,               // Longitud del código de verificación, rango [4,10]
        "verify_code_ttl": 1                // Periodo de validez del código de verificación, rango [1,10]. Nota: 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 entrega incluye whatsapp
        "template_type": 1                  // Tipo de plantilla de Whatsapp; actualmente solo admite plantillas predeterminadas, valor fijo 1
    },
    "sms_config": {                         // Configuración de la estrategia de SMS; se devuelve cuando la estrategia de entrega incluye SMS
        "template_type": 2,                 // Tipo de plantilla SMS; valores: 1-plantilla predeterminada/2-plantilla personalizada
        "template_parts": 1,                // Partes de facturación estimadas para la plantilla SMS. Si la plantilla es demasiado larga, el precio específico = partes de facturación * precio unitario
        "template_custom_config": {         // Configuración de plantilla SMS personalizada; válida cuando el tipo de plantilla SMS es 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 plantilla personalizada. Nota: Si el subtipo es authentication (Código de verificación), debe incluir la variable {{code}}
        }
    },
    "voice_config": {                       // Configuración de la estrategia de voz; se devuelve cuando la estrategia de entrega incluye voice
        "template_type": 1                  // Tipo de plantilla de voz; actualmente solo admite plantillas predeterminadas, valor fijo 1
    },
    "email_config": {                       // Configuración de la estrategia de correo electrónico; se devuelve cuando la estrategia de entrega incluye email
        "template_name": "Email Template Name", // Nombre de la plantilla de correo electrónico
        "template_custom_configs": [{       // Configuración de plantilla de correo electrónico personalizada; válida cuando el tipo de plantilla de correo electrónico es personalizada. Nota: es un array de objetos, que se distinguen principalmente por idioma en configuraciones múltiples
            "language": "default",          // Idioma; "default" es el predeterminado. Al enviar mensajes, se puede asociar contenido de plantilla diferente según el parámetro language
            "pre_from_name": "test",        // Nombre del remitente predefinido
            "pre_from_mail": "test@test.com",   // Correo del remitente predefinido
            "pre_subject": "test",          // Asunto del correo predefinido
            "template_content": "Preset email template content, required. Custom variables like {{self}}, verification code is {{code}}", // Contenido del correo electrónico; admite HTML. Las variables deben ir entre llaves dobles {{}}
            "pre_param_map": {              // Valores predeterminados para las variables del contenido del correo. Si durante el envío no se especifica ningún valor de variable, los valores predeterminados siguientes reemplazarán las variables, declarados como pares clave-valor
                "self": "This is the default value for the self variable"
            }
        }]
    },
    "pwa_config": {                         // Configuración relacionada con PWA; se devuelve cuando existe configuración de PWA
        "pwa_platform": "xx",               // Plataforma PWA utilizada
        "pwa_code": "xx"                    // Código utilizado en la plataforma PWA
    },
    "created_time": 1234567890,             // Fecha/hora de creación de la plantilla, en formato timestamp, con precisión de segundos
    "status": 1,                            // Estado de la plantilla; valores: 1-Pendiente de revisión/2-Aprobada/3-Rechazada
    "audit_remark": "xx"                    // Observaciones de auditoría; se utilizan normalmente para ver motivos de rechazo cuando la revisión se rechaza
}

            

              
              {
    "code": 4001,
    "message": "config not exist"
}