Поделиться через

chat: getAllRetainedMessages

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получение всех сохраненных сообщений из всех чатов , участником которых является пользователь, включая чаты по отдельности, групповые чаты и чаты собраний.

Дополнительные сведения об использовании API экспорта Microsoft Teams для экспорта содержимого см. в статье Экспорт содержимого с помощью API экспорта Microsoft Teams.

Заметка: Это лимитный API, который поддерживает model=A модели оплаты и model=B . Дополнительные сведения см. в разделе Модели оплаты. Если в запросе не указана модель оплаты, будет использоваться режим оценки по умолчанию.

В зависимости от выбранной модели оплаты также может потребоваться лицензия.

Примечание.

Этот API требует настройки политик хранения Teams . Дополнительные сведения см. в статье Управление политиками хранения для Microsoft Teams.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Не поддерживается. Не поддерживается.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение Chat.Read.All Chat.ReadWrite.All

HTTP-запрос

GET /users/{id}/chats/getAllRetainedMessages

Необязательные параметры запросов

В следующем примере показано, как использовать model параметр запроса со значениями A или B выбрать предпочтительную модель лицензирования и оплаты. Если модель оплаты не указана, по умолчанию используется режим оценки .

GET /users/{id}/chats/getAllRetainedMessages?model=A
GET /users/{id}/chats/getAllRetainedMessages?model=B

Этот метод поддерживает следующие параметры запроса OData для настройки ответа. Общие сведения см. в статье Параметры запроса OData.

Имя Описание
$filter Параметр запроса $filter поддерживает запросы диапазона даты и времени в свойстве lastModifiedDateTime с помощью параметров диапазона дат.
$top Используйте параметр запроса $top для управления количеством элементов на ответ.

В следующем примере показан запрос, который использует $top параметры запроса и $filter для получения списка сохраненных сообщений чата.

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

В следующей таблице приведены примеры использования $filter параметра .

Сценарий Параметр $filter Возможные значения
Получение сообщений, отправляемых по типу удостоверения пользователя $filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser
Получение сообщений, отправляемых по типу приложения $filter=from/application/applicationIdentityType eq "{teamworkApplicationIdentity}" aadApplication, bot, tenantBot, office365Connector, outgoingWebhook
Получение сообщений, отправляемых по идентификатору пользователя $filter=from/user/id eq '{oid}'
Получение сообщений об управлении (системных событиях) $filter=messageType eq 'systemEventMessage'
Исключить сообщения об управлении (системных событиях) $filter=messageType ne 'systemEventMessage'

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и коллекцию объектов chatMessage в тексте отклика.

Примеры

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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": []
    }
  ]
}

Связанные материалы

Ограничения регулирования для служб, связанных с Microsoft Graph