Update communicationConfiguration

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Reemplace el agentCommunicationConfiguration de un agentIdentity. Esta operación es un reemplazo completo: la solicitud reemplaza todo el objeto de configuración por el cuerpo suministrado. Una identidad de agente puede invalidar la configuración solo cuando el plano técnico de origen establece isOverridableAtAgentIdLevel en true.

Nota:

Al establecer endpointConfiguration, se recomienda usar agentEndpointConfigurationTypeapiBased en lugar de botBased.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permiso con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) AgentCommunicationConfiguration.ReadWrite No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AgentCommunicationConfiguration.ReadWrite.All No disponible.

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON completa del objeto agentCommunicationConfiguration . Dado que esta operación es un reemplazo completo, incluya todas las propiedades que desea conservar; Las propiedades que se omiten se borran.

Propiedad Tipo Description
isOverridableAtAgentIdLevel Booleano Indica si las instancias de agente individuales creadas a partir de este plano técnico pueden anular endpointConfiguration. Opcional.
endpointConfiguration agentEndpointConfiguration El enlace de punto de conexión (ID de bot o URI de devolución de llamada) que usa el agente para recibir mensajes. Opcional.
teamworkConfiguration agentTeamworkConfiguration La configuración de notificación por mensaje de contexto de conversación que usan los agentes. Opcional.

Respuesta

Si tiene éxito, este método devuelve un 200 OK código de respuesta y un objeto agentCommunicationConfiguration actualizado en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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"
    }
  }
}
  • Se actualizó por última vez el