CreateLiveMessageGroup - ApsaraVideo Live - Alibaba Cloud Documentation Center

Creates an interactive messaging group.

Operation description

Before you call this operation, make sure that you have called the CreateLiveMessageApp operation to create an interactive messaging application.
You can create up to 5,000 interactive messaging groups in an interactive messaging application.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:CreateLiveMessageGroup	create	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
GroupId	string	Yes	The ID of the group that you want to create. The group ID must be unique within your business. The ID can be up to 64 bytes in length and can contain letters and digits.	grouptest
GroupName	string	No	The name of the group. The name can be up to 128 bytes in length.	mytestgroup
GroupInfo	string	No	The additional information about the group. The value can be up to 32 KB in length.	testgroupinfo
Administrators	array	No	The list of administrators.
	string	No	The ID of the administrator. The ID can be up to 64 bytes in length and can contain letters and digits. Separate multiple administrator IDs with commas (,). You can specify up to three administrator IDs.	uid1
CreatorId	string	No	The ID of the group creator. The ID can be up to 64 bytes in length and can contain letters and digits.	uid1
DataCenter	string	No	The data center. It must be the same as the data center that was specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A8C7B033-B339-1A58-B0E0-7B9197BA****
GroupId	string	The ID of the group created.	grouptest
AlreadyExists	boolean	Indicates whether the group already exists.	true
AlreadyDelete	boolean	Indicates whether the group is deleted. If the group existed and is deleted, the group ID is unavailable. We recommend that you create a new group.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "A8C7B033-B339-1A58-B0E0-7B9197BA****",
  "GroupId": "grouptest",
  "AlreadyExists": true,
  "AlreadyDelete": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
400	ErrorTooManyGroups	%s.	For each AppId, a maximum of 5000 groups are allowed to be created at the same time.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-31	The Error code has changed	View Change Details