全部產品
Search
文件中心

ApsaraVideo Live:JoinMessageGroup

更新時間:Jun 09, 2026

加入訊息群組。

介面說明

本介面的單一使用者 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
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情