查询接收人
简述：
- 查询接收人
请求URL：
- http://ip:port/ibps/platform/v3/msg/messageReceiver/get
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- GET
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| messageReceiverId | String | 是 | 接收人 id |
- Body：
暂无
请求参数示例：
http://192.168.3.230:15100/ibps/platform/v3/msg/messageReceiver/get?messageReceiverId=645921644728025088返回示例：
{
"state": 200,
"request": null,
"message": "获取接收人成功！",
"cause": "",
"variables": {},
"data": null
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | MessageReceiverPo | 消息回复实体对象信息 |
获取接收人列表
简述：
- 获取接收人列表
请求URL：
- http://ip:port/ibps/platform/v3/msg/messageReceiver/query
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| request | APIRequest[1] | 是 | 动态查询请求对象 |
请求参数示例：
{
"parameters": [],
"requestPage": {
"pageNo": 1,
"limit": 20
},
"sorts": []
}返回示例：
{
"state": 200,
"request": null,
"message": "查询接收人列表成功！",
"cause": "",
"variables": {},
"data": {
"dataResult": [
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653901566041915392",
"msgId": "653901565999972352",
"receiverType": "employee",
"receiverId": "645921644728025088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653682026108420096",
"msgId": "653682026087448576",
"receiverType": "employee",
"receiverId": "651730680937447424",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653682025307308032",
"msgId": "653682025286336512",
"receiverType": "employee",
"receiverId": "651730680937447424",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653681786655604736",
"msgId": "653681786634633216",
"receiverType": "employee",
"receiverId": "651730680937447424",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653680461410729984",
"msgId": "653680461389758464",
"receiverType": "employee",
"receiverId": "651730854761988096",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653680460819333120",
"msgId": "653680460798361600",
"receiverType": "employee",
"receiverId": "651730854761988096",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653599971144105984",
"msgId": "653599971123134464",
"receiverType": "employee",
"receiverId": "651810477214531584",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "653599970514960384",
"msgId": "653599970473017344",
"receiverType": "employee",
"receiverId": "651810477214531584",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652571920553738240",
"msgId": "652571920532766720",
"receiverType": "employee",
"receiverId": "645921644728025088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652537950734647296",
"msgId": "652537950713675776",
"receiverType": "employee",
"receiverId": "651730407368163328",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652537866185867264",
"msgId": "652537866160701440",
"receiverType": "employee",
"receiverId": "651810477214531584",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652537865900654592",
"msgId": "652537865846128640",
"receiverType": "employee",
"receiverId": "651810477214531584",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652181920033013760",
"msgId": "652181920012042240",
"receiverType": "employee",
"receiverId": "1",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652180381272899584",
"msgId": "652180381209985024",
"receiverType": "org",
"receiverId": "651087432220934144",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652180381230956544",
"msgId": "652180381209985024",
"receiverType": "employee",
"receiverId": "651789288958066688",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652179895513776128",
"msgId": "652179895480221696",
"receiverType": "employee",
"receiverId": "1",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652101376888799232",
"msgId": "652101376838467584",
"receiverType": "org",
"receiverId": "625695342267990016",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652101376872022016",
"msgId": "652101376838467584",
"receiverType": "org",
"receiverId": "631490890224893952",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652101376855244800",
"msgId": "652101376838467584",
"receiverType": "employee",
"receiverId": "651810477214531584",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "652092020449345536",
"msgId": "652092020411596800",
"receiverType": "org",
"receiverId": "625695342267990016",
"receiver": null
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 759,
"totalPages": 38
}
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | APIPageList< MessageReceiverPo > | 消息回复实体对象信息列表 |
删除接收人
简述：
- 删除接收人
请求URL：
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| messageReceiverIds | String[] | 是 | 接收人id数组 |
- Body：
暂无
请求参数示例：
http://192.168.3.230:15100/ibps/platform/v3/msg/messageReceiver/remove?messageReceiverIds=651730680937447424返回示例：
{
"state": 200,
"request": null,
"message": "批量删除接收人成功！",
"cause": "",
"variables": {},
"data": null
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Void |
保存接收人
简述：
- 保存接收人
请求URL：
- http://ip:port/ibps/platform/v3/msg/messageReceiver/save
- URL中的ip需要替换为自己网关ip
- URL中的port需要替换为自己网关端口
请求方式：
- POST
请求参数：
- Headers：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 |
- Query：
暂无
- Body：
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | String | 是 | 主键 | ||
| msgId | String | 是 | 消息ID | ||
| receiverType | String | 是 | 接收者类型 | ||
| receiverId | String | 是 | 接收者ID | ||
| receiver | String | 是 | 接收者 |
请求参数示例：
{
"msgId":"626743085912555520",
"receiverType":"employee",
"receiverId":"1",
"receiver":""
}返回示例：
{
"state": 200,
"request": null,
"message": "添加接收人成功",
"cause": "",
"variables": {},
"data": null
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | Void |
备注
- [1] : APIRequest为动态查询请求对象，详情请移步[全局请求格式](
文档更新时间: 2020-02-04 16:43 作者：朱业成
