- 2.4.1.7.20. Message(消息)
- 2.4.1.7.20.1. 查询Message列表
- 2.4.1.7.20.2. 查询Message指定记录
- 2.4.1.7.20.3. 添加Message
- 2.4.1.7.20.4. 编辑Message
- 2.4.1.7.20.5. 删除Message
2.4.1.7.20. Message(消息)
2.4.1.7.20.1. 查询Message列表
调用接口:
属性 | 值 |
---|---|
url | /api/message/get_list |
http方法 | post |
Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
page_index | 查询页码 | Integer | 大于 0,如果为空,则默认从第一页显示 | 否 |
page_size | 每页记录数 | Integer | 大于 0,如果为空,则默认为 20 | 否 |
condition | 查询条件 | Json | LIKE模糊搜索条件 | 否 |
start_time | 开始时间 | Datetime | 按创建时间搜索的开始时间和结束时间 | 否 |
end_time | 结束时间 | Datetime | 否 | |
is_all | 是否返回所有数据 | Boolean | 1:是,0:否;如果为空,则默认0 | 否 |
condition参数:
格式
[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]
举例
[["message_id", "=", "1001"]]
返回参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
code | 返回码 | Integer | 200:成功 500:失败 | 是 |
msg | 提示信息 | String | 是 | |
result | 结果 | Json | 是 |
返回数据举例:
{
"code": 200,
"msg": "查询成功",
"mix_code":130001,
"mix_msg":"",
"mix_ext":"",
"result": {
"page_index": 1,
"page_size": 20,
"total_pages": 1,
"total_records": 1,
"data": [
{
"message_id": 1009,
"message_name": "适配器离线",
"date": null,
"category": "AprusDisconnect",
"unit": "gards",
"messenger": "A22018083100002",
"description": "",
"customer_id": null,
"template": null,
"script": null,
"reference": "",
"created": "2018-09-03 18:46:26",
"is_available": 1
}
]
}
}
2.4.1.7.20.2. 查询Message指定记录
调用接口:
属性 | 值 |
---|---|
url | /api/message/get |
http方法 | post |
Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
message_id | 消息标识 | String | 是 |
返回参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
code | 返回码 | Integer | 200:成功 500:失败 | 是 |
msg | 提示信息 | String | 是 | |
result | 返回结果 | Json | 是 |
返回示例:
{
"code": 200,
"msg": "查询成功",
"mix_code":130001,
"mix_msg":"",
"mix_ext":"",
"result": {
"message_id": 1009,
"message_name": "适配器离线",
"date": null,
"category": "AprusDisconnect",
"unit": "gards",
"messenger": "A22018083100002",
"description": "",
"customer_id": null,
"template": null,
"script": null,
"reference": "",
"created": "2018-09-03 18:46:26",
"is_available": 1
}
}
2.4.1.7.20.3. 添加Message
调用接口:
属性 | 值 |
---|---|
url | /api/message/add |
http方法 | post |
Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
message_name | 消息摘要或标题 | String | 是 | |
date | 消息时间 | datetime | 否 | |
category | 消息类型 | String | 否 | |
unit | 消息来源分类 | String | 否 | |
messenger | 消息来源 | String | 否 | |
description | 描述 | Text | 否 | |
customer_id | 客户标识 | String | 否 | |
template | 模板/样式 | text | 否 | |
script | 脚本 | text | 否 | |
reference | 参考号 | String | 否 | |
is_available | 是否有效 | Boolean | 1:是,0:否 | 否 |
返回参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
code | 返回码 | Integer | 200:成功 500:失败 | 是 |
msg | 提示信息 | String | 是 | |
result | 返回结果 | Json | 是 |
返回示例:
{
"code": 200,
"msg": "添加成功",
"mix_code":130001,
"mix_msg":"",
"mix_ext":"",
"result": []
}
2.4.1.7.20.4. 编辑Message
调用接口:
属性 | 值 |
---|---|
url | /api/message/edit |
http方法 | post |
Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
message_id | 消息标识 | String | 是 | |
message_name | 消息摘要或标题 | String | 否 | |
date | 消息时间 | datetime | 否 | |
category | 消息类型 | String | 否 | |
unit | 消息来源分类 | String | 否 | |
messenger | 消息来源 | String | 否 | |
description | 描述 | Text | 否 | |
customer_id | 客户标识 | String | 否 | |
template | 模板/样式 | text | 否 | |
script | 脚本 | text | 否 | |
reference | 参考号 | String | 否 |
返回参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
code | 返回码 | Integer | 200:成功 500:失败 | 是 |
msg | 提示信息 | String | 是 | |
result | 返回结果 | Json | 是 |
返回示例:
{
"code": 200,
"msg": "编辑成功",
"mix_code":130001,
"mix_msg":"",
"mix_ext":"",
"result": []
}
2.4.1.7.20.5. 删除Message
调用接口:
属性 | 值 |
---|---|
url | /api/message/delete |
http方法 | post |
Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
message_id | 消息标识 | String | 是 |
返回参数:
字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
---|---|---|---|---|
code | 返回码 | Integer | 200:成功 500:失败 | 是 |
msg | 提示信息 | String | 是 | |
result | 返回结果 | Json | 是 |
返回示例:
{
"code": 200,
"msg": "删除成功",
"mix_code":130001,
"mix_msg":"",
"mix_ext":"",
"result": []
}