Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
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.
Obtenha todas as mensagens direcionadas retidas enviadas a um utilizador específico em chats e canais de grupo.
Esta API está disponível nas seguintes implementações de cloud nacionais.
| Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
| Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | Sem suporte. | Sem suporte. |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | TeamworkTargetedMessage.Read.All | Indisponível. |
Solicitação HTTP
GET /users/{user-id | userPrincipalName}/teamwork/getAllRetainedTargetedMessages
Parâmetros de consulta opcionais
Este método suporta os 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 suporta consultas de intervalo de data e hora na propriedade lastModifiedDateTime com parâmetros de intervalo de datas. |
| $top | Utilize o parâmetro de consulta $top para controlar o número de itens por resposta. |
Operadores de $filter suportados
São suportadas as seguintes expressões de filtro:
-
lastModifiedDateTime gt {datetime}- Devolve mensagens modificadas após a data e hora especificadas. -
lastModifiedDateTime lt {datetime}- Devolve mensagens modificadas antes da data e hora especificadas. -
from/application/id eq '{id}'- Devolve mensagens enviadas por um ID de aplicação específico.
Pode combinar várias expressões de filtro com o and operador . Por exemplo:
GET /users/{user-id | userPrincipalName}/teamwork/getAllRetainedTargetedMessages?$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, esta função devolve 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, quando aplicável.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllRetainedTargetedMessages
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,
"@odata.nextLink": "https://graph.microsoft.com/beta/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllRetainedTargetedMessages?$top=1&$skiptoken=Token",
"value": [
{
"@odata.type": "#microsoft.graph.targetedChatMessage",
"id": "1684961612345",
"replyToId": null,
"etag": "1684962512345",
"messageType": "message",
"createdDateTime": "2023-05-24T20:54:49.858Z",
"lastModifiedDateTime": "2023-05-24T21:13:15Z",
"lastEditedDateTime": "2023-05-24T21:09:00.224Z",
"deletedDateTime": null,
"subject": "",
"summary": null,
"chatId": "19:1a546d42d8b54a16903716f49b512345@thread.v2",
"importance": "normal",
"locale": "en-us",
"webUrl": null,
"channelIdentity": null,
"onBehalfOf": null,
"policyViolation": null,
"eventDetail": null,
"from": {
"device": null,
"user": null,
"application": {
"@odata.type": "#microsoft.graph.teamworkApplicationIdentity",
"id": "6d23e712-527b-406f-8d59-d02927885918",
"displayName": "Breakthru",
"applicationIdentityType": "bot"
}
},
"body": {
"contentType": "html",
"content": "<p>5/24 group chat</p>"
},
"attachments": [],
"mentions": [],
"reactions": [],
"messageHistory": [],
"recipient": {
"@odata.type": "#microsoft.graph.identity",
"id": "1273a016-201d-4f95-8083-1b7f99b3edeb",
"displayName": "Adele Vance"
}
}
]
}