跳到主要内容

发送消息​

简要描述​

  • 以某人身份向指定用户或群组发送消息，也可用于从其他平台导入历史消息。

请求方式​

  • post

请求URL​

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

请求参数示例​

{
  "sendID": "openIMAdmin",
  "recvID": "2839678182",
  "content": {
    "content": "hello!!"
  },
  "contentType": 101,
  "sessionType": 1,
  "isOnlineOnly": false,
  "notOfflinePush": false,
  "sendTime": 1695212630740,
  "offlinePushInfo": {
    "title": "send message",
    "desc": "",
    "ex": "",
    "iOSPushSound": "default",
    "iOSBadgeCount": true
  },
  "ex": "ex"
}
字段名选填类型说明
sendID必填string系统通知号ID，或用户ID
recvID必填string接收者ID，单聊填userID，群聊填groupID
senderPlatformID选填int消息发送者的终端类型，默认为10
content必填object消息的具体内容，内部是json对象，contentType 设置不同的json对象 参考消息类型
contentType必填int消息类型
sessionType必填int会话类型
isOnlineOnly选填boolean接收者接收消息选项，默认为false，用户离线在线都会收到；否则，仅在线才收到
notOfflinePush选填boolean离线推送设置，默认为false，进行离线推送；否则，不进行离线推送
sendTime选填int消息发送时间，单位毫秒，一般在导入历史消息时填写
offlinePushInfo选填object离线推送的具体内容，如果不填写，使用服务器默认推送信息。notOfflinePush为false时生效
offlinePushInfo.title选填string离线推送的标题
offlinePushInfo.desc选填string离线推送的具体描述
offlinePushInfo.ex选填string离线推送扩展字段
offlinePushInfo.iOSPushSound选填stringIOS的离线推送声音
offlinePushInfo.iOSBadgeCount选填booleanIOS离线推送消息是否计入桌面图标未读数
ex选填string扩展字段

成功返回示例​

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "serverMsgID": "8698dd5d163dd79b8fdfa333fee06f40",
    "clientMsgID": "1ca0e4cf279ad5cce6b28331b2b42092",
    "sendTime": 1679558586210
  }
}

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

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

失败返回示例​

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

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

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