用於建立、更新、查詢和刪除聊天配置,支援DingTalk等平台。
介面說明
請求說明
該 API 主要用於管理和配置與DingTalk等即時通訊工具整合的聊天機器人設定,包括但不限於建立新的聊天配置、更新現有配置、擷取特定配置詳情以及刪除不再需要的配置。通過此 API,可以實現對不同使用者或使用者組許可權的精細化控制,並能夠指定具體的 RAM 角色來執行相關操作。此外,還支援為每個配置添加標籤以便於管理和分類。
特別注意的是,在調用此 API 時,需確保提供的RegionId、ConversationId以及請求體中的各項參數準確無誤,尤其是涉及到安全敏感資訊如ClientId、ClientSecret等欄位時更應謹慎處理,避免泄露給非授權方。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
oos:CreateChatConfiguration |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-hangzhou |
| Name |
string |
否 |
配置名稱。 |
chatops |
| Type |
string |
否 |
聊天平台類型。可能的值:
|
DingTalk |
| RamRole |
string |
否 |
RAM 角色名稱。 |
AliyunOOSDefaultRole |
| Configuration |
string |
否 |
聊天機器人配置資訊,格式為 JSON。 |
("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"} |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmxsn4m4****** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
成功響應的詳細資料 |
||
| RequestId |
string |
請求 ID。 |
4DB0****1234 |
| ChatConfiguration |
object |
聊天配置的詳細資料。 |
{"Name": "TestChatConfig-9be97b40", "CreatedDate": "2025-12-11T13:49:10+00:00", "UpdatedDate": "2025-12-11T13:59:02+00:00"} |
| Name |
string |
聊天配置的名稱。 |
TestChatConfig-9be97b40 |
| CreatedDate |
string |
聊天配置的建立時間。 |
2025-12-11T13:49:10+00:00 |
| UpdatedDate |
string |
聊天配置的最後更新時間。 |
2025-12-11T13:59:02+00:00 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "4DB0****1234",
"ChatConfiguration": {
"Name": "TestChatConfig-9be97b40",
"CreatedDate": "2025-12-11T13:49:10+00:00",
"UpdatedDate": "2025-12-11T13:59:02+00:00"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。