Platform APIEnterprise

Create a conversation group

Create a conversation group for a user and optionally add one conversation to it. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/conversation/create_conversation_group

Request example

curl --request POST "${API_ADDRESS}/conversation/create_conversation_group" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" \
  --data-raw '{"ownerUserID":"user_001","name":"Priority","order":1,"ex":"{}","conversationID":"si_user_001_user_002","conversationGroupType":1}'

Enterprise: This endpoint requires the corresponding OpenIM Enterprise services.

Request body

Parameter	Required	Type	Description
ownerUserID	Yes	string	User who owns the group.
name	Yes	string	Display name.
order	Yes	int	Display order.
ex	No	string	Business extension data.
conversationID	No	string	Conversation to add when creating the group.
conversationGroupType	Yes	ConversationGroupType	`0`: normal group; `1`: filter group.

Response

data.group contains the created ConversationGroup, including its ID, conversations, type, order, version, and creation time.

Errors

See Error codes.

Permissions and limits

Available only in OpenIM Enterprise.
The caller must validate its authority over ownerUserID and the optional conversation.

Was this page helpful?