通道：存档

项目
07/24/2024

命名空间：microsoft.graph

在团队中存档频道。存档频道后，用户无法发送新消息或对频道中的现有消息做出反应、编辑频道设置或对通道进行其他更改。

可以删除已存档的频道，也可以从其中添加和删除成员。如果存档团队，其频道也会存档。

存档是一种异步操作;异步存档操作成功完成后会存档通道，这可能会在响应返回后发生。

没有所有者或属于没有所有者的组的频道无法存档。

若要从其存档状态还原通道，请使用通道：unarchive 方法。如果频道团队已存档，则无法存档或取消存档频道。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	ChannelSettings.ReadWrite.All	不可用。
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	ChannelSettings.ReadWrite.All	不可用。

HTTP 请求

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

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。
Content-Type	application/json. 可选。

请求正文

在请求正文中，可以选择性地使用以下参数提供 JSON 对象。

参数	类型	说明
shouldSetSpoSiteReadOnlyForMembers	布尔值	定义是否在与团队关联的 SharePoint Online 网站上为频道成员设置只读权限。如果将其设置为 `false` 或省略参数，则跳过此步骤。

以下示例显示了 将 shouldSetSpoSiteReadOnlyForMembers 设置为 true的请求正文。

{
  "shouldSetSpoSiteReadOnlyForMembers": true
}

响应

如果成功开始存档，此方法将返回一个 202 Accepted 响应代码。响应包含一个 Location 标头，该标头指定为处理团队中频道存档而创建的 teamsAsyncOperation 的位置。可通过向此位置发出 GET 请求，查看存档操作的状态。

示例

示例 1：存档频道

以下示例演示了存档通道的请求。

请求

POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Teams["{team-id}"].Channels["{channel-id}"].Archive.PostAsync(null);



mgc teams channels archive post --team-id {team-id} --channel-id {channel-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Teams().ByTeamId("team-id").Channels().ByChannelId("channel-id").Archive().Post(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.teams().byTeamId("{team-id}").channels().byChannelId("{channel-id}").archive().post(null);


const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive')
	.post();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->teams()->byTeamId('team-id')->channels()->byChannelId('channel-id')->archive()->post()->wait();


Import-Module Microsoft.Graph.Teams

Invoke-MgArchiveTeamChannel -TeamId $teamId -ChannelId $channelId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.teams.by_team_id('team-id').channels.by_channel_id('channel-id').archive.post(None)

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Location: /teams/16dc05c0-2259-4540-a970-3580ff459721/operations/b7ee702a-d87f-4cc6-82b9-e731c16d3aba
Content-Type: text/plain
Content-Length: 0

示例 2：存档团队时存档频道

以下示例显示了一个存档通道的请求，该请求由于团队已存档而失败;团队必须处于活动状态才能存档或取消存档频道。

请求

POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Teams["{team-id}"].Channels["{channel-id}"].Archive.PostAsync(null);



mgc teams channels archive post --team-id {team-id} --channel-id {channel-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Teams().ByTeamId("team-id").Channels().ByChannelId("channel-id").Archive().Post(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.teams().byTeamId("{team-id}").channels().byChannelId("{channel-id}").archive().post(null);


const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive')
	.post();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->teams()->byTeamId('team-id')->channels()->byChannelId('channel-id')->archive()->post()->wait();


Import-Module Microsoft.Graph.Teams

Invoke-MgArchiveTeamChannel -TeamId $teamId -ChannelId $channelId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.teams.by_team_id('team-id').channels.by_channel_id('channel-id').archive.post(None)

响应

以下示例显示了响应代码， 400 Bad Request 其中包含相应的错误消息。

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"
        }
    }
}

通过