channel: archive

  • Статья

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

Важно!

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

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

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

Архивация является асинхронной; канал архивируется после успешного завершения асинхронной операции архивации, которая может произойти после возврата ответа.

Канал без владельца или, принадлежащий группе , у которой нет владельца, не может быть архивирован.

Чтобы восстановить канал из архивного состояния, используйте метод unarchive . Невозможно заархивировать или разархивировать канал, если заархивирована его команда.

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

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

Разрешения

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

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

Примечание. Этот API поддерживает разрешения администратора. Глобальные администраторы и администраторы службы Microsoft Teams могут получать доступ к командам, в которых они не состоят.

HTTP-запрос

POST /teams/{team-id}/channels/{channel-id}/archive
POST /groups/{team-id}/team/channels/{channel-id}/archive

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

Заголовок Значение
Авторизация Bearer {token}. Обязательно.

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

В запрос можно при необходимости включить shouldSetSpoSiteReadOnlyForMembers параметр в текст JSON, как показано ниже.

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

Этот необязательный параметр определяет, следует ли устанавливать разрешения только для чтения для участников канала на сайте SharePoint Online, связанном с командой. Установка значения false или полное пропуск текста приводит к пропуску этого шага.

Отклик

Если архивация начата успешно, этот метод возвращает код отклика 202 Accepted. Ответ содержит Location заголовок, содержащий расположение teamsAsyncOperation , созданной для архивации канала в команде. Проверьте состояние операции архивации, выполнив запрос GET для этого расположения.

Примеры

Пример 1. Архивация канала

В следующем примере показан запрос на архивирование канала.

Запрос

POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive

Отклик

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

HTTP/1.1 202 Accepted
Location: /teams/{team-id}/operations/{operation-id}
Content-Type: text/plain
Content-Length: 0

Пример 2. Архивация канала при архивации команды

В следующем примере показан запрос при архивации команды.

Запрос

POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive

Отклик

В следующем примере показан ответ на ошибку 400 .

http/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 193

{
    "error": {
        "code": "BadRequest",
        "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
        "innerError": {
            "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
            "code": "Unknown",
            "innerError": {},
            "date": "2023-12-11T04:26:35",
            "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
            "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
        }
    }
}