Batch Remove IM Group Members with DeleteChatGroupParticipants - Chat App Message Service

Deletes members from an IM group.

Operation description

Important

Deleting IM group members via the API is a beta feature from Meta. Contact your account manager to be added to the allowlist before using this endpoint.

Before you call this operation, ensure that you have created an IM group and an invitation link, and that members have joined the group using the link.
If you have not created an IM group, call the AddChatGroup and AddChatGroupInviteLink operations to create a group and add an invitation link.
After a member is deleted from an IM group, the member will no longer receive messages from the group. Use this operation with caution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:DeleteChatGroupParticipants

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The business number. Call the ListChatGroup operation to view the business numbers.	8613800**
ChannelType	string	No	The channel type. Valid value: WHATSAPP Note Only WhatsApp is supported.	WHATSAPP
GroupId	string	Yes	The group ID. Call the ListChatGroup operation to obtain the group ID.	EA93UU****
CustSpaceId	string	Yes	The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the Channel Management page.	cams-**
List	array<object>	No	A list of group members.
	object	No	Information about a group member.
ParticipantNumber	string	No	The phone number of the group member. Call the ListChatGroupParticipants operation to retrieve a list of current members.	86138***

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The ID of the request.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The status code of the request. Valid values: OK: The request was successful. For a list of other error codes, see Error codes.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	false
Result	integer	The number of rows affected.	20

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": false,
  "Result": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.