GetChatConfiguration - CloudOps Orchestration Service: Central de Documentação do Alibaba Cloud

Cria, atualiza, consulta e exclui configurações de chat para plataformas como DingTalk.

Descrição da operação

Esta operação de API é usada para gerenciar e configurar definições de chatbot integradas a ferramentas de mensagens instantâneas, como o DingTalk. As operações suportadas incluem a criação de configurações de chat, a atualização de configurações existentes, a obtenção de detalhes específicos de configuração e a exclusão de configurações que não são mais necessárias. Você pode usar esta operação de API para implementar controle de acesso refinado para diferentes usuários ou grupos de usuários e especificar funções RAM para executar operações relacionadas. Você também pode adicionar tags a cada configuração para facilitar o gerenciamento e a categorização.

Ao chamar esta operação de API, certifique-se de que os parâmetros RegionId, ConversationId e outros no corpo da solicitação estejam corretos. Tenha cuidado ao manipular campos sensíveis à segurança, como ClientId e ClientSecret, para evitar divulgação não autorizada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

oos:GetChatConfiguration

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-hangzhou
Name	string	Não	O nome da configuração.	chatOps-qiwei

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes da resposta bem-sucedida.
RequestId	string	O ID da solicitação.	4DB0****1234
ChatConfiguration	object	Os detalhes da configuração de chat, incluindo nome, tipo, função RAM e outras propriedades.	{ "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	O nome da configuração de chat.	chatops
Type	string	O tipo da configuração de chat. Valores válidos: DingTalk: Configuração do DingTalk. WeChat: Configuração do WeCom. TODO: Estas informações são geradas por IA com base em logs recentes de chamadas de API. Confirme a precisão destas informações.	DingTalk
RamRole	string	O nome da função RAM usada para executar operações.	OOSServiceRole
Configuration	string	O conteúdo da configuração de chat em formato de string JSON, que contém informações sensíveis, como ID do cliente e segredo.	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	O ID do grupo de recursos que identifica o grupo de recursos ao qual o recurso pertence.	s
CreatedDate	string	A hora em que a configuração de chat foi criada, no formato ISO 8601.	2025-12-26T09:53:02+00:00
UpdatedDate	string	A hora em que a configuração de chat foi atualizada pela última vez, no formato ISO 8601.	2026-01-07T02:14:55+00:00
Outputs	string	As informações de saída da configuração de chat em formato de string JSON, que contêm parâmetros como a URL do webhook.	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

Exemplos

Resposta de sucesso

JSON formato

{
  "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/\"}"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.