communicationConfiguration を更新する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

agentIdentity の agentCommunicationConfiguration を置き換えます。 この操作は完全な置き換えです。要求は構成オブジェクト全体を指定された本文に置き換えます。 エージェント ID は、ソース ブループリントが isOverridableAtAgentIdLevel を true に設定している場合にのみ、構成をオーバーライドできます。

注:

endpointConfiguration を設定するときは、botBasedではなく apiBasedagentEndpointConfigurationType を使用することをお勧めします。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AgentCommunicationConfiguration.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AgentCommunicationConfiguration.ReadWrite.All 注意事項なし。

HTTP 要求

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエストの本文には、 agentCommunicationConfiguration オブジェクトの完全な JSON 表現を指定します。 この操作は完全な置換であるため、保持するすべてのプロパティを含めます。省略されたプロパティはクリアされます。

プロパティ 型 説明
isOverridableAtAgentIdLevel ブール型 このブループリントから作成された個々のエージェント インスタンスが endpointConfiguration をオーバーライドできるかどうかを示します。 省略可能。
endpointConfiguration agentEndpointConfiguration エージェントがメッセージを受信するために使用するエンドポイント バインディング (ボット ID またはコールバック URI)。 省略可能。
teamworkConfiguration agentTeamworkConfiguration エージェントが使用する会話コンテキスト メッセージ通知設定。 省略可能。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された agentCommunicationConfiguration オブジェクトを返します。

例

要求

次の例は要求を示しています。

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"
    }
  }
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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"
    }
  }
}
  • 最終更新: