服务端 API商业版

将会话移出分组

批量将会话从一个或多个会话分组移出。此接口仅在 OpenIM 商业版中提供。请先在接入准备中配置 API 地址和有效 Token。

HTTP 请求

POST {API_ADDRESS}/conversation/remove_conversations_from_groups

请求示例

curl --request POST "${API_ADDRESS}/conversation/remove_conversations_from_groups" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${TOKEN}" \
  --data-raw '{
  "ownerUserID": "user_001",
  "conversationIDs": [
    "si_user_001_user_002"
  ],
  "conversationGroupIDs": [
    "conversation_group_001"
  ]
}'

商业版：此接口需要部署对应的商业版服务。接口是否可用以及具体权限以客户交付版本为准。

请求体

{
  "ownerUserID": "user_001",
  "conversationIDs": ["si_user_001_user_002"],
  "conversationGroupIDs": ["conversation_group_001"]
}

参数名	是否必填	类型	说明
ownerUserID	是	string	资源所属用户 ID。
conversationIDs	是	string[]	OpenIM 会话 ID 列表。
conversationGroupIDs	是	string[]	会话分组 ID 列表。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，`0` 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。

错误

错误响应使用 Platform API 通用结构，处理方式见错误码。

权限和限制

仅在 OpenIM 商业版中提供。
调用方必须校验操作用户和目标资源的业务权限。
请求数组和分页大小应遵循客户交付版本的服务端限制。

HTTP 请求

请求示例

请求体

响应

响应参数

错误

权限和限制

相关页面