作者：管理员 历史版本：1 最后编辑：龚清 更新时间：2024-09-20 15:13
查询接收人
简述：
- 查询接收人
请求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=654680789308407808返回示例：
{
"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": "656821259140595712",
"msgId": "656821259115429888",
"receiverType": "employee",
"receiverId": "655074391100489728",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656821259128012800",
"msgId": "656821259115429888",
"receiverType": "employee",
"receiverId": "655074898657411072",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656821088793133056",
"msgId": "656821088767967232",
"receiverType": "employee",
"receiverId": "655074689797849088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656821088780550144",
"msgId": "656821088767967232",
"receiverType": "employee",
"receiverId": "655075052584173568",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656820948585938944",
"msgId": "656820948564967424",
"receiverType": "employee",
"receiverId": "655077249782906880",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656820948577550336",
"msgId": "656820948564967424",
"receiverType": "employee",
"receiverId": "656161494303506432",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815863604707328",
"msgId": "656815863583735808",
"receiverType": "employee",
"receiverId": "655074391100489728",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815863596318720",
"msgId": "656815863583735808",
"receiverType": "employee",
"receiverId": "655074689797849088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815493415436288",
"msgId": "656815493293801472",
"receiverType": "employee",
"receiverId": "655074391100489728",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815493402853376",
"msgId": "656815493293801472",
"receiverType": "employee",
"receiverId": "655074689797849088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815324628254720",
"msgId": "656815324611477504",
"receiverType": "employee",
"receiverId": "655077249782906880",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656815324619866112",
"msgId": "656815324611477504",
"receiverType": "employee",
"receiverId": "656540372104642560",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656814093272875008",
"msgId": "656814093243514880",
"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": "656814093256097792",
"msgId": "656814093243514880",
"receiverType": "employee",
"receiverId": "654729192604172288",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656813715441582080",
"msgId": "656813715420610560",
"receiverType": "employee",
"receiverId": "655074391100489728",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656813715433193472",
"msgId": "656813715420610560",
"receiverType": "employee",
"receiverId": "655074689797849088",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656813323962023936",
"msgId": "656813323941052416",
"receiverType": "employee",
"receiverId": "655077249782906880",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656813323953635328",
"msgId": "656813323941052416",
"receiverType": "employee",
"receiverId": "656540372104642560",
"receiver": null
},
{
"pk": "",
"name": null,
"ip": null,
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"tenantId": null,
"dataStatus": null,
"dbtype": null,
"id": "656812167693074432",
"msgId": "656812167537885184",
"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": "656812167684685824",
"msgId": "656812167537885184",
"receiverType": "employee",
"receiverId": "654620507647246336",
"receiver": null
}
],
"pageResult": {
"limit": 20,
"page": 1,
"totalCount": 186,
"totalPages": 10
}
}
}返回参数说明：
| 名称 | 类型 | 备注 |
|---|---|---|
| data | APIPageList< MessageReceiverPo > | 消息回复实体对象信息列表 |
删除接收人
简述：
- 删除接收人
请求URL：
- http://ip:port/ibps/platform/v3/msg/messageReceiver/remove
- 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=656808467557777408返回示例：
{
"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 |
