查詢聊天配置 - 系統營運管理 - 阿里雲 - CloudOps Orchestration Service

介面說明

請求說明

該 API 主要用於管理和設定與釘釘等即時通訊工具整合的聊天機器人設定，包括但不限於建立新的聊天設定、更新現有設定、取得特定設定詳情以及刪除不再需要的設定。透過此 API，可以實現對不同使用者或使用者群組權限的精細化控制，並能夠指定具體的 RAM 角色來執行相關操作。此外，還支援為每個設定新增標籤以便於管理和分類。

特別注意的是，在呼叫此 API 時，需確保提供的 RegionId、ConversationId 以及請求主體中的各項參數準確無誤，尤其是涉及到安全敏感資訊如 ClientId、ClientSecret 等欄位時更應謹慎處理，避免洩漏給非授權方。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oos:ListChatConfigurations

create

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地域 ID。	cn-hangzhou
Filters	array<object>	否	篩選條件清單，用於篩選聊天設定。	[{"Name": "status", "Value": "inactive"}, {"Name": "type", "Value": "private"}]
	object	否	篩選條件項目，包含名稱和值。	{"Name": "status", "Value": "inactive"}
Name	string	否	篩選條件的名稱。	status
Value	string	否	篩選條件的具體值。	inactive
MaxResults	integer	否	分頁查詢時每頁列數。	10
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫傳回的 NextToken 參數值。	AQEBARoBBgEAAgIBBQ==

返回參數

名稱	類型	描述	樣本值
	object	成功回應的詳細資訊。
RequestId	string	請求 ID。	4DB0****1234
ChatConfigurations	array<object>	聊天設定清單。	[{"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}]}
	object	單一聊天設定資訊。	{"Name": "test-wechat", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}"}
Name	string	聊天設定名稱。	test-wechat
CreatedDate	string	聊天設定建立時間，採用 ISO 8601 格式，時區為 UTC。	2025-12-10T10:09:32+00:00
UpdatedDate	string	聊天設定最後更新時間，採用 ISO 8601 格式，時區為 UTC。	2025-12-28T13:59:48+00:00
RamRole	string	用於執行操作的 RAM 角色名稱。	OOSServiceRole
Type	string	聊天設定類型。取值： WeChat：企業微信。 DingTalk：釘釘。 TODO：該資訊由 AI 根據 API 近期呼叫日誌產生，請確認正確性！	WeChat
Outputs	string	輸出資訊，包含 Webhook URL 和加密金鑰。	{"URL": "https://1407907063606569.appflow.aliyunnes", "AesKey": "UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF"}

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4DB0****1234",
  "ChatConfigurations": [
    {
      "Name": "test-wechat",
      "CreatedDate": "2025-12-10T10:09:32+00:00",
      "UpdatedDate": "2025-12-28T13:59:48+00:00",
      "RamRole": "OOSServiceRole",
      "Type": "WeChat",
      "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\", \"AesKey\": \"UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF\"}"
    }
  ]
}

錯誤碼

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

變更歷史

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