模板管理 API

          Authorization: Basic ${base64_auth_string}

        

          // 一个 json 数组，数组中每一个对象都是模板信息
[
    {
        "id": "406979728071589", // 模板id
        "name": "code", // 模板名称
        "language": "zh_CN", // 模板语言
        "status": "APPROVED", // 状态，APPROVED为审核通过可用
        "category": "OTP", // 类别，目前支持 OTP/TRANSACTIONAL/MARKETING
        "components": [ // 模板具体内容，可包含 HEADER/BODY/FOOTER/BUTTON
            {
                "type": "HEADER",
                "format": "text", // 类型，支持 text/image/location/video/document，默认TEXT
                "text": "注册验证码" // 文本内容，当format为text时，为必选项
            },
            {
                "type": "BODY",
                "text": "您的验证码是 {{1}}，请于 5 分钟内输入。" // 两个大括号{{}}括起来的表示模板变量
            }
        ]
    },
    ......
]

        

          {
    "name": "template_name", // 模板名称，允许同名模板，仅支持小写字母及数字及下划线
    "language": "zh_CN", // 模板语言，同名模板下不允许同语言模板
    "category": "OTP", // 类别，目前支持 OTP/TRANSACTIONAL/MARKETING
    "components": [
        { // 模板内容
            "type": "BODY", // 内容块，目前支持 HEADER/BODY/FOOTER/BUTTONS
            "text": "define var as {{1}}" // 具体文本，当body为text时不需要传format字段
          "example": {
                "body_text": [
                    [
                        "var1"
                    ]
                ]
            }
        },
        {
            "type": "HEADER",
            "format": "image", // 内容类型，支持 text/image/video/document/location
            "example": {
                "header_handle": [
                    "https://jiguang.cn/demopic.jpg"
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "footer only support text without variable"
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "PHONE_NUMBER", // 按钮类型，支持 PHONE_NUMBER/URL/QUICK_REPLY              
                    "text": "this is a phone number",
                    "phone_number": "8613800138000"
                }
            ]
        }
    ]
}

        

          {
    "name": "copycodetmpl",
    "language": "zh_CN",
    "category": "AUTHENTICATION",
    "components": [
        {
            // body 是必须的
            "type": "BODY",
            "add_security_recommendation": true  // 是否添加安全建议描述
            
        },
        {
            // footer 是可选的
            "type": "FOOTER",		
            "code_expiration_minutes": 2    // 添加过期时间显示，范围[1,90]，不添加则不传该字段
        },
        {
            "type": "BUTTONS",          
            "buttons": [
                {
                    "type": "OTP",
                    "otp_type": "copy_code",
                    "text": "copy it"      // 长度限制 25 字符
                }
            ]
        }
    ]
}

        

          {
    "name": "copycodetmpl",
    "language": "zh_CN",
    "category": "AUTHENTICATION",
    "components": [
        {
            "type": "BODY",
            "text": "*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。",
            "example": {
                "body_text": [
                    ["123456"]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "这组验证码将在 2 分钟后过期。"
        },
        {
            "type": "BUTTONS",
            "buttons": [{
              "type": "URL",
              "text": "Copy code",
              "url": "https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}",
              "example": [
                  "https://www.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp123456"
              ]
          }]
        }
    ]
}

        

          {
    "name": "copycodetmpl",
    "language": "zh_CN",
    "category": "AUTHENTICATION",
    "components": [
        {
            // body是必须的
            "type": "BODY",
            "add_security_recommendation": true  // 是否添加安全建议描述
            
        },
        {
            // footer是可选的
            "type": "FOOTER",		
            "code_expiration_minutes": 2    // 添加过期时间显示，范围[1,90]，不添加则不传该字段
        },
        {
            "type": "BUTTONS",          
            "buttons": [
                {
                    "type": "OTP",
                    "otp_type": "one_tap",
                    "text": "auto1",      // 长度限制25字符
                    "autofill_text": "auto1",      // 长度限制25字符
                    "package_name": "ppssd",    
                    "signature_hash": "asds"  
                }
            ]
        }
    ]
}

        

          {
    "name": "copycodetmpl",
    "language": "zh_CN",
    "category": "AUTHENTICATION",
    "components": [
        {
            "type": "BODY",
            "text": "*{{1}}* 是你的验证码。为安全起见，请不要分享这组验证码。",
            "example": {
                "body_text": [
                    ["123456"]
                ]
            }
        },
        {
            "type": "FOOTER",
            "text": "这组验证码将在 2 分钟后过期。"
        },
        {
            "type": "BUTTONS",
            "buttons": [{
                "type": "URL",
                "text": "copy1",
                "url": "https://www.whatsapp.com/otp/code/?otp_type=ONE_TAP\u0026cta_display_name=auto1\u0026package_name=ppssd\u0026signature_hash=asds\u0026code=otp{{1}}",
                "example": ["https://www.whatsapp.com/otp/code/?otp_type=ONE_TAP\u0026cta_display_name=auto1\u0026package_name=ppssd\u0026signature_hash=asds\u0026code=otp123456"]
            }]
        }
    ]
}

        

          {
    "template_id": "1275172986566180"		// 模板id
}

        

          {
    "code": 5002,
    "message": "Invalid parameter. code:100:2388042"
}

        

          {
   "components": [{						// 模板内容
        "type": "BODY",					// 内容块，目前支持 HEADER/BODY/FOOTER/BUTTONS
        "text": "define var as {{1}}" // 具体文本，当body为text时不需要传format字段
          "example": {
              "body_text": [["var1"]]
        }
    },{
        "type": "HEADER",
        "format": "image",				// 内容类型，支持 text/image/video/document/location
          "example": {
              "header_url": ["https://jiguang.cn/demopic.jpg"]
          }
    },{
                "type": "FOOTER",
                "text": "footer only support text without variable"
        },{
          "type": "BUTTONS",
          "buttons": [{                                    
            "type": "PHONE_NUMBER",         	// 按钮类型，支持 PHONE_NUMBER/URL/QUICK_REPLY              
            "text": "this is a phone number",             
            "phone_number": "8613800138000"
            }]
      }]
}

        

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

        

          {
    "code": 5002,
    "message": "Invalid parameter. code:100:2593002"
}

        

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


        

          {
    "code": 2004,
    "message": "something error"
}