AddChatGroup-阿里云帮助中心

Operation description

Important Creating IM groups via the API is a feature in closed beta testing by Meta. Please contact your account manager to be added to the allowlist.

You can only create an IM group by calling this API.
After creating an IM group, you can call the AddChatGroupInviteLink API to generate an invite link.
For the WhatsApp channel type, an IM group is limited to eight members.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessNumber	string	Yes	The phone number associated with the business account.	8613800***
Description	string	No	The group description.	This is a newly created group
Subject	string	No	The group title.	test
CustSpaceId	string	Yes	The SpaceId or instance ID of the ISV sub-customer, which is the channel ID. Find it on the Channel Management page.	cams-***
ChannelType	string	No	The channel type. Valid value: WHATSAPP Note Currently, only the WhatsApp channel type is supported.	WHATSAPP
GroupLink	string	No	The link to the WhatsApp group.	https://t.me/testgroup

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details of the access denial.	None
UniqueCode	string	The unique request code.	8938****
Message	string	The response message.	None
RequestId	string	The unique identifier for the request.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The response status code. Valid values: `OK`: The request was successful. For other error codes, see the error code list.	OK
Success	boolean	Indicates if the API call succeeded. Valid values: true: The API call was successful. false: The API call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "UniqueCode": "8938****",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.