Query IM Group Participants with ListChatGroupParticipants API - Chat App Message Service

Retrieves members in an IM group.

Operation description

Important

This API is in internal preview. Contact your account manager to request access.

Before you call this operation, make sure that you have created an IM group, added an invitation link to the group, and that members have joined the group through 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.

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:ListChatGroupParticipants

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The business number. You can call the ListChatGroup operation to view the business number.	8613800***
ChannelType	string	No	The type. Valid value: WHATSAPP Note Only the WhatsApp channel is supported.	WHATSAPP
GroupId	string	Yes	The group ID. You can call the ListChatGroup operation to view the group ID.	EA939****
CustSpaceId	string	Yes	The Space ID of the independent software vendor (ISV) sub-customer or the instance ID of the direct customer. You can view it on the Channel Management page.	cams-k***
Page	object	No	The paging information.
Size	integer	No	The number of entries per page.	20
Index	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data.
Total	integer	The total number of records.	8
List	array<object>	The list of group members.
	object	The information about a group member.
ParticipantNumber	string	The group member.	861382***
Code	string	The request status code. Valid values: OK: The request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 8,
    "List": [
      {
        "ParticipantNumber": "861382***"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.