Create Template

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

            

              
              {
    "template_id": "test-template-1",       // Custom template id, unique within the application
    "description": "Test template 1",       // Description of the template
    "send_channel_strategy": "whatsapp|sms",// Template delivery strategy, supports whatsapp/sms/voice/email. Combined strategies use the | character to indicate fallback on failure
    "brand_name": "Brand Name",             // Brand name, used for signatures in template content in some countries/regions (e.g., some countries require registered signatures in the SMS channel)
    "verify_code_config": {                 // Verification code configuration, used to configure automatically generated verification codes, required when the template contains a verification code type
        "verify_code_type": 1,              // Verification code type, value range [1,7]
        "verify_code_len": 6,               // Verification code length, value range [4,10]
        "verify_code_ttl": 1                // Verification code validity period, value range [1,10], note that when the strategy includes whatsapp, the value can only be 1, 5, 10
    },
    "whatsapp_config": {                    // whatsapp strategy configuration, valid when the delivery strategy includes whatsapp
        "template_type": 1,                 // whatsapp template type, currently only supports default template, fixed value is 1
        "template_default_config": {        // whatsapp default template configuration, valid for default template type
            "contain_security": false,      // Whether to add security reminder
            "contain_expire": false         // Whether to add expiration time content
        }
    },
    "sms_config": {                         // sms strategy configuration, valid when the delivery strategy includes sms
        "template_type": 2,                 // sms template type, values: 1-default template/2-custom template
        "template_default_config": {        // sms default template configuration, valid for default template type
            "contain_security": false,      // Whether to add security reminder
            "contain_expire": false         // Whether to add expiration time content
        },
        "template_custom_config": {         // sms custom template configuration, valid when sms template type is custom template
            "custom_sub_type": "authentication", // Custom template type, values: authentication/marketing/utility
            "custom_content": "xxx",        // Custom template content, note that if the sub-type is authentication, it must contain the {{code}} variable
            "custom_country_codes": "HK,PH" // Target country/region for custom template, used for reference during template audit, please fill in according to actual situation, otherwise it may affect actual delivery
        }
    },
    "voice_config": {                       // voice strategy configuration, valid when the delivery strategy includes voice
        "template_type": 1,                 // voice template type, currently only supports default template, fixed value is 1
        "template_default_config": {        // voice default template configuration, valid for default template type
            "contain_security": false,      // Whether to add security reminder
            "contain_expire": false         // Whether to add expiration time content
        }
    },
    "email_config": {                       // email strategy configuration, valid when the delivery strategy includes email
        "template_name": "email template name", // email template name
        "template_custom_configs": [{       // email custom template configuration, note this is an object array, mainly used to configure multiple languages via language
            "language": "default",          // Language, default is default, different template content can be matched according to the language parameter during message delivery
            "pre_from_name": "test",        // Preset sender name
            "pre_from_mail": "test@test.com",// Preset sender email
            "pre_subject": "test",          // Preset email subject
            "template_content": "Preset email template content, required, custom variables like {{self}}, verification code is {{code}}", // Email content, supports html, variables need to be enclosed in double braces {{}}
            "pre_param_map": {              // Default values for variables in email content, i.e., if variable values are not specified during delivery, the following default values will be used to replace variables, declared as key-value pairs, value needs to be a string
                "self": "Here is the preset value for the self variable"
            }
        }]
    },
    "pwa_config": {                         // pwa related configuration, temporarily not used
        "pwa_platform": "xx",               // pwa platform used, please contact technical support for specific values
        "pwa_code": "xx"                    // code in the pwa platform used
    }
}

            

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

            

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

            

              
              {{brand_name}} Verification Code

            

              
              <img src="{{logo_url}}" />
<strong>{{title}}</strong>
<p>Your verification code is <strong>{{code}}</strong>, please complete verification within {{ttl}} minutes.</p>
<p>If you have any questions, please contact <a href="mailto:{{support_email}}">{{support_email}}</a></p>

            

              
              "pre_param_map": {
  "logo_url": "https://example.com/logo.png",
  "title": "Your Verification Code",
  "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": "Your Verification Code",
      "support_email": "support@example.com"
    }
  }
}