Update communicationConfiguration

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Replace the agentCommunicationConfiguration of an agentIdentityBlueprint. This operation is a full replace: the request replaces the entire configuration object with the supplied body.

Note

When you set the endpointConfiguration, we recommend that you use the apiBased agentEndpointConfigurationType rather than botBased.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permission	Higher privileged permissions
Delegated (work or school account)	AgentCommunicationConfiguration.ReadWrite	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	AgentCommunicationConfiguration.ReadWrite.All	Not available.

HTTP request

PUT /applications/{agentIdentityBlueprintId}/microsoft.graph.agentIdentityBlueprint/communicationConfiguration

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a full JSON representation of the agentCommunicationConfiguration object. Because this operation is a full replace, include all properties you want to persist; properties that are omitted are cleared.

Property	Type	Description
isOverridableAtAgentIdLevel	Boolean	Indicates whether individual agent instances created from this blueprint can override the endpointConfiguration. Optional.
endpointConfiguration	agentEndpointConfiguration	The endpoint binding (bot ID or callback URI) that the agent uses to receive messages. Optional.
teamworkConfiguration	agentTeamworkConfiguration	The per-conversation-context message notification settings that agents use. Optional.

Response

If successful, this method returns a 200 OK response code and an updated agentCommunicationConfiguration object in the response body.

Examples

Request

The following example shows a request.

HTTP

PUT https://graph.microsoft.com/beta/applications/2a665ec0-9d8b-43ed-9fa3-2b4c5d6e7f80/microsoft.graph.agentIdentityBlueprint/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"
    }
  }
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const communicationConfiguration = {
  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'
    }
  }
};

await client.api('/applications/2a665ec0-9d8b-43ed-9fa3-2b4c5d6e7f80/microsoft.graph.agentIdentityBlueprint/communicationConfiguration')
	.version('beta')
	.put(communicationConfiguration);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('2a665ec0-9d8b-43ed-9fa3-2b4c5d6e7f80')/microsoft.graph.agentIdentityBlueprint/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"
    }
  }
}