Atualizar communicationconfiguration

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Substitua o agentCommunicationConfiguration de um agentIdentity. Esta operação é uma substituição completa: a solicitação substitui todo o objeto de configuração pelo corpo fornecido. Uma identidade de agente só pode substituir a configuração quando o blueprint de origem define isOverridableAtAgentIdLevel como true.

Observação

Ao definir o endpointConfiguration, recomendamos que você use o apiBasedagentEndpointConfigurationType em vez de botBased.

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissão com privilégios mínimos Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) AgentCommunicationConfiguration.ReadWrite Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentCommunicationConfiguration.ReadWrite.All Indisponível.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON completa do objeto agentCommunicationConfiguration . Como essa operação é uma substituição completa, inclua todas as propriedades que você deseja manter; As propriedades omitidas são desmarcadas.

Propriedade Tipo Descrição
isOverridableAtAgentIdLevel Booliano Indica se instâncias de agente individuais criadas a partir desse blueprint podem substituir o endpointConfiguration. Opcional.
endpointconfiguration agentEndpointConfiguration A associação de ponto de extremidade (ID do bot ou URI de retorno de chamada) que o agente usa para receber mensagens. Opcional.
Trabalho em equipeConfiguração agentTeamworkConfiguration As configurações de notificação de mensagem por contexto de conversa que os agentes usam. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto agentCommunicationConfiguration atualizado no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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