批量发送消息
简要描述
- 批量发送消息。
请求方式
post
请求URL
http://x.x.x.x:10002/msg/batch_send_msg
Header
header名 | 示例值 | 选填 | 类型 | 说明 |
---|---|---|---|---|
operationID | 1646445464564 | 必填 | string | operationID用于全局链路追踪 |
token | eyJhbxxxx3Xs | 必填 | string | 管理员token |
请求参数示例
{
"sendID": "openIMAdmin",
"senderNickname": "Gordon",
"senderFaceURL": "http://www.head.com",
"senderPlatformID": 1,
"content": {
"text": "{\"content\":\"hello world!\"}"
},
"contentType": 101,
"sessionType": 1,
"isOnlineOnly": false,
"notOfflinePush": false,
"offlinePushInfo": {
"title": "send message",
"desc": "",
"ex": "",
"iOSPushSound": "default",
"iOSBadgeCount": true
},
"isSendAll": true
}
字段名 | 选填 | 类型 | 说明 |
---|---|---|---|
sendID | 必填 | string | 发送者ID(可以为管理员ID,可以为用户ID) |
recvIDs | 选填 | array | 接收者ID列表,sessionType1或者4,必填,为接收方用户ID,如果是群聊则不填 |
senderNickname | 选填 | string | 发送者昵称 |
senderFaceURL | 选填 | string | 发送者头像 |
senderPlatformID | 选填 | int | 发送者平台号,模拟用户发送时填写, 1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux,8->AndroidPad,9->IPad |
content | 必填 | object | 消息的具体内容,内部是json 对象,其他消息的详细字段请参考消息类型格式描述文档 |
contentType | 必填 | int | 消息类型,101表示文本,102表示图片..详细参考消息类型格式描述文档 |
sessionType | 必填 | int | 会话类型,发送的消息是单聊还是群聊,单聊为1,群聊(普通写扩散)为2,大群(读扩散接口)为3,通知会话为4 |
isOnlineOnly | 选填 | boolean | 该字段设置为true时候,发送的消息服务器不会存储,接收者在线才会收到,不在线该消息丢失 |
notOfflinePush | 选填 | string | 该字段设置为true时候,发送的消息在用户离线时将不会进行离线推送 |
offlinePushInfo | 选填 | object | 离线推送的具体内容,如果不填写,使用服务器默认推送标题 |
offlinePushInfo.title | 选填 | string | 推送的标题 |
offlinePushInfo.desc | 选填 | string | 推送的具体描述 |
offlinePushInfo.ex | 选填 | string | 扩展字段 |
offlinePushInfo.iOSPushSound | 选填 | string | IOS的推送声音 |
offlinePushInfo.iOSBadgeCount | 选填 | string | IOS推送消息是否计入桌面图标未读数 |
isSendAll | 选填 | boolean | 是否发送给全部人 |
成功返回示例
成功返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,0表示成功 |
errMsg | string | 错误简要信息,无错误时为空 |
errDlt | errDlt | 错误详细信息,无错误时为空 |
data | object | 通用数据对象,具体结构见下方 |
失败返回示例
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
失败返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,具体查看全局错误码文档 |
errMsg | string | 错误简要信息 |
errDlt | errDlt | 错误详细信息 |