获取所有模板列表
目前该接口不做分页,将返回所有的模版列表简要内容。主要减去了具体的内容,若需要得到内容请使用详情接口。
调用地址
GET https://otp.api.engagelab.cc/v1/template-configs
调用验证
请参考 调用验证 了解如何进行 API 鉴权。
请求
请求参数
无
请求示例
请求头
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 | 模版不存在 |










