跳到主要内容

批量发送消息​

简要描述​

  • 批量发送消息。

请求方式​

  • post

请求URL​

  • http://x.x.x.x:10002/msg/batch_send_msg
header名示例值选填类型说明
operationID1646445464564必填stringoperationID用于全局链路追踪
tokeneyJhbxxxx3Xs必填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选填stringIOS的推送声音
offlinePushInfo.iOSBadgeCount选填stringIOS推送消息是否计入桌面图标未读数
isSendAll选填boolean是否发送给全部人

成功返回示例​


成功返回示例的参数说明​

参数名类型说明
errCodeint错误码,0表示成功
errMsgstring错误简要信息,无错误时为空
errDlterrDlt错误详细信息,无错误时为空
dataobject通用数据对象，具体结构见下方

失败返回示例​

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明​

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息