GetChatConfiguration - - Centre de documentation Alibaba Cloud

Crée, met à jour, consulte et supprime des configurations de chat pour des plateformes telles que DingTalk.

Description de l'opération

Cette opération d'API est utilisée pour gérer et configurer les paramètres du chatbot intégrés aux outils de messagerie instantanée tels que DingTalk. Les opérations prises en charge incluent la création de configurations de chat, la mise à jour des configurations existantes, l'obtention des détails de configuration spécifiques et la suppression des configurations qui ne sont plus nécessaires. Vous pouvez utiliser cette opération d'API pour implémenter un contrôle d'accès à granularité fine pour différents utilisateurs ou groupes d'utilisateurs et spécifier des rôles RAM pour effectuer les opérations associées. Vous pouvez également ajouter des balises à chaque configuration pour faciliter la gestion et la catégorisation.

Lorsque vous appelez cette opération d'API, assurez-vous que les paramètres RegionId, ConversationId et autres dans le corps de la requête sont corrects. Faites preuve de prudence lorsque vous traitez des champs sensibles à la sécurité tels que ClientId et ClientSecret afin d'éviter toute divulgation non autorisée.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

oos:GetChatConfiguration

create

*All Resource.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région.	cn-hangzhou
Name	string	Non	Le nom de la configuration.	chatOps-qiwei

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les détails de la réponse réussie.
RequestId	string	L'identifiant de la requête.	4DB0****1234
ChatConfiguration	object	Les détails de la configuration de chat, y compris le nom, le type, le rôle RAM et d'autres propriétés.	{ "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	Le nom de la configuration de chat.	chatops
Type	string	Le type de la configuration de chat. Valeurs valides : DingTalk : configuration DingTalk. WeChat : configuration WeCom. TODO : Ces informations sont générées par l'IA sur la base des journaux d'appels d'API récents. Confirmez l'exactitude de ces informations.	DingTalk
RamRole	string	Le nom du rôle RAM utilisé pour effectuer les opérations.	OOSServiceRole
Configuration	string	Le contenu de la configuration de chat au format de chaîne JSON, qui contient des informations sensibles telles que l'identifiant client et le secret.	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	L'identifiant du groupe de ressources, qui identifie le groupe de ressources auquel appartient la ressource.	s
CreatedDate	string	L'heure à laquelle la configuration de chat a été créée, au format ISO 8601.	2025-12-26T09:53:02+00:00
UpdatedDate	string	L'heure de la dernière mise à jour de la configuration de chat, au format ISO 8601.	2026-01-07T02:14:55+00:00
Outputs	string	Les informations de sortie de la configuration de chat au format de chaîne JSON, qui contiennent des paramètres tels que l'URL du webhook.	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

Exemples

JSON format

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.