JoinMessageGroup - 加入消息组(旧版)

加入消息组。

接口说明

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:JoinMessageGroup

update

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

请求参数

名称

类型

必填

描述

示例值

AppId

string

互动消息应用 ID。

a494caec-***-695ef345db77

GroupId

string

要加入的消息组 ID,请确保传入的 GroupId 是存在的。

AE35-****-T95F

UserId

string

用户 UserId,用户自定义,在 AppId 下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度 32 个字符。不同的用户需要使用不同的 UserId。

de1**a0

BroadCastType

integer

系统消息扩散类型,取值:

  • 0(默认值):不扩散。

  • 1:扩散到指定人。

  • 2:扩散到群组。

2

BroadCastStatistics

boolean

是否扩散统计类消息,打开时在加入消息组后会广播消息组的统计信息,客户端可以接收处理该消息。取值:

  • true:扩散统计类消息。

  • false:不扩散统计类消息。

true

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

16A96B9A-****-CB92E68F4CD8

Result

object

返回结果。

Success

boolean

加入消息组是否成功,取值:

  • true:成功。

  • false:不成功。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "Success": true
  }
}

错误码

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

变更历史

更多信息,参考变更详情