用于创建、更新、查询和删除聊天配置,支持钉钉等平台。
接口说明
请求说明
该 API 主要用于管理和配置与钉钉等即时通讯工具集成的聊天机器人设置,包括但不限于创建新的聊天配置、更新现有配置、获取特定配置详情以及删除不再需要的配置。通过此 API,可以实现对不同用户或用户组权限的精细化控制,并能够指定具体的 RAM 角色来执行相关操作。此外,还支持为每个配置添加标签以便于管理和分类。
特别注意的是,在调用此 API 时,需确保提供的RegionId、ConversationId以及请求体中的各项参数准确无误,尤其是涉及到安全敏感信息如ClientId、ClientSecret等字段时更应谨慎处理,避免泄露给非授权方。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
| Name |
string |
否 |
聊天配置名称。 |
Ginlong-AIops |
| Type |
string |
否 |
聊天平台类型。可能的值:
|
DingTalk |
| RamRole |
string |
否 |
RAM 角色名称。 |
AliyunOOSLifecycleHook4CSRole |
| Configuration |
string |
否 |
聊天配置的具体参数,通常为 JSON 格式。 |
("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"} |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-2cd3****9dc2 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
成功响应的详细信息 |
||
| RequestId |
string |
请求 ID。 |
4DB0****1234 |
| ChatConfiguration |
object |
聊天配置信息,包含配置名称、创建时间及更新时间。 |
{"Name": "dingtalk", "CreatedDate": "2025-12-23T10:14:28+00:00", "UpdatedDate": "2025-12-23T10:16:37.178097"} |
| Name |
string |
配置名称。 |
dingtalk |
| CreatedDate |
string |
配置创建时间,ISO8601 格式。 |
2025-12-23T10:14:28+00:00 |
| UpdatedDate |
string |
配置最后更新时间,ISO8601 格式。 |
2025-12-23T10:16:37.178097 |
示例
正常返回示例
JSON格式
{
"RequestId": "4DB0****1234",
"ChatConfiguration": {
"Name": "dingtalk",
"CreatedDate": "2025-12-23T10:14:28+00:00",
"UpdatedDate": "2025-12-23T10:16:37.178097"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。