用於建立、更新、查詢和刪除聊天設定，支援釘釘等平台。
介面說明
請求說明
該 API 主要用於管理和設定與釘釘等即時通訊工具整合的聊天機器人設定，包括但不限於建立新的聊天設定、更新現有設定、取得特定設定詳情以及刪除不再需要的設定。透過此 API，可以實現對不同使用者或使用者群組權限的精細化控制，並能夠指定具體的 RAM 角色來執行相關操作。此外，還支援為每個設定新增標籤以便於管理和分類。
特別注意的是，在呼叫此 API 時，需確保提供的 RegionId、ConversationId 以及請求主體中的各項參數準確無誤，尤其是涉及到安全敏感資訊如 ClientId、ClientSecret 等欄位時更應謹慎處理，避免洩露給非授權方。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
oos:GetChatConfiguration |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| Name |
string |
否 |
設定名稱。 |
chatOps-qiwei |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
成功回應的詳細資訊。 |
||
| RequestId |
string |
請求 ID。 |
4DB0****1234 |
| ChatConfiguration |
object |
聊天設定的詳細資訊，包含名稱、類型、RAM 角色等屬性。 |
{ "Name": "chatops", "Type": "DingTalk", "RamRole": "OOSServiceRole", "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"******\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}", "ResourceGroupId": "s", "CreatedDate": "2025-12-26T09:53:02+00:00", "UpdatedDate": "2026-01-07T02:14:55+00:00", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}", "RequestId": "4DB0****1234" } |
| Name |
string |
聊天設定的名稱。 |
chatops |
| Type |
string |
聊天設定的類型。取值：
TODO：該資訊由 AI 根據 API 近期呼叫日誌產生，請確認正確性！ |
DingTalk |
| RamRole |
string |
用於執行操作的 RAM 角色名稱。 |
OOSServiceRole |
| Configuration |
string |
具體的聊天設定內容，格式為 JSON 字串，包含用戶端 ID、金鑰等敏感資訊。 |
{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"} |
| ResourceGroupId |
string |
資源群組 ID，用於識別資源所屬的資源群組。 |
s |
| CreatedDate |
string |
聊天設定的建立時間，格式為 ISO 8601。 |
2025-12-26T09:53:02+00:00 |
| UpdatedDate |
string |
聊天設定的最後更新時間，格式為 ISO 8601。 |
2026-01-07T02:14:55+00:00 |
| Outputs |
string |
聊天設定的輸出資訊，包含 Webhook 位址等參數，格式為 JSON 字串。 |
{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"} |
樣本
正常返回樣本
JSON格式
{
"RequestId": "4DB0****1234",
"ChatConfiguration": {
"Name": "chatops",
"Type": "DingTalk",
"RamRole": "OOSServiceRole",
"Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"******\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}",
"ResourceGroupId": "s",
"CreatedDate": "2025-12-26T09:53:02+00:00",
"UpdatedDate": "2026-01-07T02:14:55+00:00",
"Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。