ListChatGroup - Chat App Message Service - Alibaba Cloud Documentation Center

Retrieves a list of Instant Messaging (IM) groups.

Operation description

Important The feature to retrieve IM group lists using the API is in closed beta on Meta. Contact your account manager to be added to the allowlist.

Before you call this API, ensure that you have created at least one IM group.
If you have not created an IM group, you can only create one by calling the AddChatGroup operation.
The optional parameters for this operation are used to filter the list of IM groups. If you do not specify these parameters, all IM groups are returned.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The business number.	8613800***
ChannelType	string	No	The channel type. Valid value: WHATSAPP Note Only the WhatsApp channel is supported.	WHATSAPP
CustSpaceId	string	Yes	The space ID of the independent software vendor (ISV) sub-customer. This is the channel ID. You can find the channel ID on the Channel Management page.	cams-x***
GroupStatus	string	No	The group status. Valid values: ACTIVE: In use. INACTIVE: Not activated. SUSPENDED: Paused. CREATING: Being created. DELETING: Being deleted. UPDATING: Being updated.	ACTIVE
Subject	string	No	The group title.	test
Page	object	Yes	The paging information.
Size	integer	Yes	The number of entries per page.	20
Index	integer	Yes	The page number.	1

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details about the access denial.	None
Message	string	The message returned. This parameter is returned only when an error occurs.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data.
Total	integer	The total number of entries.	51
List	array<object>	The list of groups.
	object	The group object.
Description	string	The description.	test
BusinessNumber	string	The business number.	8613800**
InviteLink	string	The invitation link.	https://chat.whatsapp.com/***
GroupStatus	string	The group status.	ACTIVE
ProfilePictureFile	string	The group's profile picture.	https://*********/png.jpg
Subject	string	The group title.	This is a test subject
GroupId	string	The group ID.	EA30d***
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: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 51,
    "List": [
      {
        "Description": "test",
        "BusinessNumber": "8613800**",
        "InviteLink": "https://chat.whatsapp.com/***",
        "GroupStatus": "ACTIVE",
        "ProfilePictureFile": "https://*********/png.jpg",
        "Subject": "This is a test subject",
        "GroupId": "EA30d***"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.