CreateLiveMessageGroup - 创建直播互动群组

调用CreateLiveMessageGroup创建互动消息群组。

接口说明

  • 调用本接口前,您必须已经调用 CreateLiveMessageApp 创建互动消息应用。
  • 单个互动消息应用下最多可创建 5000 个互动消息群组。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:CreateLiveMessageGroupcreate
  • Rtc
    acs:live::{#accountId}:rtc/{#AppId}

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

demo
GroupIdstring

要创建的群组 ID,业务应保证群组 ID 唯一,由大小写字母、数字组成,长度不超过 64 字节。

grouptest
GroupNamestring

群组名,长度不超过 128 字节。

mytestgroup
GroupInfostring

群组扩展信息,长度不超过 32KB。

testgroupinfo
Administratorsarray

管理员用户 ID 列表。

string

管理员用户 ID,由大小写字母、数字组成,长度不超过 64 字节。多个用半角逗号(,)隔开,最多不超过 3 个。

uid1
CreatorIdstring

群组创建者 ID,由大小写字母、数字组成,长度不超过 64 字节。

uid1
DataCenterstring

数据中心,需要与 CreateLiveMessageApp 中的数据中心一致, 当前支持上海(取值为 cn-shanghai)、新加坡(取值为 ap-southeast-1)。

cn-shanghai

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

A8C7B033-B339-1A58-B0E0-7B9197BA****
GroupIdstring

创建的群组 ID。

grouptest
AlreadyExistsboolean

是否已经存在。

true
AlreadyDeleteboolean

是否已删除。如果已存在,且被删除了,那么群组 ID 是处于不可用状态,建议重新创建。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InputInvalid%s.输入参数不合法
400ErrorTooManyGroups%s.每个AppId,最多同时允许创建5000个群组
403NoAuth%s.没有权限
404ResourceNotExist%s.请求资源不存在,请检查后重新尝试
500ServerError%s.未知错误,请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-31OpenAPI 错误码发生变更查看变更详情