ListChatGroupParticipants - Chat App Message Service - Alibaba Cloud Documentation Center

Operation description

Important Listing IM group members using an API is a beta feature from Meta. Contact your account manager to request access.

Before you call this operation, make sure 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, you can call the AddChatGroup and AddChatGroupInviteLink operations to create a group and 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The business number. Call the ListChatGroup operation to view the business number.	8613800***
ChannelType	string	No	The type. Valid value: WHATSAPP Note Only messages on the WhatsApp channel are supported.	WHATSAPP
GroupId	string	Yes	The group ID. Call the ListChatGroup operation to view the group ID.	EA939****
CustSpaceId	string	Yes	The SpaceId or instance ID of the independent software vendor (ISV) sub-customer. This is the channel ID. 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 is successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	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.