# 模板中心接口
# 模板分类
# 新增模板分类
该接口主要用来新增模板分类
# 请求路径：
/template-sort/
# 请求方法：
POST
# 请求参数：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| code | 是 | 分类编码 |
| name | 是 | 分类名称 |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| code | String | 分类编码 |
| name | String | 分类名称 |
| id | String | 分类ID |
| status | Int | 分类状态 |
| systemId | String | 系统ID |
# 示例：
- 请求范例：
POST /template-sort/
Host: gosp.glink.glkyun.com
Request Payload: {name: "请假业务", code: "QJYW"}
1
2
3
2
3
- 响应范例：
{
"uuid": "9e50a9b7-a0c2-489d-8057-420a7a6c58b5",
"code": "000000",
"msg": "成功",
"data": {
"id": "1518855265813282816",
"code": "XXMB",
"name": "消息模版",
"status": null,
"systemId": null
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 模板分类列表：
# 请求路径：
/template-sort/list
# 请求方法：
GET
# 请求参数：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| code | 否 | 分类编码 |
| name | 否 | 分类名称 |
| status | 否 | 状态 |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 分类ID |
| code | String | 分类编码 |
| name | String | 分类名称 |
| status | Int | 状态 |
| systenId | String | 系统ID |
# 示例：
- 请求范例：
GET /template-sort/list
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "369ee707-d289-4ad5-8251-bb04595157a8",
"code": "000000",
"msg": "成功",
"data": [
{
"id": "1511640383258902528",
"code": "WeChat",
"name": "微信分组",
"status": null,
"systemId": null
},
{
"id": "1518853350857654272",
"code": "QJYW",
"name": "请假业务",
"status": null,
"systemId": null
}
],
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 根据ID查询模板分类
# 请求路径：
/template-sort/{id}
# 请求方法：
GET
# 请求参数：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 分类ID |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 分类ID |
| code | String | 分类编码 |
| name | String | 分类名称 |
| status | Int | 状态 |
| systemId | String | 系统ID |
# 示例：
- 请求范例：
GET /template-sort/1518853350857654272?id=1518853350857654272
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "34b3edbd-79ff-4d82-8258-60741efa0092",
"code": "000000",
"msg": "成功",
"data": {
"id": "1518853350857654272",
"code": "QJYW",
"name": "请假业务",
"status": null,
"systemId": null
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 删除模板分类
# 请求路径：
/template-sort/batch
# 请求方法：
DELETE
# 请求参数：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| ids | 是 | 分类ID集合 |
# 返回信息：
true
# 示例：
- 请求范例：
DELETE /template-sort/batch
Host: gosp.glink.glkyun.com
Request Payload: ["1518855265813282816"]
1
2
3
2
3
- 响应范例：
{
"uuid": "34b3edbd-79ff-4d82-8258-60741efa0092",
"code": "000000",
"msg": "成功",
"data": true,
"ok": true
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 模板
# 新增模版
# 请求路径：
/template-details/
# 请求方法：
POST
# 请求参数：
| 参数 | 是否必须 | 说明 |
|---|---|---|
| sortId | 是 | 模板分类ID |
| name | 是 | 模板名称 |
| contentFormat | 是 | 数据类型 |
| content | 是 | 内容 |
| status | 是 | 状态 (0:禁用 1:启用) |
| remark | 否 | 描述 |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 模板ID |
| name | String | 模板名称 |
| content | String | 内容 |
| contentFormat | String | 数据类型 |
| priority | String | 是否默认 (default:是) |
| remark | String | 描述 |
| sortCode | String | 模板分类编码 |
| sortId | String | 模版分类ID |
| status | Int | 状态 |
# 示例：
- 请求范例：
POST /template-details/
Host: gosp.glink.glkyun.com
Request Payload: {
"name": "消息业务",
"contentFormat": "json",
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"status": 1,
"sortId": "1518853350857654272"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
- 响应范例：
{
"uuid": "e2aeda0f-737c-4c19-8d26-03c367d99519",
"code": "000000",
"msg": "成功",
"data": {
"id": "1518871418593886208",
"sortId": 1518853350857654300,
"name": "消息业务",
"status": 1,
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"remark": null,
"contentFormat": "json",
"sortCode": null,
"priority": null
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 编辑模板
# 请求路径：
/template-details/{id}
# 请求方法：
PUT
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| id | 是 | 模板ID |
| name | 是 | 模板名称 |
| priority | 是 | 是否默认 |
| contentFormat | 是 | 数据类型 |
| content | 是 | 内容 |
| remark | 否 | 描述 |
| sortCode | 是 | 分类编码 |
| sortId | 是 | 分类ID |
| status | 是 | 状态 |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 模板ID |
| name | String | 模板名称 |
| priority | String | 是否默认 |
| contentFormat | String | 数据类型 |
| content | String | 内容 |
| remark | String | 描述 |
| sortCode | String | 分类编码 |
| sortId | String | 分类ID |
| status | Int | 状态 |
# 示例：
- 请求范例：
PUT /template-details/1518871418593886208
Host: gosp.glink.glkyun.com
Request Payload: {
"name": "消息业务",
"contentFormat": "json",
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"status": 1,
"remark": "消息发送模板",
"id": "1518871418593886208",
"sortId": "1518853350857654272",
"sortCode": "QJYW",
"priority": "default"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
- 响应范例：
{
"uuid": "f921d99f-7d71-40de-9658-a01e67ccd5f1",
"code": "000000",
"msg": "成功",
"data": {
"id": "1518871418593886208",
"sortId": 1518853350857654300,
"name": "消息业务",
"status": 1,
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"remark": "消息发送模板",
"contentFormat": "json",
"sortCode": "QJYW",
"priority": "default"
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 模板列表
# 请求路径：
/template-details/list
# 请求方法：
GET
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| sortId | 否 | 分类ID |
| sortCode | 否 | 分类编码 |
| priority | 否 | 是否默认 |
| status | 否 | 状态 |
| contentFormat | 否 | 数据类型 |
| name | 否 | 模板名称 |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 模板ID |
| sortId | String | 模板分类ID |
| name | String | 模板名称 |
| status | Int | 状态 |
| content | String | 内容 |
| remark | String | 描述 |
| contentFormat | String | 数据类型 |
| sortCode | String | 模板分类编码 |
| priority | String | 是否默认 |
# 示例：
- 请求范例：
GET /template-details/list
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "daeb306b-bb94-4d2f-8916-85d3b6a6e09e",
"code": "000000",
"msg": "成功",
"data": [
{
"id": "1511887001526747136",
"sortId": 1511886922564780032,
"name": "微信文本消息",
"status": 1,
"content": "{\n \"msgtype\" : \"text\",\n \"text\" : {\n \"content\" : \"$userName=${userId}$你的快递已到，请携带工卡前往邮件中心领取。\\n出发前可查看<a href=\\\"http://work.weixin.qq.com\\\">邮件中心视频实况</a>，聪明避开排队。\"\n }\n}",
"remark": "快递提醒消息",
"contentFormat": "json",
"sortCode": "QYWXTEXT",
"priority": "default"
},
{
"id": "1513761032462942208",
"sortId": 1511886922564780032,
"name": "微信文本消息2",
"status": 0,
"content": "{\n \"msgtype\" : \"text\",\n \"text\" : {\n \"content\" : \"$userName=${userId}$你的快递已到，请到微信消息中心领取。\"\n }\n}",
"remark": "快递提醒2",
"contentFormat": "json",
"sortCode": "QYWXTEXT",
"priority": null
},
{
"id": "1518871418593886208",
"sortId": 1518853350857654272,
"name": "消息业务",
"status": 1,
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"remark": "消息发送模板",
"contentFormat": "json",
"sortCode": "QJYW",
"priority": "default"
}
],
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 根据ID查询模板
# 请求路径：
/template-details/{id}
# 请求方法：
GET
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| id | 是 | 模板ID |
# 返回信息：
| 名称 | 类型 | 字段名 |
|---|---|---|
| id | String | 模板ID |
| sortId | String | 模板分类ID |
| name | String | 模板名称 |
| status | Int | 状态 |
| content | String | 内容 |
| remark | String | 描述 |
| contentFormat | String | 数据类型 |
| sortCode | String | 模板分类编码 |
| priority | String | 是否默认 |
# 示例：
- 请求范例：
GET /template-details/1518871418593886208?id=1518871418593886208
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "4e51ab3d-3455-4cd3-ac73-f87fc3a4b989",
"code": "000000",
"msg": "成功",
"data": {
"id": "1518871418593886208",
"sortId": 1518853350857654272,
"name": "消息业务",
"status": 1,
"content": "${userId}收到了会议邀请。会议号：${meetingNum}",
"remark": "消息发送模板",
"contentFormat": "json",
"sortCode": "QJYW",
"priority": "default"
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 删除模板：
# 请求路径：
/template-details/batch
# 请求方法：
DELETE
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| ids | 是 | 模板ID集合 |
# 返回信息：
true
# 示例：
- 请求范例：
DELETE /template-details/batch
Host: gosp.glink.glkyun.com
Request Payload: ["1511633122721546240"]
1
2
3
2
3
- 响应范例：
{
"uuid": "9abb8243-d7c7-41c6-9117-ebb3989caf4c",
"code": "000000",
"msg": "成功",
"data": true,
"ok": true
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 设为默认
模板分类下的第一个模板为默认模板，一个分类只有一个默认模板，支持手动设置
# 请求路径：
/template-details/fit/{id}
# 请求方法：
PUT
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| id | 是 | 模板ID |
# 返回信息：
true
# 示例：
- 请求范例：
PUT /template-details/fit/1516699187482738688?id=1516699187482738688
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "b74aec0c-cf91-461e-8bdb-02250d70b40b",
"code": "000000",
"msg": "成功",
"data": true,
"ok": true
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 启用模板
# 请求路径：
/template-details/batch/enable
# 请求方法：
PUT
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| ids | 是 | 模板ID集合 |
# 返回信息：
true
# 示例：
- 请求范例：
PUT /template-details/batch/enable
Host: gosp.glink.glkyun.com
Request Payload: ["1516699187482738688"]
1
2
3
2
3
- 响应范例：
{
"uuid": "610134c6-08d5-4f10-a008-1a0818031fc0",
"code": "000000",
"msg": "成功",
"data": true,
"ok": true
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 禁用模板
# 请求路径：
/template-details/batch/unEnable
# 请求方法：
PUT
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| ids | 是 | 模板ID集合 |
# 返回信息：
true
# 示例：
- 请求范例：
PUT /template-details/batch/unEnable
Host: gosp.glink.glkyun.com
Request Payload: ["1516699187482738688"]
1
2
3
2
3
- 响应范例：
{
"uuid": "98398df8-9294-4c0c-9d89-2dd7a3945ef7",
"code": "000000",
"msg": "成功",
"data": true,
"ok": true
}
1
2
3
4
5
6
7
2
3
4
5
6
7
# 模板转换
# 请求路径：
/template-details/process
# 请求方法：
GET
# 请求参数：
| 参数 | 是否必须 | 描述 |
|---|---|---|
| id | 否 | 模板ID |
| code | 否 | 模板分类编码(模板ID与模板分类编码不能都为空) |
| params | 是 | 参数集合 |
# 返回信息：
| 字段 | 类型 | 字段名 |
|---|---|---|
| id | String | 模板ID |
| sortId | String | 模板分类ID |
| name | String | 模板名称 |
| status | Int | 状态 |
| content | String | 内容 |
| remark | String | 描述 |
| contentFormat | String | 数据类型 |
| sortCode | String | 模板分类编码 |
| priority | String | 是否默认 |
# 示例：
- 请求范例：
GET /template-details/process?id=&code=QYWXTEXT
Host: gosp.glink.glkyun.com
1
2
2
- 响应范例：
{
"uuid": "93b2dc88-4c71-413f-9324-6ae1c652efcc",
"code": "000000",
"msg": "成功",
"data": {
"id": "1511887001526747136",
"sortId": 1511886922564780032,
"name": "微信文本消息",
"status": 1,
"content": "{\n \"msgtype\" : \"text\",\n \"text\" : {\n \"content\" : \"$userName=张三$你的快递已到，请携带工卡前往邮件中心领取。\\n出发前可查看<a href=\\\"http://work.weixin.qq.com\\\">邮件中心视频实况</a>，聪明避开排队。\"\n }\n}",
"remark": "快递提醒消息",
"contentFormat": "json",
"sortCode": "QYWXTEXT",
"priority": "default"
},
"ok": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17