chat: getAllRetainedMessages
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 retidas de todos os chats em que um usuário é participante, incluindo chats individuais, chats em grupo e chats de reunião.
Nota: Essa é uma API limitada que dá suporte aos
model=A
modelos de pagamento emodel=B
. Para obter detalhes, consulte Modelos de pagamento. Se você não especificar um modelo de pagamento em sua consulta, o modo de avaliação padrão será usado.Dependendo do modelo de pagamento escolhido, uma licença também pode ser necessária.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | Sem suporte. | Sem suporte. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | Chat.Read.All | Chat.ReadWrite.All |
Solicitação HTTP
GET /users/{id}/chats/getAllRetainedMessages
Parâmetros de consulta opcionais
O exemplo a seguir mostra como usar o model
parâmetro de consulta com valores A
ou B
selecionar o modelo de licenciamento e pagamento preferencial. Se você não especificar um modelo de pagamento, o modo de avaliação será usado por padrão.
GET /users/{id}/chats/getAllRetainedMessages?model=A
GET /users/{id}/chats/getAllRetainedMessages?model=B
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. |
O exemplo a seguir mostra uma solicitação que usa os $top
parâmetros de consulta e $filter
para obter uma lista de mensagens de chat retidas.
GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z
A tabela a seguir lista exemplos que mostram como usar o $filter
parâmetro.
Cenário | Parâmetro $filter |
Valores possíveis |
---|---|---|
Obter mensagens enviadas pelo tipo de identidade do usuário | $filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' | aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser |
Obter mensagens enviadas por tipo de aplicativo | $filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' | aadApplication, bot, tenantBot, office365Connector, outgoingWebhook |
Obter mensagens enviadas pela ID do usuário | $filter=from/user/id eq '{oid}' | |
Obter mensagens de controle (evento do sistema) | $filter=messageType eq 'systemEventMessage' | |
Excluir mensagens de controle (evento do sistema) | $filter=messageType ne 'systemEventMessage' |
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 bem sucedido, este método retorna um código de resposta 200 OK
e uma coleção de objetos chatMessage no corpo da resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages
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(chatMessage)",
"@odata.count": 10,
"@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages?$skip=10",
"value": [
{
"@odata.type": "#microsoft.graph.chatMessage",
"id": "1600457965467",
"replyToId": null,
"etag": "1600457965467",
"messageType": "message",
"createdDateTime": "2020-09-18T19:39:25.467Z",
"lastModifiedDateTime": "2020-09-18T19:39:25.467Z",
"lastEditedDateTime": null,
"deletedDateTime": null,
"subject": null,
"summary": null,
"chatId": "19:0de69e5e-2da8-4cf2-821f-5e6585b2c65b_5c64e248-3269-4268-a36e-0f80314e9c39@unq.gbl.spaces",
"importance": "normal",
"locale": "en-us",
"webUrl": null,
"channelIdentity": null,
"policyViolation": null,
"eventDetail": null,
"from": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "0de69e5e-2da8-4cf2-821f-5e6585b2c65b",
"displayName": "Richard Wilson",
"userIdentityType": "aadUser"
}
},
"body": {
"contentType": "html",
"content": "<div>\n<blockquote itemscope=\"\" itemtype=\"http://schema.skype.com/Reply\" itemid=\"1600457867820\">\n<strong itemprop=\"mri\" itemid=\"8:orgid:0de69e5e-2da8-4cf2-821f-5e6585b2c65b\">Richard Wilson</strong><span itemprop=\"time\" itemid=\"1600457867820\"></span>\n<p itemprop=\"preview\">1237</p>\n</blockquote>\n<p>this is a reply</p>\n</div>"
},
"attachments": [],
"mentions": [],
"reactions": []
}
]
}
Conteúdo relacionado
Limites de limitação específicos do serviço do Microsoft Graph
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de