Saltar para a documentação
Servidor MCP

Exportações

Um zip de todo o espaço de trabalho.

Ferramentas de exportações

FerramentaO que faz
getExportPreviewSe uma exportação pode começar agora, quando a seguinte poderá, a exportação ainda em curso e quanto uma exportação conteria.
listExportsAs exportações do espaço de trabalho, das mais recentes para as mais antigas, com o seu estado, progresso e tamanho.
getExportUma exportação pelo seu id.
startExportComeçar a fazer um zip de todo o espaço de trabalho, uma vez por dia. Pede um código de verificação, e no chat da aplicação pergunta sempre primeiro.

Só o proprietário do espaço de trabalho, ou um membro cujo papel detenha todas as permissões, pode exportar, através de um cliente ligado com todos os endereços. Cada ferramenta precisa de threads:read.

Nenhuma ferramenta devolve o zip. Transfira-o na página Exportar da aplicação, com GET /exports/{id}/content na API REST, exports.download no SDK ou openemail exports download na linha de comandos.

Algumas ferramentas deste servidor fazem uma alteração que a API REST protege com um código de verificação, e pedem o mesmo código. Enquanto o cliente não tiver verificado um código nos últimos 60 minutos, e a pessoa não tiver escolhido Permitir alterações durante 60 minutos para ele em Conta → Aplicações ligadas, essa ferramenta responde com um resultado que começa por Refused (step_up_required): e não altera nada. emptyAudience nunca pede um código. A página Autenticação da API lista cada ferramenta que o pede e mostra como pedir um código e verificá-lo.

Referência

getExportPreview

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

Whether this workspace can be exported now, when the next export can start, the export still being made, and how much an export would hold: conversations, attachments, contacts, audiences, calendar events, templates, rules, labels, notes and addresses.

Entradas

Não recebe entradas.

Também disponível em

API
GET /exports/preview
SDK
exports.preview()

listExports

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

The exports of this workspace, newest first, with their status, progress, size and when each is deleted. A ready one is downloaded on the Export page of the app or with GET /exports/{id}/content on the REST API.

Entradas

limitinteger
Pelo menos 1No máximo 100
offsetinteger
Pelo menos 0

Também disponível em

API
GET /exportsGET /exports/{id}
SDK
exports.list()exports.get()

getExport

Âmbitosthreads:readO assistente da app executa-o sem perguntarConjunto de ferramentasworkspace

One export by its id: its status, its progress through the conversations, its size and when it is deleted.

Entradas

idstringObrigatório
De 1 a 128 caracteres

Também disponível em

API
GET /exportsGET /exports/{id}
SDK
exports.list()exports.get()

startExport

Âmbitosthreads:readO assistente da app pergunta sempre primeiroConjunto de ferramentasworkspace

Start making a zip of the whole workspace, as Export now on the Export page does. It is made in the background, one at a time and once a day, and kept for a year. Ask the person first.

Entradas

Não recebe entradas.

Também disponível em

API
POST /exports
SDK
exports.start()