模板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"
}