CreateLiveMessageGroup - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

Before you call this operation, make sure that you 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 and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateLiveMessageGroup	The operation that you want to perform. Set the value to CreateLiveMessageGroup.
AppId	String	Yes	demo	The application ID.
GroupId	String	Yes	grouptest	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.
GroupName	String	No	mytestgroup	The name of the group. The name can be up to 128 bytes in length.
GroupInfo	String	No	testgroupinfo	The additional information about the group. The value can be up to 32 KB in length.
Administrators	Array of String	No	["uid1","uid2"]	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.
CreatorId	String	No	uid1	The ID of the group creator. The ID can be up to 64 bytes in length and can contain letters and digits.
DataCenter	String	No	cn-shanghai	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).

Response parameters

Parameter	Type	Example	Description
RequestId	String	A8C7B033-B339-1A58-B0E0-7B9197BA****	The request ID.
GroupId	String	grouptest	The ID of the group created.
AlreadyExists	Boolean	true	Indicates whether the group already exists.
AlreadyDelete	Boolean	true	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.

Examples

Sample requests

http(s)://live.aliyuncs.com?Action=CreateLiveMessageGroup
&AppId=demo
&GroupId=grouptest
&GroupName=mytestgroup
&GroupInfo=testgroupinfo
&Administrators=["uid1","uid2"]
&CreatorId=uid1
&DataCenter=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateLiveMessageGroupResponse>
    <RequestId>A8C7B033-B339-1A58-B0E0-7B9197BA****</RequestId>
    <GroupId>grouptest</GroupId>
    <AlreadyExists>true</AlreadyExists>
    <AlreadyDelete>true</AlreadyDelete>
</CreateLiveMessageGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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.	One or more parameters are invalid.
400	ErrorTooManyGroups	%s.	The number of groups exceeds the limit. You can create up to 5,000 groups in an application.
403	NoAuth	%s.	You do not have the required permissions.
404	ResourceNotExist	%s.	The requested resource does not exist. Check whether the resource exists and try again.
500	ServerError	%s.	An unknown error occurred. Try again later or submit a ticket.

For a list of error codes, see Service error codes.