模板API接口

              
              Authorization: Basic ${base64_auth_string}

            

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

            

              
              {
    "template_id": "test-template-1",       // 自定义的模版id，应用内唯一
    "description": "测试模版1",                 // 该模版的描述说明
    "send_channel_strategy": "whatsapp|sms",    // 模版的下发策略，支持whatsapp/sms/voice/email四类，组合策略则使用｜字符表示失败补发
    "brand_name": "品牌名称",                   // 品牌名称，用在一些国家地区模版内容中的签名（如短信通道中一些国家地区要求要注册签名）
    "verify_code_config": {                     // 验证码的配置，用于配置自动生成的验证码，模版包含验证码类型时必填
        "verify_code_type": 1,                  // 验证码类型，取值范围[1,7]
        "verify_code_len": 6,                   // 验证码长度，取值范围[4,10]
        "verify_code_ttl": 1                    // 验证码有效期，取值范围[1,10]，注意当策略包含whatsapp时取值只能是1，5，10
    },
    "whatsapp_config": {                        // whatsapp策略的配置，当下发策略包含whatsapp时有效
        "template_type": 1,                      // whatsapp模版类型，目前仅支持默认模版，即固定取值为1
        "template_default_config": {            // whatsapp默认模版配置，针对默认模版类型时有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加过期时间内容
        }
    },
    "sms_config": {                             // sms策略的配置，当下发策略包含sms时有效
        "template_type": 2,                     // sms模版类型，取值：1-默认模版/2-自定义模版
        "template_default_config": {            // sms默认模版配置，针对默认模版类型时有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加过期时间内容
        }
        "template_custom_config": {             // sms自定义模版配置，sms模版类型为自定义模版时有效
            "custom_sub_type": "authentication",    // 自定义模版类型，取值：authentication-验证码/marketing-营销/utility-通知
            "custom_content": "xxx",                // 自定义模版内容，注意若子类型为authentication验证码类型时必须包含{{code}}变量
            "custom_country_codes": "HK,PH"         // 自定义模版的目标国家地区，用于模版审核时参考，请按实际填写，否则可能影响实际下发
        }
    },
    "voice_config": {                           // voice策略的配置，当下发策略包含voice时有效
        "template_type": 1,                      // voice模版类型，目前仅支持默认模版，即固定取值为1
        "template_default_config": {            // voice默认模版配置，针对默认模版类型时有效
            "contain_security": false,              // 是否添加安全提醒
            "contain_expire": false                 // 是否添加过期时间内容
        }
    },
    "email_config": {                           // email策略的配置，当下发策略包含email时有效
        "template_name": "email模板名称",                     // email模版名称
        "template_custom_configs": [{           // email自定义模版配置，注意这里是对象数组，主要是通过language进行区分配置多个
            "language": "default",              // 语言，default为默认，消息下发时可以根据language参数来匹配不同的模版内容
            "pre_from_name": "test",            // 预设的发送人名称
            "pre_from_mail": "test@test.com",   // 预设的发送人邮箱
            "pre_subject": "test",              // 预设的邮件主题
            "template_content": "预设邮件模版内容，必填，自定义变量如{{self}},验证码是{{code}}",    // 邮件内容，支持html，变量需要使用两个大括号{{}}括起来
            "pre_param_map": {                  // 邮件内容中变量的默认值，即下发时若不指定变量值，则采用下述的默认值来替换变量，采用key-value对声明，value需要使用字符串
                "self": "这里是self变量预设值"
            }
        }]
    },
    "pwa_config": {                             // pwa相关的配置，暂时可以不使用
        "pwa_platform": "xx",                   // 使用的pwa平台，具体取值请与技术支持联系获取确定
        "pwa_code": "xx"                        // 使用的pwa平台中的code
    }
}

            

              
              {
    "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，应用内唯一
    "description": "测试模版1",                 // 该模版的描述说明
    "send_channel_strategy": "whatsapp|sms",    // 模版的下发策略，支持whatsapp/sms/voice/email四类，组合策略则使用｜字符表示失败补发
    "brand_name": "品牌名称",                   // 品牌名称，用在一些国家地区模版内容中的签名（如短信通道中一些国家地区要求要注册签名）
    "verify_code_config": {                     // 验证码的配置，用于配置自动生成的验证码，模版包含验证码类型时返回
        "verify_code_type": 1,                  // 验证码类型，取值范围[1,7]
        "verify_code_len": 6,                   // 验证码长度，取值范围[4,10]
        "verify_code_ttl": 1                    // 验证码有效期，取值范围[1,10]，注意当策略包含whatsapp时取值只能是1，5，10
    },
    "whatsapp_config": {                        // whatsapp策略的配置，当下发策略包含whatsapp时返回
        "template_type": 1                      // whatsapp模版类型，目前仅支持默认模版，即固定取值为1
    },
    "sms_config": {                             // sms策略的配置，当下发策略包含sms时返回
        "template_type": 2,                     // sms模版类型，取值：1-默认模版/2-自定义模版
        "template_parts": 1                    // sms模版预估的计费条数，模版过长则会具体的价格=计费条数*计费单价
    },
    "voice_config": {                           // voice策略的配置，当下发策略包含voice时返回
        "template_type": 1                      // voice模版类型，目前仅支持默认模版，即固定取值为1
    },
    "email_config": {                           // email策略的配置，当下发策略包含email时返回
        "template_name": "email模板名称"                     // email模版名称
    },
    "pwa_config": {                             // pwa相关的配置，具有pwa配置时才会返回
        "pwa_platform": "xx",                   // 使用的pwa平台
        "pwa_code": "xx"                        // 使用的pwa平台中的code
    },
    "created_time": 1234567890,                 // 该模版的创建时间，时间戳格式，精确到秒
    "status": 1,                                 // 模版状态，取值：1-待审核/2-审核通过/3-审核拒绝
    "audit_remark": "xx"                        // 审核备注，一般当审核拒绝时可以查看该字段看审核拒绝说明
},...]      // 注意这里是object数组

            

              
              {
    "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，应用内唯一
    "description": "测试模版1",                 // 该模版的描述说明
    "send_channel_strategy": "whatsapp|sms",    // 模版的下发策略，支持whatsapp/sms/voice/email四类，组合策略则使用｜字符表示失败补发
    "brand_name": "品牌名称",                   // 品牌名称，用在一些国家地区模版内容中的签名（如短信通道中一些国家地区要求要注册签名）
    "verify_code_config": {                     // 验证码的配置，用于配置自动生成的验证码，模版包含验证码类型时返回
        "verify_code_type": 1,                  // 验证码类型，取值范围[1,7]
        "verify_code_len": 6,                   // 验证码长度，取值范围[4,10]
        "verify_code_ttl": 1                    // 验证码有效期，取值范围[1,10]，注意当策略包含whatsapp时取值只能是1，5，10
    },
    "whatsapp_config": {                        // whatsapp策略的配置，当下发策略包含whatsapp时返回
        "template_type": 1                      // whatsapp模版类型，目前仅支持默认模版，即固定取值为1
    },
    "sms_config": {                             // sms策略的配置，当下发策略包含sms时返回
        "template_type": 2,                     // sms模版类型，取值：1-默认模版/2-自定义模版
        "template_parts": 1,                    // sms模版预估的计费条数，模版过长则会具体的价格=计费条数*计费单价
        "template_custom_config": {             // sms自定义模版配置，sms模版类型为自定义模版时有效
            "custom_sub_type": "authentication",    // 自定义模版类型，取值：authentication-验证码/marketing-营销/utility-通知
            "custom_content": "xxx"                // 自定义模版内容，注意若子类型为authentication验证码类型时必须包含{{code}}变量
        }
    },
    "voice_config": {                           // voice策略的配置，当下发策略包含voice时返回
        "template_type": 1                      // voice模版类型，目前仅支持默认模版，即固定取值为1
    },
    "email_config": {                           // email策略的配置，当下发策略包含email时返回
        "template_name": "email模板名称",                     // email模版名称
        "template_custom_configs": [{           // email自定义模版配置，email模版类型为自定义模版时有效，注意这里是对象数组，主要是通过language进行区分配置多个
            "language": "default",              // 语言，default为默认，消息下发时可以根据language参数来匹配不同的模版内容
            "pre_from_name": "test",            // 预设的发送人名称
            "pre_from_mail": "test@test.com",   // 预设的发送人邮箱
            "pre_subject": "test",              // 预设的邮件主题
            "template_content": "预设邮件模版内容，必填，自定义变量如{{self}},验证码是{{code}}",    // 邮件内容，支持html，变量需要使用两个大括号{{}}括起来
            "pre_param_map": {                  // 邮件内容中变量的默认值，即下发时若不指定变量值，则采用下述的默认值来替换变量，采用key-value对声明
                "self": "这里是self变量预设值"
            }
        }]
    },
    "pwa_config": {                             // pwa相关的配置，具有pwa配置时才会返回
        "pwa_platform": "xx",                   // 使用的pwa平台
        "pwa_code": "xx"                        // 使用的pwa平台中的code
    },
    "created_time": 1234567890,                 // 该模版的创建时间，时间戳格式，精确到秒
    "status": 1,                                 // 模版状态，取值：1-待审核/2-审核通过/3-审核拒绝
    "audit_remark": "xx"                        // 审核备注，一般当审核拒绝时可以查看该字段看审核拒绝说明
}

            

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