OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

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

Set conversation group order

Copy

Set the display order of multiple conversation groups for a user.

HTTP request

POST {API_ADDRESS}/conversation/set_conversation_group_order

Request example

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

Request body

ParameterRequiredTypeDescription
ownerUserIDYesstringUser who owns the groups.
ordersYesConversationGroupOrder[]Group IDs and their target order values. See ConversationGroupOrder.

Response

The common response has errCode: 0 when the order was updated successfully.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Supply each target group at most once.