使用CreateChatConfiguration API创建钉钉聊天配置-系统运维管理-阿里云-阿里云帮助中心

接口说明

请求说明

该 API 主要用于管理和配置与钉钉等即时通讯工具集成的聊天机器人设置，包括但不限于创建新的聊天配置、更新现有配置、获取特定配置详情以及删除不再需要的配置。通过此 API，可以实现对不同用户或用户组权限的精细化控制，并能够指定具体的 RAM 角色来执行相关操作。此外，还支持为每个配置添加标签以便于管理和分类。

特别注意的是，在调用此 API 时，需确保提供的RegionId、ConversationId以及请求体中的各项参数准确无误，尤其是涉及到安全敏感信息如ClientId、ClientSecret等字段时更应谨慎处理，避免泄露给非授权方。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

oos:CreateChatConfiguration

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
Name	string	否	配置名称。	chatops
Type	string	否	聊天平台类型。可能的值： DingTalk：钉钉。 WeChat：微信。	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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。