Build IM Groups via AddChatGroup API - Chat App Message Service

Creates an Instant Messaging (IM) group.

Operation description

Important

This API is in beta testing for Meta. Contact your account manager to be added to the allowlist before using this endpoint.

Currently, you can create IM groups only using the API.
After you create a group, call the AddChatGroupInviteLink operation to generate an invitation link and invite members to the group.
A WhatsApp group can have a maximum of 8 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 mobile phone number.	8613800***
Description	string	No	The group description.	This is a new group
Subject	string	Yes	The group title.	Test
CustSpaceId	string	Yes	The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the Channel Management page.	cams-***
ChannelType	string	No	The channel type. Valid value: WHATSAPP. Note Only the WhatsApp channel type is supported.	WHATSAPP

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
UniqueCode	string	The unique code for the request.	8938****
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The status code of the request. 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.	false

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.