Crear plantilla

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

            

              
              {
    "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; obligatorio 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; válida 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
        "template_default_config": {            // Configuración de la plantilla predeterminada de whatsapp; válida para el tipo de plantilla predeterminada
            "contain_security": false,              // Si se añade un aviso de seguridad
            "contain_expire": false                 // Si se añade el contenido del tiempo de expiración
        }
    },
    "sms_config": {                             // Configuración de la estrategia de sms; válida cuando la estrategia de envío incluye sms
        "template_type": 2,                     // Tipo de plantilla de sms; valores: 1-plantilla predeterminada/2-plantilla personalizada
        "template_default_config": {            // Configuración de la plantilla predeterminada de sms; válida para el tipo de plantilla predeterminada
            "contain_security": false,              // Si se añade un aviso de seguridad
            "contain_expire": false                 // Si se añade el contenido del tiempo de expiración
        },
        "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}}
            "custom_country_codes": "HK,PH"         // Países o regiones de destino de la plantilla personalizada; se usan como referencia durante la revisión de la plantilla; indíquelos según corresponda, de lo contrario podría afectar al envío real
        }
    },
    "voice_config": {                           // Configuración de la estrategia de voice; válida 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
        "template_default_config": {            // Configuración de la plantilla predeterminada de voice; válida para el tipo de plantilla predeterminada
            "contain_security": false,              // Si se añade un aviso de seguridad
            "contain_expire": false                 // Si se añade el contenido del tiempo de expiración
        }
    },
    "email_config": {                           // Configuración de la estrategia de email; válida 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; 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, y el valor debe ser una cadena
                "self": "Este es el valor preestablecido de la variable self"
            }
        }]
    },
    "pwa_config": {                             // Configuración relacionada con pwa; por el momento no es necesario usarla
        "pwa_platform": "xx",                   // Plataforma pwa utilizada; para conocer los valores concretos, póngase en contacto con el soporte técnico
        "pwa_code": "xx"                        // code de la plataforma pwa utilizada
    }
}

            

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

            

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

            

              
              Código de verificación de {{brand_name}}

            

              
              <img src="{{logo_url}}" />
<strong>{{title}}</strong>
<p>Su código de verificación es <strong>{{code}}</strong>; complete la verificación en un plazo de {{ttl}} minutos.</p>
<p>Si tiene alguna duda, póngase en contacto con <a href="mailto:{{support_email}}">{{support_email}}</a></p>

            

              
              "pre_param_map": {
  "logo_url": "https://example.com/logo.png",
  "title": "Su código de verificación",
  "support_email": "support@example.com"
}

            

              
              {
  "to": "user@example.com",
  "template": {
    "id": "my_email_template",
    "language": "default",
    "params": {
      "logo_url": "https://example.com/logo.png",
      "title": "Su código de verificación",
      "support_email": "support@example.com"
    }
  }
}