Aktualisieren von communicationConfiguration

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Ersetzen Sie die agentCommunicationConfiguration einer agentIdentity. Dieser Vorgang ist ein vollständiger Ersatz: Die Anforderung ersetzt das gesamte Konfigurationsobjekt durch den angegebenen Text. Eine Agentidentität kann die Konfiguration nur überschreiben, wenn der Quell-Blueprint "isOverridableAtAgentIdLevel " auf truefestlegt.

Hinweis

Wenn Sie endpointConfiguration festlegen, empfiehlt es sich, den apiBasedagentEndpointConfigurationType anstelle von botBasedzu verwenden.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigung mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) AgentCommunicationConfiguration.ReadWrite Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AgentCommunicationConfiguration.ReadWrite.All Nicht verfügbar.

HTTP-Anforderung

PUT /servicePrincipals/microsoft.graph.agentIdentity/{agentIdentityId}/communicationConfiguration

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine vollständige JSON-Darstellung des agentCommunicationConfiguration-Objekts an. Da es sich bei diesem Vorgang um einen vollständigen Ersatz handelt, schließen Sie alle Eigenschaften ein, die beibehalten werden sollen. Eigenschaften, die weggelassen werden, werden gelöscht.

Eigenschaft Typ Beschreibung
isOverridableAtAgentIdLevel Boolean Gibt an, ob einzelne Agent-Instanzen, die mit dieser Blaupause erstellt wurden, die endpointConfiguration überschreiben können. Optional.
endpointConfiguration agentEndpointConfiguration Die Endpunktbindung (Bot-ID oder Rückruf-URI), die der Agent zum Empfangen von Nachrichten verwendet. Optional.
teamworkKonfiguration agentTeamworkConfiguration Die Einstellungen für Benachrichtigungen pro Gesprächskontext, die von Agents verwendet werden. Optional.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und ein aktualisiertes agentCommunicationConfiguration-Objekt im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PUT https://graph.microsoft.com/beta/servicePrincipals/microsoft.graph.agentIdentity/1f554dbf-8c7a-42dc-8f92-1a3b4c5d6e7f/communicationConfiguration
Content-Type: application/json

{
  "isOverridableAtAgentIdLevel": false,
  "endpointConfiguration": {
    "configurationType": "apiBased",
    "apiBased": {
      "callbackUri": "https://agent.contoso.com/api/messages"
    }
  },
  "teamworkConfiguration": {
    "groupChatConfiguration": {
      "messageNotificationMode": "atMentionedMessagesOnly"
    },
    "channelConfiguration": {
      "messageNotificationMode": "allMessages"
    },
    "oneOnOneChatConfiguration": {
      "messageNotificationMode": "allMessages"
    },
    "meetingChatConfiguration": {
      "messageNotificationMode": "atMentionedMessagesOnly"
    }
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals/microsoft.graph.agentIdentity/communicationConfiguration/$entity",
  "isOverridableAtAgentIdLevel": false,
  "endpointConfiguration": {
    "configurationType": "apiBased",
    "apiBased": {
      "callbackUri": "https://agent.contoso.com/api/messages"
    },
    "botBased": null
  },
  "teamworkConfiguration": {
    "groupChatConfiguration": {
      "messageNotificationMode": "atMentionedMessagesOnly"
    },
    "channelConfiguration": {
      "messageNotificationMode": "allMessages"
    },
    "oneOnOneChatConfiguration": {
      "messageNotificationMode": "allMessages"
    },
    "meetingChatConfiguration": {
      "messageNotificationMode": "atMentionedMessagesOnly"
    }
  }
}
  • Last updated on