发送业务通知
简要描述
- 业务服务发送自定义通知，客户端会收到OnRecvCustomBusinessMessage回调
请求方式
post
请求URL
{API_ADDRESS}/msg/send_business_notification
Header
| header名 | 示例值 | 选填 | 类型 | 说明 |
|---|---|---|---|---|
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
| token | eyJhbxxxx3Xs | 必填 | string | 管理员 token |
请求参数示例
{
"sendUserID": "openIMAdmin",
"recvUserID": "2839678182",
"recvGroupID": "",
"key": "xxx",
"data": "xxxxxx",
"sendMsg": false,
"reliabilityLevel": 1
}
| 字段名 | 选填 | 类型 | 说明 |
|---|---|---|---|
| sendUserID | 必填 | string | 系统通知号ID，或用户ID |
| recvUserID | 选填 | string | 接收者用户ID，与recvGroupID只能选其中一个 |
| recvGroupID | 选填 | string | 接收群ID，与recvUserID只能选其中一个 |
| key | 必填 | string | 根据业务分类，客户端可以通过改字段用不同方法处理data |
| data | 必填 | string | 业务数据 |
| sendMsg | 选填 | bool | 是否已消息形式发送，默认: false |
| reliabilityLevel | 选填 | int | 通知消息的可靠基本，1: 在线推送。2: 必达通知(断线重连或重新登录也会触发，用于必达的场景，该可靠性等级下，由于是顺序全量同步，建议不能发送过多，否则会影响客户端消息同步性能)，默认: 1 |
成功返回示例
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"serverMsgID": "8698dd5d163dd79b8fdfa333fee06f40",
"clientMsgID": "1ca0e4cf279ad5cce6b28331b2b42092",
"sendTime": 1679558586210
}
}
成功返回示例的参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码，0表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |
| serverMsgID | string | 服务器消息ID，预留字段 |
| clientMsgID | string | 客户端消息ID，此ID为消息唯一ID |
| sendTime | int | 消息发送的时间 |
失败返回示例
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
失败返回示例的参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码，具体查看全局错误码文档 |
| errMsg | string | 错误简要信息 |
| errDlt | errDlt | 错误详细信息 |