GetChatConfiguration - CloudOps Orchestration Service - Centro de documentación de Alibaba Cloud

Crea, actualiza, consulta y elimina configuraciones de chat para plataformas como DingTalk.

Descripción de la operación

Esta operación de API se utiliza para administrar y configurar los ajustes del chatbot integrados con herramientas de mensajería instantánea como DingTalk. Las operaciones admitidas incluyen crear configuraciones de chat, actualizar configuraciones existentes, obtener detalles de configuraciones específicas y eliminar configuraciones que ya no son necesarias. Puede utilizar esta operación de API para implementar un control de acceso detallado para diferentes usuarios o grupos de usuarios y especificar roles de RAM para realizar las operaciones relacionadas. También puede agregar etiquetas a cada configuración para facilitar su administración y categorización.

Cuando invoque esta operación de API, asegúrese de que RegionId, ConversationId y otros parámetros en el cuerpo de la solicitud sean correctos. Tenga precaución al manejar campos sensibles a la seguridad, como ClientId y ClientSecret, para evitar divulgaciones no autorizadas.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

oos:GetChatConfiguration

create

*All Resource.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	No	El ID de la región.	cn-hangzhou
Name	string	No	El nombre de la configuración.	chatOps-qiwei

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los detalles de la respuesta exitosa.
RequestId	string	El ID de la solicitud.	4DB0****1234
ChatConfiguration	object	Los detalles de la configuración de chat, incluido el nombre, el tipo, el rol de RAM y otras propiedades.	{ "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	El nombre de la configuración de chat.	chatops
Type	string	El tipo de la configuración de chat. Valores válidos: DingTalk: Configuración de DingTalk. WeChat: Configuración de WeCom. TODO: Esta información es generada por IA basándose en registros recientes de llamadas a la API. Confirme la exactitud de esta información.	DingTalk
RamRole	string	El nombre del rol de RAM utilizado para realizar operaciones.	OOSServiceRole
Configuration	string	El contenido de la configuración de chat en formato de cadena JSON, que contiene información sensible como el ID de cliente y el secreto.	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	El ID del grupo de recursos que identifica el grupo de recursos al que pertenece el recurso.	s
CreatedDate	string	La hora en que se creó la configuración de chat, en formato ISO 8601.	2025-12-26T09:53:02+00:00
UpdatedDate	string	La hora en que se actualizó por última vez la configuración de chat, en formato ISO 8601.	2026-01-07T02:14:55+00:00
Outputs	string	La información de salida de la configuración de chat en formato de cadena JSON, que contiene parámetros como la URL del webhook.	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.