跳到主要内容

批量发送消息​

简要描述​

  • 批量发送消息。

请求方式​

  • post

请求URL​

  • {API_ADDRESS}/msg/batch_send_msg
header名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪，建议使用时间戳，在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例​

{
    "recvIDs": [
        "9948077346",
        "9371245179"
    ],
    "sendID": "3473643418",
    "senderNickname": "Alice",
    "senderFaceURL": "http://nvpydodr.ae/ylyqu",
    "senderPlatformID": 2,
    "content": {
        "content": "hello!!"
    },
    "contentType": 101,
    "sessionType": 1,
    "isOnlineOnly": false,
    "notOfflinePush": false,
    "sendTime": 1340619319058,
    "offlinePushInfo": {
        "title": "1213",
        "desc": "in eiusmod magna",
        "ex": "ex",
        "iOSPushSound": "in Duis ut sunt nostrud",
        "iOSBadgeCount": true
    },
    "ex": "ex",
    "isSendAll": true
}
字段名选填类型说明
recvIDs选填array接收者ID列表，sessionType1或者4，必填，为接收方用户ID，如果是群聊则不填
sendID必填string发送者ID(可以为管理员ID，可以为用户ID)
senderNickname选填string发送者昵称
senderFaceURL选填string发送者头像
senderPlatformID选填int消息发送者的终端类型，模拟用户发送时填写
content必填object消息的具体内容，内部是json 对象，其他消息的详细字段请参考消息类型格式描述文档
contentType必填int消息类型
sessionType必填int会话类型
isOnlineOnly选填boolean该字段设置为true时候，发送的消息服务器不会存储，接收者在线才会收到，不在线该消息丢失
notOfflinePush选填string该字段设置为true时候，发送的消息在用户离线时将不会进行离线推送
sendTime选填int发送消息时间戳，单位毫秒
offlinePushInfo选填object离线推送的具体内容，如果不填写，使用服务器默认推送标题。notOfflinePush为true时该字段不会使用。
offlinePushInfo.title选填string推送的标题
offlinePushInfo.desc选填string推送的具体描述
offlinePushInfo.ex选填string扩展字段
offlinePushInfo.iOSPushSound选填stringIOS的推送声音
offlinePushInfo.iOSBadgeCount选填stringIOS推送消息是否计入桌面图标未读数
ex选填string扩展字段
isSendAll选填boolean是否发送给全部人

成功返回示例​

{
    "errCode": 0,
    "errMsg": "",
    "errDlt": "",
    "data": {
        "results": [
            {
                "serverMsgID": "b30cb040685c1ff3e92b32d25826a06e",
                "clientMsgID": "ec5792358392cf9168eff64adfa4ac6a",
                "sendTime": 1340619319058,
                "recvID": "imAdmin"
            },
            {
                "serverMsgID": "5f0987ef1bbdcd565c85befb1a084035",
                "clientMsgID": "ec5792358392cf9168eff64adfa4ac6a",
                "sendTime": 1340619319058,
                "recvID": "3473643418"
            },
            {
                "serverMsgID": "9ba70b63487559db1857ce324ae3bcf0",
                "clientMsgID": "ec5792358392cf9168eff64adfa4ac6a",
                "sendTime": 1340619319058,
                "recvID": "9948077346"
            },
            {
                "serverMsgID": "56f483592c3ee9fff1465d9b23277408",
                "clientMsgID": "ec5792358392cf9168eff64adfa4ac6a",
                "sendTime": 1340619319058,
                "recvID": "9371245179"
            },
            {
                "serverMsgID": "ee8b6bbd3190753bc0713c1085ccb479",
                "clientMsgID": "ec5792358392cf9168eff64adfa4ac6a",
                "sendTime": 1340619319058,
                "recvID": "6412123282"
            }
        ],
        "failedUserIDs": null
    }
}

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

参数名类型说明
errCodeint错误码，0表示成功
errMsgstring错误简要信息，为空
errDlterrDlt错误详细信息，为空
dataobject通用数据对象，具体结构见下方
data.resultsarray结果列表
serverMsgIDstring服务器消息ID，预留字段
clientMsgIDstring客户端消息ID，此ID为消息唯一ID
sendTimeint消息发送的时间
recvIDstring接收者ID
data.failedUserIDsarray向其发送消息失败的用户ID列表

失败返回示例​

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

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

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