全部產品
Search

搜尋本產品

    Chat App Message Service：ListChatGroup

    文件中心

    Chat App Message Service：ListChatGroup

    更新時間：Jun 30, 2026

    取得 IM 群列表。

    介面說明

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

    • 在呼叫此介面前，請確保您已有建立成功的 IM 群。

    • 若您沒有已建立成功的 IM 群，暫僅支援透過 AddChatGroup 介面建立 IM 群。

    • 此介面的非必填參數為 IM 群列表的篩選條件，若不填寫，則查詢全部 IM 群列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:ListChatGroup

    list

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    BusinessNumber

    string

    是

    商家號碼。

    8613800***
    ChannelType

    string

    否

    類型。取值：WHATSAPP。

    說明

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

    WHATSAPP
    CustSpaceId

    string

    是

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

    cams-x***
    GroupStatus

    string

    否

    群組狀態。取值：

    • ACTIVE：使用中。

    • INACTIVE：未啟用。

    • SUSPENDED：已暫停。

    • CREATING：建立中。

    • DELETING：刪除中。

    • UPDATING：更新中。

    ACTIVE
    Subject

    string

    否

    群組標題。

    test
    GroupType

    string

    否

    telegram 群組類型。

    example
    GroupLink

    string

    否

    telegram 群組地址。

    example
    Page

    object

    是

    分頁資訊。

    Example value
    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

    總記錄條數。

    51
    List

    array<object>

    群組列表。

    object

    群組物件。

    Description

    string

    描述。

    test
    BusinessNumber

    string

    商家號碼。

    8613800**
    GroupStatus

    string

    群組狀態。

    ACTIVE
    ProfilePictureFile

    string

    群組頭像。

    https://*********/png.jpg
    Subject

    string

    群組標題。

    This is a test subject
    GroupId

    string

    群組 ID。

    EA30d***
    TotalParticipantCount

    integer

    群成員數量

    35
    GroupType

    string

    群類型

    example
    BusinessRole

    string

    機器人在群中角色

    example
    GmtModifier

    integer

    更新時間

    94
    Code

    string

    請求狀態碼。取值：

    OK
    Success

    boolean

    是否呼叫成功。取值：

    • true：呼叫成功。

    • false：呼叫失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Total": 51,
    "List": [
      {
        "Description": "test",
        "BusinessNumber": "8613800**",
        "InviteLink": "https://chat.whatsapp.com/***",
        "GroupStatus": "ACTIVE",
        "ProfilePictureFile": "https://*********/png.jpg",
        "Subject": "This is a test subject",
        "GroupId": "EA30d***",
        "GroupLink": "example",
        "TotalParticipantCount": 35,
        "GroupType": "example",
        "BusinessRole": "example",
        "GmtModifier": 94
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

    錯誤碼

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

    變更歷史

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