範本 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"
}