userTeamwork: getAllRetainedTargetedMessages

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

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

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

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

Разрешения

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

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

HTTP-запрос

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

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

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

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

Поддерживаемые операторы $filter

Поддерживаются следующие выражения фильтра:

  • lastModifiedDateTime gt {datetime} - Возвращает сообщения, измененные после указанной даты и времени.
  • lastModifiedDateTime lt {datetime} - Возвращает сообщения, измененные до указанной даты и времени.
  • from/application/id eq '{id}' - Возвращает сообщения, отправленные определенным идентификатором приложения.

С помощью and этого оператора можно объединить несколько выражений фильтра. Например, вы можете:

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

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

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

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

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

Отклик

В случае успеха эта функция возвращает код ответа 200 OK и коллекцию объектов targetedChatMessage в тексте ответа.

Отклик включает свойство @odata.nextLink для разбивки на страницы, если применимо.

Примеры

Запрос

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

GET https://graph.microsoft.com/v1.0/users/f47b5f54-6968-4706-a522-31e842b12345/teamwork/getAllRetainedTargetedMessages

Отклик

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

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(targetedChatMessage)",
  "@odata.count": 1,
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/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"
      }
    }
  ]
}
  • Last updated on