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.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:CreateLiveMessageGroup |
create |
*Rtc
|
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 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 is deleted, the group ID is unavailable. We recommend that you create a new group. |
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. | For each AppId, a maximum of 5000 groups are allowed to be created at the same time. |
| 500 | ServerError | %s. | Unknown error, please try again later or submit a ticket for consultation. |
| 403 | NoAuth | %s. | No permission |
| 404 | ResourceNotExist | %s. | The requested resource does not exist, please check and try again |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.