跳到主要内容

获取排序后的会话列表​

简要描述​

  • 根据是否置顶、发消息的时间先后获取排序后的会话列表。

请求方式​

  • post

请求URL​

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

请求参数示例​

{
  "userID": "9906953281",
  "conversationIDs": ["si_2699373280_9906953281"],
  "pagination":{
    "pageNumber":1,
    "showNumber":20
    }
}

字段名选填类型说明
userID必填string当前用户ID
conversationIDs选填string会话ID列表，填写后返回指定的会话列表，不填返回默认分页的会话列表
pagination必填string分页参数结构体
pageNumber必填string当前页码，从1开始
showNumber必填string当前页请求数量

成功返回示例​

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "conversationTotal": 2,
    "unreadTotal": 2,
    "conversationElems": [
      {
        "conversationID": "si_110_114",
        "recvMsgOpt": 0,
        "unreadCount": 1,
        "IsPinned": false,
        "msgInfo": {
          "serverMsgID": "c54203436b727117226cb528fc7b08e8",
          "clientMsgID": "c972d53afb9d6b9744f1edfc4ac1aeef",
          "sessionType": 1,
          "sendID": "114",
          "recvID": "110",
          "senderName": "yourNickname",
          "faceURL": "yourFaceURL",
          "groupID": "",
          "groupName": "",
          "groupFaceURL": "",
          "groupType": 0,
          "groupMemberCount": 0,
          "LatestMsgRecvTime": 1695212630741,
          "msgFrom": 200,
          "contentType": 101,
          "content": "{\"content\":\"hello!!\"}",
          "ex":""
        }
      },
      {
        "conversationID": "si_110_111",
        "recvMsgOpt": 0,
        "unreadCount": 1,
        "IsPinned": false,
        "msgInfo": {
          "serverMsgID": "5c3d8542f9eae1487283a5fe335aab1a",
          "clientMsgID": "e09109bdfeb221cec1827317c313e3d0",
          "sessionType": 1,
          "sendID": "111",
          "recvID": "110",
          "senderName": "yourNickname",
          "faceURL": "yourFaceURL",
          "groupID": "",
          "groupName": "",
          "groupFaceURL": "",
          "groupType": 0,
          "groupMemberCount": 0,
          "LatestMsgRecvTime": 1695212630740,
          "msgFrom": 200,
          "contentType": 101,
          "content": "{\"content\":\"hello!!\"}",
          "ex":""
        }
      }
    ]
  }
}

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

字段名类型说明
errCodeint错误码，0表示成功
errMsgstring错误简要信息，为空
errDlterrDlt错误详细信息，为空
unreadTotalstring未读数总数
conversationToalstring会话数总数
dataobject通用数据对象，具体结构见下方
conversationElemsarray无
conversationIDstring会话ID
recvMsgOptstring群聊消息免打扰
unreadCountstring未读消息数
msgInfoobject消息内容
serverMsgIDstring服务器消息ID
clientMsgIDstring客户端消息ID
sessionTypestring会话类型，发送的消息是单聊还是群聊,单聊为1，群聊（普通写扩散）为2,大群(读扩散接口)为3，通知会话为4
recvIDstring接收者ID
SendIDstring发送者ID
faceURLstring头像URL。在单聊中，当发送者为当前用户时，该字段为好友头像URL
senderNamestring发送者呢称。在单聊中，当发送者为当前用户时，该字段为好友呢称。在群聊中，该字段为对应的发送者呢称
LatestMsgRecvTimestring最后一条消息的接收时间
msgFromstring消息来源，100来源于用户发送，200来源于管理员发送或者系统广播通知等
contentobject消息的具体内容，内部是json 对象，其他消息的详细字段请参考消息类型格式描述文档
contentTypeint消息类型
groupIDstring群聊ID
groupNamestring群聊名称
groupFaceURLstring群聊头像URL
groupMemberCountstring群聊人数
IsPinnedstring会话是否置顶
exstring拓展字段

失败返回示例​

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

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

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