ดึงรายการเทมเพลตทั้งหมด
ปัจจุบันอินเทอร์เฟซนี้ไม่มีการแบ่งหน้า โดยจะส่งกลับเนื้อหาแบบย่อของรายการเทมเพลตทั้งหมด ซึ่งได้ตัดเนื้อหาโดยละเอียดออกไป หากต้องการเนื้อหาทั้งหมด โปรดใช้อินเทอร์เฟซรายละเอียด
ที่อยู่สำหรับเรียกใช้
GET https://otp.api.engagelab.cc/v1/template-configs
การยืนยันตัวตนในการเรียกใช้
โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธีการยืนยันตัวตน API
คำขอ
พารามิเตอร์ของคำขอ
ไม่มี
ตัวอย่างคำขอ
Header ของคำขอ
GET /v1/template-configs HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
GET /v1/template-configs HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
โค้ดนี้โชว์เป็นหน้าต่างลอย
เนื้อหาคำขอ
ไม่มี
การตอบกลับ
พารามิเตอร์การตอบกลับ
ไม่มีฟิลด์ห่อหุ้มชั้นนอก ส่งกลับเป็นอาเรย์ JSON โดยตรง
ตัวอย่างการตอบกลับ
การตอบกลับเมื่อสำเร็จ
[
{
"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" // 审核备注,一般当审核拒绝时可以查看该字段看审核拒绝说明
}
]
[
{
"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" // 审核备注,一般当审核拒绝时可以查看该字段看审核拒绝说明
}
]
โค้ดนี้โชว์เป็นหน้าต่างลอย
การตอบกลับเมื่อล้มเหลว
{
"code": 4001,
"message": "config not exist"
}
{
"code": 4001,
"message": "config not exist"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
รหัสข้อผิดพลาด
| รหัสข้อผิดพลาด | http code | คำอธิบาย |
|---|---|---|
| 1000 | 500 | ข้อผิดพลาดภายใน |
| 2001 | 401 | การยืนยันตัวตนล้มเหลว ไม่ได้แนบ token ที่ถูกต้อง |
| 2002 | 401 | การยืนยันตัวตนล้มเหลว token หมดอายุหรือถูกปิดใช้งานแล้ว |
| 2004 | 403 | ไม่มีสิทธิ์เรียกใช้ API นี้ |
| 4001 | 400 | ไม่พบเทมเพลต |










