ListChatGroup-阿里云帮助中心

Retrieves a list of IM groups.

Operation description

Important Retrieving the IM group list via the API is a beta feature. Contact your account manager to be added to the allowlist.

You must have an IM group before you call this operation.
If you do not have an IM group, you can only create one by calling the AddChatGroup API.
The optional parameters for this operation filter the IM group list. If you do not specify any filters, the operation returns the complete IM group list.

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 instance ID (or SpaceId) of an ISV sub-customer, which also serves as the channel ID. You can find it on the Channel Management page.	cams-x***
GroupStatus	string	No	The group status. Valid values: ACTIVE: In use. INACTIVE: Not activated. SUSPENDED: Suspended. CREATING: Being created. DELETING: Being deleted. UPDATING: Being updated.	ACTIVE
Subject	string	No	The group title.	test
GroupType	string	No	The Telegram group type.	example
GroupLink	string	No	The Telegram group link.	example
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 denied error.	None
Message	string	The response message. 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 group list.
	object	A group object.
Description	string	The group description.	test
BusinessNumber	string	The business number.	8613800**
InviteLink	string	The group 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 subject.	This is a test subject
GroupId	string	The group ID.	EA30d***
GroupLink	string	The group link.	example
TotalParticipantCount	integer	The total number of group participants.	35
GroupType	string	The group type.	example
BusinessRole	string	The role of the bot in the group.	example
GmtModifier	integer	The time the group was last updated.	94
Code	string	The status code. Valid values: `OK`: The request succeeded. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request succeeded. false: The request 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***",
        "GroupLink": "example",
        "TotalParticipantCount": 35,
        "GroupType": "example",
        "BusinessRole": "example",
        "GmtModifier": 94
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.