JoinMessageGroup - - Alibaba Cloud Documentation Center

Operation description

The QPS limit for this API is 200 calls per second per user. If this limit is exceeded, API calls will be throttled, which may affect your business. Please use this API responsibly.

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 support 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

live:JoinMessageGroup

update

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	Interactive message application ID.	a494caec-***-695ef345db77
GroupId	string	Yes	The ID of the message group to join. Make sure the GroupId you provide exists.	AE35-****-T95F
UserId	string	Yes	User ID, which is customized by the user and must be unique under the AppId. It can contain lowercase letters, numbers, underscores (_), and periods (.). The maximum length is 32 characters. Different users must use different UserIds.	de1**a0
BroadCastType	integer	No	System message diffusion type. Valid values: 0 (default): No diffusion. 1: Diffusion to specified users. 2: Diffusion to the group.	2
BroadCastStatistics	boolean	No	Specifies whether to broadcast statistics messages. When enabled, statistics information of the message group will be broadcast after joining the message group, and the client can receive and process this message. Valid values: true: Broadcast statistics messages. false: Do not broadcast statistics messages.	true

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	16A96B9A-****-CB92E68F4CD8
Result	object	Return result.
Success	boolean	Indicates whether joining the message group was successful. Valid values: true: Successful. false: Unsuccessful.	true

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "Success": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.