userTeamwork: getAllTargetedMessages

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.

Receba todas as mensagens direcionadas enviadas a um usuário específico em chats e canais em grupo.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

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ões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Trabalho em equipeTargetedMessage.Read.All Indisponível.

Solicitação HTTP

GET /users/{user-id | userPrincipalName}/teamwork/getAllTargetedMessages

Parâmetros de consulta opcionais

Esse método dá suporte aos seguintes parâmetros de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Nome Descrição
$filter O parâmetro de consulta $filter dá suporte a consultas de intervalo de data e hora na propriedade lastModifiedDateTime usando parâmetros de intervalo de datas.
$top Use o parâmetro de consulta $top para controlar o número de itens por resposta.

Operadores de $filter com suporte

Há suporte para as seguintes expressões de filtro:

  • lastModifiedDateTime gt {datetime} - Retorna mensagens modificadas após a data e hora especificadas.
  • lastModifiedDateTime lt {datetime} - Retorna mensagens modificadas antes da data e hora especificadas.
  • from/application/id eq '{id}' - Retorna mensagens enviadas por um ID de aplicativo específico.

Você pode combinar várias expressões de filtro usando o and operador. Por exemplo:

GET /users/{user-id | userPrincipalName}/teamwork/getAllTargetedMessages?$filter=lastModifiedDateTime gt 2024-01-01T00:00:00Z and lastModifiedDateTime lt 2024-12-31T23:59:59Z

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedida, essa função retornará um 200 OK código de resposta e uma coleção de objetos targetedChatMessage no corpo da resposta.

A resposta inclui a propriedade @odata.nextLink para paginação e a propriedade @odata.deltaLink para rastreamento delta, quando aplicável.

Exemplos

Exemplo 1: Obter todas as mensagens direcionadas para um usuário

O exemplo a seguir mostra como recuperar todas as mensagens direcionadas para um usuário.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages

Resposta

O exemplo a seguir mostra a resposta que inclui mensagens direcionadas ao contexto do canal e do chat.

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#Collection(targetedChatMessage)",
  "@odata.count": 2,
  "@odata.nextLink": "https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages?$top=2&$skiptoken=U2tpcFZhbHVlPTIjTWFpbGJveEZvbGRlcj1NYWlsRm9sZGVycy9UZWFtc01lc3NhZ2VzRGF0YQ",
  "value": [
    {
      "id": "1580849738240",
      "@odata.type": "#microsoft.graph.targetedChatMessage",
      "replyToId": null,
      "etag": "1580849738240",
      "chatId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
      "channelIdentity": null,
      "messageType": "message",
      "createdDateTime": "2020-02-04T20:55:38.24Z",
      "lastModifiedDateTime": null,
      "deletedDateTime": null,
      "subject": null,
      "summary": null,
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "policyViolation": null,
      "from": {
        "device": null,
        "user": null,
        "application": {
          "@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
          "id": "6d23e712-527b-406f-8d59-d02927885918",
          "displayName": "Breakthru",
          "applicationIdentityType": "bot"
        }
      },
      "body": {
        "contentType": "text",
        "content": "hello"
      },
      "attachments": [],
      "mentions": [],
      "reactions": [],
      "recipient": {
        "@odata.type": "#microsoft.graph.identity",
        "id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
        "displayName": "Adele Vance"
      }
    },
    {
      "id": "1580849738241",
      "@odata.type": "#microsoft.graph.targetedChatMessage",
      "replyToId": null,
      "etag": "1580849738241",
      "chatId": null,
      "channelIdentity": {
        "channelId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
        "teamId": "3Aeeaa4e946d674c4f8d4dded613780f45@thread.v2"
      },
      "messageType": "message",
      "createdDateTime": "2020-02-04T20:55:38.24Z",
      "lastModifiedDateTime": null,
      "deletedDateTime": null,
      "subject": null,
      "summary": null,
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "policyViolation": null,
      "from": {
        "device": null,
        "user": null,
        "application": {
          "@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
          "id": "6d23e712-527b-406f-8d59-d02927885918",
          "displayName": "Breakthru",
          "applicationIdentityType": "bot"
        }
      },
      "body": {
        "contentType": "text",
        "content": "hello"
      },
      "attachments": [],
      "mentions": [],
      "reactions": [],
      "recipient": {
        "@odata.type": "#microsoft.graph.identity",
        "id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
        "displayName": "Adele Vance"
      }
    }
  ]
}

Exemplo 2: Filtrar mensagens direcionadas por intervalo de datas

O exemplo a seguir mostra como recuperar mensagens direcionadas em um intervalo de datas específico.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllTargetedMessages?$filter=lastModifiedDateTime gt 2024-01-01T00:00:00Z and lastModifiedDateTime lt 2024-12-31T23:59:59Z

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#Collection(targetedChatMessage)",
  "@odata.count": 1,
  "value": [
    {
      "id": "1704067200000",
      "@odata.type": "#microsoft.graph.targetedChatMessage",
      "replyToId": null,
      "etag": "1704067200000",
      "chatId": "19:eeaa4e946d674c4f8d4dded613780f45@thread.v2",
      "channelIdentity": null,
      "messageType": "message",
      "createdDateTime": "2024-01-01T00:00:00Z",
      "lastModifiedDateTime": "2024-01-01T00:00:00Z",
      "deletedDateTime": null,
      "subject": null,
      "summary": null,
      "importance": "normal",
      "locale": "en-us",
      "webUrl": null,
      "policyViolation": null,
      "from": {
        "device": null,
        "user": null,
        "application": {
          "@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
          "id": "6d23e712-527b-406f-8d59-d02927885918",
          "displayName": "Breakthru",
          "applicationIdentityType": "bot"
        }
      },
      "body": {
        "contentType": "text",
        "content": "Filtered message content"
      },
      "attachments": [],
      "mentions": [],
      "reactions": [],
      "recipient": {
        "@odata.type": "#microsoft.graph.identity",
        "id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
        "displayName": "Adele Vance"
      }
    }
  ]
}