调用CreateLiveMessageGroup创建互动消息群组。
接口说明
调用本接口前,您必须已经调用 CreateLiveMessageApp 创建互动消息应用。
单个互动消息应用下最多可创建 5000 个互动消息群组。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:CreateLiveMessageGroup |
create |
*Rtc
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
应用 ID。 |
demo |
| GroupId |
string |
是 |
要创建的群组 ID,业务应保证群组 ID 唯一,由大小写字母、数字组成,长度不超过 64 字节。 |
grouptest |
| GroupName |
string |
否 |
群组名,长度不超过 128 字节。 |
mytestgroup |
| GroupInfo |
string |
否 |
群组扩展信息,长度不超过 32KB。 |
testgroupinfo |
| Administrators |
array |
否 |
管理员用户 ID 列表。 |
|
|
string |
否 |
管理员用户 ID,由大小写字母、数字组成,长度不超过 64 字节。多个用半角逗号(,)隔开,最多不超过 3 个。 |
uid1 |
|
| CreatorId |
string |
否 |
群组创建者 ID,由大小写字母、数字组成,长度不超过 64 字节。 |
uid1 |
| DataCenter |
string |
否 |
数据中心,需要与 CreateLiveMessageApp 中的数据中心一致, 当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。 |
cn-shanghai |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
A8C7B033-B339-1A58-B0E0-7B9197BA**** |
| GroupId |
string |
创建的群组 ID。 |
grouptest |
| AlreadyExists |
boolean |
是否已经存在。 |
true |
| AlreadyDelete |
boolean |
是否已删除。如果已存在,且被删除了,那么群组 ID 是处于不可用状态,建议重新创建。 |
true |
示例
正常返回示例
JSON格式
{
"RequestId": "A8C7B033-B339-1A58-B0E0-7B9197BA****",
"GroupId": "grouptest",
"AlreadyExists": true,
"AlreadyDelete": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 输入参数不合法 |
| 400 | ErrorTooManyGroups | %s. | 每个AppId,最多同时允许创建5000个群组 |
| 500 | ServerError | %s. | 未知错误,请稍后重试或提交工单咨询。 |
| 403 | NoAuth | %s. | 没有权限 |
| 404 | ResourceNotExist | %s. | 请求资源不存在,请检查后重新尝试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。