查询模板信息
更新时间：2022-11-09
1.功能说明
1.1.该接口可以查询自己账户（或者子账户）下创建的所有模板，实现和自己业务系统无缝对接。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址：http(s)://api.guoyangyun.com/api/template/query.htm
1.4.汉字字符集：UTF-8，请注意参数的大小写。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址：http(s)://api.guoyangyun.com/api/template/query.htm
1.4.汉字字符集：UTF-8，请注意参数的大小写。
2.输入参数
| 参数 | 名称 | 类型 | 必须 | 描述 |
| 公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
| username | 账户名称 | String | 否 | 要查询的账户名称，如不填查询，则仅查询自己账户下的模板。 |
| templateCode | 模板ID | String | 否 | 要查询的模板code。 |
| templateName | 模板名称 | String | 否 | 要查询的模板名称，支持模糊查询。 |
| message | 模板内容 | String | 否 | 要查询的模板内容，支持模糊查询。 |
| startTime | 起始时间 | String | 否 | 模板创建起始查询时间。格式：yyyy-MM-dd HH:mm:ss |
| endTime | 结束时间 | String | 否 | 模板创建结束查询时间。格式：yyyy-MM-dd HH:mm:ss |
| pageSize | 分页大小 | Int | 否 | 可自定义查询页大小，默认值20条/页。 |
| page | 查询页 | Int | 否 | 可指定查询页，默认值第1页。 |
3.调用示例
http(s)://api.guoyangyun.com/api/template/query.htm?appkey=XXX&appsecret=XXX&username=&templateCode=&templateName=&message=&startTime=&endTime=&pageSize=&page=
特别提醒：需对url中的参数进行URLEncode编码，以免出现参数异常查询不准确情况。
4.Json返回
4.1.返回参数
| 参数 | 名称 | 类型 | 描述 |
| code | 返回码 | Int | 提交返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》） |
| msg | 信息提示内容 | String | 返回成功/错误详细描述信息。 |
 data |
模板信息 | List | 返回模板详细信息 |
| created | 创建时间 | String | 模板的创建时间 |
| modified | 修改时间 | String | 模板最近一次修改时间 |
| primaryName | 主账户名 | String | 主账户的登录名称 |
| username | 账户名称 | String | 账户登录名称 |
| status | 模板状态 | String | WAIT_AUDIT：等待审核；ENABLE：正常；AUDIT_REJECT：审核拒绝；DISABLE：禁用 |
| label | 模板标签 | String | 模板所属分类标签 |
| smsType | 模板类型 | String | VT：验证码；NT：通知；MT：营销 |
| templateName | 模板名称 | String | 模板名称 |
| message | 模板内容 | String | 模板的完整内容 |
| templateCode | 模板ID | String | 模板代码 |
| sceneRemark | 使用场景 | String | 模板的使用场景描述 |
| count | 查询结果总数 | Int | 查询到的模板总数量 |
4.2.调用成功样例
{
"code": "0",
"msg": "成功",
"data": [
{
"created": "2022-05-12 16:45:34", //模板创建时间
"modified": "2022-05-12 16:45:34", //模板修改时间
"primaryName": "a123456", //主账户名
"username": "a123456", //账户名
"status": "ENABLE", //模板状态
"label": "", //模板分类标签名
"smsType": "VT", //模板类型：VT，NT，MT
"templateName": "登录注册验证码", //模板名称
"message": "验证码：**code**，5分钟有效！", //模板内容
"templateCode": "57dbf34aaa104a4a3abf9f0", //模板code
"sceneRemark": "注册/登录会员身份验证使用" //使用场景
}
],
"count": 1 //查询总模板数
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}