全部產品
Search

搜尋本產品

    Chat App Message Service：ListChatGroupParticipants - IM群成員列表

    文件中心

    Chat App Message Service：ListChatGroupParticipants - IM群成員列表

    更新時間：Jun 09, 2026

    擷取IM群成員列表。

    介面說明

    重要 通過 API 擷取 IM 群成員列表功能屬於 Meta 內測功能，請聯絡您的商務經理申請加白。

    • 在調用此介面之前，請確保您建立成功的 IM 群已添加 IM 群邀請連結且已有成員通過連結進入 IM 群。

    • 若您沒有已建立成功的 IM 群，可通過 AddChatGroup 、 AddChatGroupInviteLink 介面建立並添加 IM 群邀請連結。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:ListChatGroupParticipants

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BusinessNumber

    string

    是

    商家號碼。可通過 ListChatGroup 介面查看商家號碼。

    8613800***
    ChannelType

    string

    否

    類型。取值：

    • WHATSAPP

    說明

    暫僅支援 WhatsApp 通道類型訊息。

    WHATSAPP
    GroupId

    string

    是

    群組 ID。可通過 ListChatGroup 介面查看群組 ID。

    EA939****
    CustSpaceId

    string

    是

    ISV 子客戶的 SpaceId/執行個體 ID。即通道 ID，在通道管理介面查看。

    cams-k***
    Page

    object

    否

    分頁資訊。

    Size

    integer

    否

    每頁顯示數量。

    20
    Index

    integer

    否

    頁數。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    AccessDeniedDetail

    string

    訪問被拒絕詳細資料。

    None
    Message

    string

    錯誤提示資訊。

    None
    RequestId

    string

    請求 ID。

    90E63D28-E31D-1EB2-8939-A94866411B2O
    Data

    object

    返回資料。

    Total

    integer

    總記錄條數。

    8
    List

    array<object>

    群組成員列表。

    object

    群組成員資訊。

    ParticipantNumber

    string

    群組成員。

    861382***
    Code

    string

    請求狀態代碼。取值：

    OK
    Success

    boolean

    是否調用成功。取值：

    • true：調用成功。

    • false：調用失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 8,
    "List": [
      {
        "ParticipantNumber": "861382***"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

    錯誤碼

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

    變更歷史

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