OpenIM文档

输入至少两个字符来搜索标题和路径。

简中

语言

ENEnglishEnglish docs简中简体中文中文文档
浏览 平台 API
服务端 API

批量获取会话

复制

使用 批量获取会话 从可信后端调用 OpenIM 会话 REST 接口。批量获取指定用户的一组会话记录。 请先在接入准备中配置 API 地址和管理员 Token；接口参数通过请求头和 JSON 请求体传递。

HTTP 请求

POST {API_ADDRESS}/conversation/get_conversations

请求示例

curl --request POST "${API_ADDRESS}/conversation/get_conversations" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "ownerUserID": "user_001",
  "conversationIDs": [
    "si_user_001_user_002"
  ]
}'
安全提示：管理员 Token 只能保存在可信后端服务中，不能下发到客户端或写入前端代码。客户端登录应使用服务端签发的用户 Token。

参数

此接口通过请求头传入链路追踪信息和鉴权凭证，通过 JSON 请求体传递业务参数。

请求头

Header是否必填类型说明
operationID是string每次请求的唯一链路追踪 ID，建议由后端生成并写入日志。
token是stringAPP 管理员 Token；仅保存在可信后端服务中。
Content-Type: application/json是string请求体为 JSON 时必须设置。

请求体

{
  "ownerUserID": "user_001",
  "conversationIDs": [
    "si_user_001_user_002"
  ]
}
参数名是否必填类型说明
ownerUserID是string会话所属用户 ID。
conversationIDs是array要查询的会话 ID 列表。
hash 商业版否uint64调用方已有会话集合的哈希值；不传时按普通查询处理。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "conversations": [
      {
        "ownerUserID": "user_001",
        "conversationID": "si_user_001_user_002",
        "recvMsgOpt": 0,
        "conversationType": 1,
        "userID": "user_002",
        "groupID": "",
        "isPinned": false,
        "attachedInfo": "",
        "isPrivateChat": false,
        "groupAtType": 0,
        "ex": "",
        "burnDuration": 0,
        "minSeq": 0,
        "maxSeq": 128,
        "msgDestructTime": 0,
        "latestMsgDestructTime": 0,
        "isMsgDestruct": false
      }
    ]
  }
}

响应参数

参数名类型说明
errCodeint业务错误码，0 表示成功。
errMsgstring错误简要信息，成功时通常为空。
errDltstring错误详细信息，成功时通常为空。
dataobject接口返回数据。
data.conversationsarray会话列表，结构为会话模块的 ConversationInfo。
data.hash 商业版uint64服务端返回的会话集合哈希值，可用于后续查询。

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}
错误场景可能原因处理方式
鉴权失败token 缺失、过期，或不是可调用管理端接口的管理员 Token。重新获取 APP 管理员 Token，并只在可信后端保存。
链路追踪困难operationID 缺失或在大量请求中重复使用。为每次请求生成独立 operationID，并在服务端日志中保留。
参数校验失败请求体字段类型、必填字段或枚举值不符合接口要求。对照请求体参数表和限制说明检查字段。

权限和限制

  • 只读查询，不改变会话状态。
  • ownerUserID 和 conversationIDs 必填。
  • conversationIDs 不要传重复值。
  • 所有数组型请求参数建议控制在 1000 个元素以内。

相关页面