Create Live Messaging Groups with CreateLiveMessageGroup API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

Before you call this operation, call 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, which may cause service interruptions. Take note of this limit when you call this operation.

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

live:CreateLiveMessageGroup

create

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	demo
GroupId	string	Yes	The ID of the group 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, which must match the one specified when you called the CreateLiveMessageApp operation. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai

Response elements

Element	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 has been deleted, the group ID is unavailable. Create a new group instead.	true

Examples

Success response

JSON format

{
  "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.	A maximum of 5,000 groups can be created for each AppId.
500	ServerError	%s.	An unknown error occurred. Try again later or submit a ticket.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist. Verify the resource and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.