ListMessageGroup - ApsaraVideo Live

呼叫ListMessageGroup查詢指定使用者下訊息群組清單。

介面說明

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理呼叫。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:ListMessageGroup

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
UserId	string	否	使用者 UserId，使用者自訂，在 AppId 下單獨唯一。不同的使用者需要使用不同的 UserId。說明正確填寫此參數內容，才能正常查詢。	de1**a0
AppId	string	否	互動訊息應用 ID。說明正確填寫此參數內容，才能正常查詢。	VKL3***
SortType	integer	否	排列方式，取值： 0：時間遞增順序。 1：時間遞減順序。	1
PageNum	integer	是	頁碼，預設值：1。取值範圍：1~100000。	10
PageSize	integer	是	單頁顯示訊息群組的數量，預設值：20。取值範圍：1~50。	20

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	16A96B9A-****-CB92E68F4CD8
Result	object	傳回結果。
GroupList	array<object>	訊息群組清單。
	array<object>	訊息群組詳情。
AppId	string	Interactive Messages application ID.	VKL3***
CreateTime	integer	UTC timestamp when the message group was created.	1502280113
CreatorId	string	Creator ID.	as****hs
Extension	object	Extension field.
	string	Extension field.	test001
GroupId	string	Message group ID.	AE35-****-T95F
Status	integer	Message group status. The default value is 1, indicating that the message group status is normal.	1
HasMore	boolean	是否還有下一頁，取值： true：有下一頁。 false：沒有下一頁。	false
Total	integer	訊息群組總數。	5

樣本

正常返回樣本

JSON格式

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "GroupList": [
      {
        "AppId": "VKL3***",
        "CreateTime": 1502280113,
        "CreatorId": "as****hs",
        "Extension": {
          "key": "test001"
        },
        "GroupId": "AE35-****-T95F",
        "Status": 1
      }
    ],
    "HasMore": false,
    "Total": 5
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。