OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

List conversation groups

Copy

Get a user's conversation groups and their synchronization version. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/conversation/get_conversation_groups

Request example

curl --request POST "${API_ADDRESS}/conversation/get_conversation_groups" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" \
  --data-raw '{"ownerUserID":"user_001","maxVersion":1}'

Request body

ParameterRequiredTypeDescription
ownerUserIDYesstringUser who owns the groups.
maxVersionNoInt64ValueHighest group version already known by the caller.

Response

PropertyTypeDescription
data.groupsConversationGroup[]Group records. See ConversationGroup.
data.maxVersionintHighest version represented by this result.
data.fullboolWhether the result is a full snapshot.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Treat full and maxVersion as synchronization metadata; do not infer a full snapshot from an empty array alone.