短信
获取使用中的短信模板
获取企业下审核通过且处于使用状态的短信模板列表。短信服务需已注册并开启。请求体可为空 JSON。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 提示信息 | success |
| data | object[] | 模板列表 | |
| └id | int64 | 模板 ID | 1001 |
| └name | string | 模板名称 | 验证码模板 |
| └type | int32 | 模板类型,1-验证码 2-通知 3-营销 | 1 |
| └content | string | 模板内容 | 您的验证码是%s,有效期5分钟。 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体为空 |
| 14500 | 服务内部异常 |
| 67407 | 短信服务未开启或未注册 |
postEndpoint
/openapi/smstask/templatescurl -X POST "https://qiyukf.com/openapi/smstask/templates?appKey=string&time=0&checksum=string"{
"code": 200,
"message": "success",
"data": [
{
"id": 1001,
"name": "验证码模板",
"type": 1,
"content": "您的验证码是%s,有效期5分钟。"
}
]
}{
"code": 14001,
"message": "AppKey 不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体为空"
}{
"code": 14500,
"message": "服务内部异常"
}{
"code": 67407,
"message": "短信服务未开启或未注册"
}这篇文档有帮助吗?