调用JoinMessageGroup加入消息组。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 JoinMessageGroup

系统规定参数。取值：JoinMessageGroup。

AppId String 是 a494caec-***-695ef345db77

互动消息应用ID。
GroupId String 是 AE35-****-T95F

要加入的消息组ID。
UserId String 是 de1**a0

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

系统消息扩散类型，取值：

  • 0（默认值）：不扩散。
  • 1：扩散到指定人。
  • 2：扩散到群组。
BroadCastStatistics Boolean 否 true

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

  • true：扩散统计类消息。
  • false：不扩散统计类消息。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-****-CB92E68F4CD8

请求ID。
Result Object

返回结果。
Success Boolean true

加入消息组是否成功，取值：

  • true：成功。
  • false：不成功。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=JoinMessageGroup
&AppId=a494caec-***-695ef345db77
&GroupId=AE35-****-T95F
&UserId=de1**a0
&BroadCastType=2
&BroadCastStatistics=true
&公共请求参数

正常返回示例

XML格式 

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

<JoinMessageGroupResponse>
    <RequestId>16A96B9A-****-CB92E68F4CD8</RequestId>
    <Result>
        <Success>true</Success>
    </Result>
</JoinMessageGroupResponse>

JSON格式 

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

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

错误码

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