Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
Arquivo um canal em uma equipe. Quando um canal é arquivado, os usuários não podem enviar novas mensagens ou reagir a mensagens existentes no canal, editar as configurações do canal ou fazer outras alterações no canal.
Você pode excluir um canal arquivado ou adicionar e remover membros dele. Se você arquivar uma equipe, seus canais também serão arquivados.
O arquivamento é uma operação assíncrona; Um canal é arquivado depois que a operação de arquivamento assíncrono é concluída com êxito, o que pode ocorrer após o retorno da resposta.
Um canal sem proprietário ou que pertença a um grupo que não tenha proprietário não pode ser arquivado.
Para restaurar um canal de seu estado arquivado, use o método channel: unarchive . Um canal não poderá ser arquivado ou desarquivado se sua equipe for arquivada.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global | Governo dos EUA L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | ChannelSettings.ReadWrite.All | Indisponível. |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | ChannelSettings.ReadWrite.All | Indisponível. |
Observação: esta API oferece transporte a permissões de administrador. Os usuários com as funções de administrador global ou administrador de serviço do Microsoft Teams podem acessar equipes das quais não são membros.
Solicitação HTTP
POST /teams/{team-id}/channels/{channel-id}/archive
POST /groups/{team-id}/team/channels/{channel-id}/archive
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-Type | application/json. Opcional. |
Corpo da solicitação
No corpo da solicitação, você pode, opcionalmente, fornecer um objeto JSON com o parâmetro a seguir.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| shouldSetSpoSiteReadOnlyForMembers | Booliano | Define se as permissões dos membros do canal são somente leitura no site do SharePoint Online associado à equipe. Se você defini-lo ou false omitir o parâmetro, esta etapa será ignorada. |
O exemplo a seguir mostra o corpo da solicitação com shouldSetSpoSiteReadOnlyForMembers definido como true.
{
"shouldSetSpoSiteReadOnlyForMembers": true
}
Resposta
Se o arquivamento for iniciado com êxito, esse método retornará um código de resposta 202 Accepted. A resposta contém um Location cabeçalho que especifica o local da teamsAsyncOperation que foi criada para lidar com o arquivamento do canal em uma equipe. Verifique o status da operação de arquivamento fazendo uma solicitação GET para esse local.
Exemplos
Exemplo 1: Arquivo um canal
O exemplo a seguir mostra uma solicitação para arquivar um canal.
Solicitação
POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive
Resposta
O exemplo a seguir mostra a resposta.
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
Exemplo 2: Arquivo de um canal quando a equipe for arquivada
O exemplo a seguir mostra uma solicitação para arquivar um canal que falha porque a equipe está arquivada; A equipe deve estar ativa para arquivar ou desarquivar um canal.
Solicitação
POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721/channels/19:v32db348d9264477abcf18ffa2cf76dc@thread.tacv2/archive
Resposta
O exemplo a seguir mostra o código de 400 Bad Request resposta com uma mensagem de erro correspondente.
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"
}
}
}