Denúncias e canais
Casos, canais, categorias, prazos, automações, prevenção, indicadores e evidências do canal de denúncias.
Consultar revisão de proteção do caso
Retorna a versão do caso, se a pessoa pode escolher qualquer membro e a lista de pessoas que podem receber acesso caso ele seja protegido (responsável atual, quem recebe casos protegidos e quem já tinha acesso nominal). Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Exige leitura do caso e `requests.demands.triage`; para caso já protegido, relato inexistente ou sem a permissão de triagem, a resposta é `null`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Proteger caso
Move o caso para a fila protegida, restringe o acesso às pessoas em `identity_ids` (1 a 100) e registra a justificativa em `reason` (10 a 2000 caracteres); acessos e atividades de quem ficou de fora são revogados. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); exige `requests.demands.read` e `requests.demands.triage`. Idempotente por `request_nonce` e com concorrência otimista por `expected_version` (versão divergente → `409`); caso já protegido → `409`; pessoa que deixou de ser elegível → `409`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Corrigir empresa do caso
Corrige a empresa à qual o caso pertence (a empresa declarada por quem relatou nunca muda), removendo acessos e o responsável fora do escopo da nova empresa. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); exige `requests.demands.triage`. Idempotente por `request_nonce`, com concorrência otimista por `expected_version` (`409` se divergente); empresa inativa ou fora do seu escopo → `422`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar canais
Lista os canais da organização com status, versão, modos de identificação, empresas atendidas e pendências que impedem a publicação. Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`).
Criar canal
Cria um canal em rascunho com `slug`, nome, descrição, público (`internal`, `external` ou `both`) e as empresas atendidas em `company_ids`; vazio vale apenas quando a organização tem uma única empresa ativa (`422` caso contrário). Requer a permissão `reporting.channels.manage`, exige acesso a todas as empresas (`403`) e não aceita chave de API. `slug` já usado → `409`; empresa inativa → `422`.
Definir empresas do canal
Substitui a lista de empresas atendidas pelo canal (`channel_id` é o UUID do canal). Requer a permissão `reporting.channels.manage`, exige acesso a todas as empresas (`403`) e não aceita chave de API. Concorrência otimista por `expected_version` (`409` se divergente); canal ativo ou pausado com empresa sem quem receba os casos → `422`; canal inexistente → `404`.
Consultar panorama de empresas
Para cada empresa que você pode ver: os canais que a atendem, quantas pessoas recebem casos protegidos dela, quantos membros têm escopo restrito a ela e se está coberta. Requer a permissão `identity.companies.read`.
Atualizar canal
Altera nome, descrição, instruções, público, listagem, modos de identificação e status (`draft`, `active`, `paused`, `disabled`) do canal. Requer a permissão `reporting.channels.manage`, exige acesso a todas as empresas (`403`) e não aceita chave de API. Concorrência otimista por `expected_version` (`409` se divergente); transição de status inválida → `409`; ativar sem tipos ou com pendências de configuração → `422`; canal inexistente → `404`.
Consultar prontidão do canal de denúncias
Resume se a organização está pronta para publicar canais: pendências, endereço público, empresas sem canal ou sem cobertura, canais ativos, quem recebe casos protegidos e se você é autoridade de concessão ou contingência. Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`).
Listar autoridades de casos protegidos
Lista as pessoas com autoridade de concessão (`grantor`) ou de contingência (`contingency`) sobre casos protegidos. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Permitido a quem é autoridade ou tem `reporting.channels.read`; os demais recebem `403`.
Definir autoridade de casos protegidos
Concede ou revoga a autoridade `grantor` ou `contingency` de um membro, com `reason_code`. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Só uma autoridade de concessão pode alterar; antes da primeira configuração, apenas o proprietário (`403` caso contrário). Membro inexistente → `422`; conceder a quem não tem acesso a todas as empresas → `422`; revogar a última autoridade de concessão → `409`.
Listar quem recebe casos protegidos
Lista as pessoas que recebem todo novo caso protegido, indicando se são o padrão inicial e se conseguem ler o caso. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Permitido a quem é autoridade ou tem `reporting.channels.read`; os demais recebem `403`.
Listar impedimentos por conflito do caso
Lista as pessoas impedidas de atuar no caso por conflito de interesse, com o motivo. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Permitido a quem pode conceder acesso ao caso ou já tem acesso a ele na fila protegida; caso contrário `404`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Registrar impedimento por conflito
Impede um membro de atuar em um caso protegido: revoga o acesso dele e, se for o responsável, deixa o caso aguardando nova atribuição. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); permitido a quem pode conceder acesso ao caso ou já tem acesso a ele (`404` caso contrário). Caso fora da fila protegida ou membro inexistente → `422`; impedimento já existente é devolvido sem alteração. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Liberar impedimento por conflito
Encerra um impedimento por conflito (`conflict_id` é o UUID do impedimento), com `reason_code`. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Só quem pode conceder acesso ao caso, e nunca a própria pessoa impedida; caso contrário `404`.
Criar canal a partir de modelo
Cria um canal já configurado a partir de um modelo (`internal`, `anonymous`, `suppliers`, `ombudsman`, `praise`), que define público, categorias oferecidas e modos de identificação. Requer a permissão `reporting.channels.manage` e exige acesso a todas as empresas (`403`). Nenhuma categoria habilitada para o modelo → `409`; `slug` já usado → `409`.
Listar categorias de relato
Lista as categorias de denúncia e os tipos de ouvidoria do catálogo, com tratamento de proteção, workflow, se estão habilitadas e em quantos canais aparecem. Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`).
Habilitar ou desabilitar categoria
Habilita ou desabilita a categoria `key`; ao habilitar, ela é adicionada aos canais que já oferecem categorias do mesmo grupo. Requer a permissão `reporting.channels.manage`, `requests.workflows.activate`, exige acesso a todas as empresas (`403`) e não aceita chave de API. Categoria inexistente → `404`; desabilitar a última categoria habilitada de um canal ativo → `409`.
Listar tipos de manifestação
Lista os tipos de solicitação habilitados que um canal pode oferecer (tipos de manifestação). Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`).
Listar tipos oferecidos pelo canal
Lista, em ordem, os tipos de manifestação oferecidos pelo canal (`channel_id` é o UUID do canal). Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`).
Definir tipos oferecidos pelo canal
Substitui a lista ordenada de tipos oferecidos pelo canal por `type_keys` (1 a 20 chaves distintas de tipos de manifestação habilitados). Requer a permissão `reporting.channels.manage`, exige acesso a todas as empresas (`403`) e não aceita chave de API. Canal inexistente → `404`; chave repetida, desabilitada ou desconhecida → `422`.
Consultar manifestação do caso
Retorna protocolo, modo de identificação, canal, empresa do caso e empresa declarada, e se existe identidade guardada, nunca a identidade em si. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Exige acesso ao caso; casos de relato também exigem segundo fator verificado na sessão. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Consultar identidade de quem relatou
Revela a identidade de uma manifestação identificada ou confidencial, com justificativa em `reason_code` (`triage`, `investigation`, `legal`, `inspection`, `other`). Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); exige acesso ao caso, segundo fator verificado com fator cadastrado e, para manifestação confidencial, a permissão `reporting.identity.reveal`. O acesso é registrado no histórico de acessos antes de a identidade sair (recusas também ficam registradas); há limite por hora por pessoa (`429`); identidade ilegível → `409`; o cabeçalho de idempotência não é aceito. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar histórico de acessos do caso
Lista os acessos sensíveis ao caso (revelação de identidade, exportação, visualização do relato, retenção), com pessoa, ação, motivo e data, até 500 linhas. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Permitido a quem pode conceder acesso ao caso ou a quem tem `requests.history.read` e vê o caso; caso contrário `404`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar perfis elegíveis a responsável
Lista as pessoas aceitas como responsável pelo caso, com papéis, funções no canal de denúncias (triagem, concessão, contingência) e quantidade de casos abertos sob sua responsabilidade. Requer a permissão `requests.demands.assign`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar casos protegidos distribuíveis
Lista até 100 casos protegidos sobre os quais você pode conceder acesso, com código, tipo, etapa e contadores de acessos e impedimentos, nunca o conteúdo. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Apenas autoridades de casos protegidos (`403` para os demais).
Listar pessoas de um caso protegido
Lista quem tem acesso ao caso protegido e quem está impedido por conflito, indicando se cada pessoa consegue ler o caso. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Apenas quem pode conceder acesso ao caso; caso fora da fila protegida ou sem essa autoridade → `403`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar evidências do caso
Lista os arquivos anexados ao caso com nome, tipo, tamanho, hash `sha256` e estado da verificação antivírus, sem o conteúdo; o download só entrega arquivos limpos. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Exige acesso ao caso; casos de relato também exigem segundo fator verificado. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Exportar caso
Gera um pacote ZIP assinado do caso para fiscalização (o caso como você pode lê-lo, evidências limpas, o histórico de acessos e um manifesto de integridade), montado a cada pedido e nunca armazenado. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); requer a permissão `reporting.cases.export` e acesso ao caso e, com `include_identity`, também segundo fator com fator cadastrado e, para manifestação confidencial, `reporting.identity.reveal`. Cada exportação e recusa fica no histórico de acessos; há limite por hora por pessoa (`429`) e o cabeçalho de idempotência não é aceito. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Validar pacote exportado
Confere um pacote exportado por esta plataforma, enviado no corpo da requisição: o hash de cada arquivo e o manifesto assinado. Um pacote alterado depois da exportação (arquivo modificado, incluído ou removido, ou manifesto editado) falha. Retorna `ok` e a lista `problems`. Requer a permissão `reporting.cases.export`.
Consultar ciência do aviso de 2FA na demo
Informa se a sessão é de demonstração, se o segundo fator foi verificado e se o aviso de segurança sobre 2FA já foi aceito nesta sessão. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`).
Registrar ciência do aviso de 2FA na demo
Registra, na sessão atual de demonstração, a ciência explícita de que casos de relato exigem segundo fator, liberando a visualização sem 2FA nesta sessão; o aceite é auditado. O corpo deve ter `acknowledge` igual a `true`. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Apenas contas de demonstração (`403` nas demais).
Consultar análise do caso
Retorna a análise estruturada do caso (triagem, apuração e conclusão), se você pode salvá-la agora e o que cada resultado de apuração ainda exige (`ready_for`, a mesma regra do encerramento); retorna `null` para caso que não é denúncia. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Exige acesso ao caso e segundo fator verificado. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Salvar análise do caso
Grava o documento completo da análise (triagem, apuração e conclusão) e cria uma revisão com as seções alteradas. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); requer a permissão `requests.demands.transition`, acesso ao caso e ausência de impedimento por conflito. Concorrência otimista por `expected_version` (`409` se divergente); caso encerrado → `409`; dados inválidos → `422`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Listar revisões da análise do caso
Lista as revisões da análise, da mais recente para a mais antiga (até 200), com versão, seções alteradas, autor e data. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Exige acesso ao caso e segundo fator verificado. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Registrar visualização do relato
Registra no histórico de acessos uma linha `statement.view` quando a pessoa exibe o relato (que aparece desfocado por padrão); para caso sem relato, retorna `ignored`. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); exige acesso ao caso. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Consultar indicadores do canal de denúncias
Indicadores agregados dos relatos no período (`from`/`to`, padrão: mês atual; até cerca de 3 anos), com filtros opcionais `channel_id` e `company_id`: totais, tempos medianos e distribuição por tipo, canal, empresa, categoria, etapa e mês. Grupos com menos de 5 casos são suprimidos e, se o total for insuficiente, retorna `sufficient` igual a `false`. Requer a permissão `reporting.reports.read`; nunca abre um caso. Canal ou empresa fora do seu escopo → `404`.
Baixar indicadores em CSV
Os mesmos indicadores agregados em CSV, com colunas dimensão, grupo, quantidade e suprimido (quantidade vazia quando suprimida). Células que uma planilha executaria como fórmula são neutralizadas. Requer a permissão `reporting.reports.read`.
Listar ações preventivas
Lista até 500 ações preventivas das empresas no seu escopo, com fator de risco, responsável, prazo, status, verificação e se estão atrasadas. Requer a permissão `reporting.reports.read`.
Criar ação preventiva
Cria uma ação preventiva com título, fator de risco, medida, responsável e prazo opcionais, para uma empresa ou para todo o grupo. Requer a permissão `reporting.prevention.manage` e não aceita chave de API. Ação de todo o grupo exige acesso a todas as empresas; empresa fora do escopo → `422`; responsável que não é membro ativo → `422`.
Atualizar ação preventiva
Altera título, medida, responsável, prazo, status (`planned`, `in_progress`, `done`, `canceled`) e verificação da ação (`action_id` é o UUID da ação). Concluir exige descrever a verificação. Requer a permissão `reporting.prevention.manage` e não aceita chave de API. Concorrência otimista por `expected_version` (`409` se divergente); ação inexistente → `404`; dados inválidos → `422`.
Baixar cartaz do canal em PDF
Gera o cartaz A4 em PDF de um canal (por slug ou id), com QR code e endereço montados a partir do endereço público da organização, tema (`classic`, `vibrant`, `light`), título e mensagem opcionais; o hash vem no cabeçalho `X-Poster-Sha256`. Requer a permissão `reporting.channels.read` e exige acesso a todas as empresas (`403`). Canal ou empresa não encontrados → `404`; canal não ativo sem `allow_draft` → `409` (com `allow_draft`, cada página leva a marca RASCUNHO); texto que não cabe → `422`.
Consultar política de retenção
Retorna por quantos dias (`keep_days`) os casos de relato encerrados são mantidos antes de poderem ser descartados. Requer a permissão `reporting.retention.manage` e exige acesso a todas as empresas (`403`).
Definir política de retenção
Define o prazo de retenção `keep_days` (30 a 36500 dias) dos casos de relato encerrados. Requer a permissão `reporting.retention.manage`, exige acesso a todas as empresas (`403`) e não aceita chave de API.
Listar casos elegíveis para descarte
Lista até 500 casos encerrados há mais tempo que a política de retenção e ainda não descartados, indicando os que têm bloqueio de descarte. Requer a permissão `reporting.retention.manage`, exige acesso a todas as empresas (`403`) e ser autoridade de concessão (`403` caso contrário). Sem política definida, a lista vem vazia.
Definir bloqueio de descarte do caso
Aplica ou libera o bloqueio de descarte (retenção legal) do caso, com `reason_code` (`legal_hold`, `investigation`, `audit`, `inspection`, `other`); a ação fica no histórico de acessos. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); requer a permissão `reporting.retention.manage` e acesso ao caso. Caso que não é relato → `404`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Descartar caso
Apaga de forma irreversível o conteúdo de um caso encerrado além do prazo de retenção (identidade, respostas, mensagens, anexos), mantendo o registro do descarte; `confirm_code` deve repetir o código do caso. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); requer a permissão `reporting.retention.manage`, exige acesso a todas as empresas (`403`) e ser autoridade de concessão (`403`). Fora do prazo, código divergente, já descartado ou bloqueio liberado pela mesma pessoa nas últimas 24 horas → `409`; caso com bloqueio de descarte → `409`. O parâmetro `demand_id` é o código público do caso (4 caracteres).
Gerar pacote de evidências
Monta na hora o pacote de evidências da organização para fiscalização e responde o ZIP, com hashes nos cabeçalhos `X-Evidence-*`; nada é armazenado além de hashes e metadados no histórico, gravado antes de o ZIP sair. Exige `acknowledge` igual a `true`, com período e empresas opcionais. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`); requer a permissão `reporting.evidence.export` e acesso a todas as empresas. Limites ou tempo de montagem excedidos → `422` (a recusa fica no histórico); outro pacote em montagem → `409`; limite por hora → `429`; o cabeçalho de idempotência não é aceito.
Listar pacotes de evidências
Lista o histórico de pacotes gerados e recusados da organização, paginado no envelope `{items, page}` com `limit` (até 100) e `cursor`. O filtro `sha256` encontra o pacote cujo hash do pacote ou do manifesto é igual ao informado (hash inválido → `422`, com limite por hora). Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Requer a permissão `reporting.evidence.export`.
Consultar pacote de evidências
Retorna os metadados de um pacote do histórico (`pack_id` é o UUID): status, parâmetros, hashes, contagens, omissões e motivo de recusa. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Requer a permissão `reporting.evidence.export`. Pacote inexistente → `404`.
Baixar recibo do pacote de evidências
Retorna o recibo de um pacote gerado, em JSON (padrão) ou em PDF de uma página com `format=pdf`. Exige sessão humana com segundo fator confirmado e vínculo ativo na organização; chaves de API não são aceitas (`403`). Requer a permissão `reporting.evidence.export`. Pacote inexistente → `404`; pacote recusado → `409`.
Listar políticas de prazo
Lista as políticas de prazo da organização: a padrão e as específicas por canal, com total de horas, tipo de calendário (úteis ou corridos), percentual de alerta e horário de expediente. Requer a permissão `reporting.channels.read`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Definir política de prazo
Cria ou substitui a política de prazo padrão (sem `channel_id`) ou de um canal: `total_hours` de 1 a 24000, `calendar` `business` ou `calendar`, `warn_pct` de 1 a 99 e expediente com fim depois do início. Requer a permissão `reporting.channels.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API. Dados inválidos respondem `422`; canal inexistente, `404`.
Listar prazos por categoria
Lista cada categoria de denúncia com o prazo efetivo e a origem dele: `custom` (definido pela organização), `product` (padrão do produto) ou `default` (política padrão). Requer a permissão `reporting.channels.read`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Definir prazo da categoria
Define o prazo em horas (1 a 24000) de uma categoria identificada pela chave `key`; enviar `total_hours` nulo volta ao padrão do produto, e o calendário e o expediente seguem a política padrão. Requer a permissão `reporting.channels.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API. Categoria inexistente responde `404`.
Listar feriados
Lista os feriados cadastrados para o ano informado em `year` (padrão: ano atual), usados no cálculo de prazos em dias úteis. Requer a permissão `reporting.channels.read`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Definir feriado
Cadastra ou renomeia o feriado de uma data (`name` de 1 a 120 caracteres) ou o remove com `remove: true`. Requer a permissão `reporting.channels.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API. Dados inválidos respondem `422`.
Consultar prazo do caso
Retorna a situação do prazo de um caso: prazo configurado, vencimento, alerta e estado. Qualquer membro autenticado que possa ver o caso pode consultar. `demand_id` é o código público do caso; caso inexistente ou que você não pode ver responde `404`.
Prorrogar prazo do caso
Prorroga o prazo do ciclo atual do caso em `hours` (1 a 2400) com um motivo em `reason_code`; a soma das prorrogações do ciclo não pode passar de 2400 horas e um clique repetido em até 15 segundos não duplica a prorrogação. Requer a permissão `requests.demands.transition` e não pode ser feito por chave de API. `demand_id` é o código público do caso; caso inexistente ou que você não pode ver responde `404`. Caso encerrado responde `409`; caso sem prazo configurado ou dados inválidos, `422`.
Consultar relatório de prazos
Resume o cumprimento de prazos dos casos recebidos no período `from`/`to`: cumpridos, perdidos e em atraso. Para proteger o anonimato, abaixo de 5 casos medidos retorna apenas `sufficient: false`, e contagens pequenas são omitidas. Requer a permissão `reporting.reports.read`.
Consultar configuração da triagem por IA
Retorna se a triagem assistida por IA está ligada na organização e em cada canal, o limite diário de análises e o que é enviado para análise (apenas o texto do relato). Requer a permissão `reporting.channels.read`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Atualizar configuração da triagem por IA
Liga ou desliga a triagem por IA na organização (`enabled`) e por canal (`channels`, mapa de id do canal para booleano); análises na fila de canais que ficaram desligados são canceladas. Requer a permissão `reporting.ai.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API. Canal inexistente responde `404`.
Consultar triagem do caso
Retorna a triagem por IA do caso: se está ligada no canal, a última análise solicitada, a última sugestão (pendente, revisada ou obsoleta) e se a reclassificação aplicada ainda pode ser desfeita. Qualquer membro autenticado que possa ver o caso pode consultar. `demand_id` é o código público do caso; caso inexistente ou que você não pode ver responde `404`.
Solicitar triagem por IA
Coloca o caso na fila de análise por IA e responde `202`; se já houver análise na fila, responde `already_queued`. Requer a permissão `requests.demands.triage` e não pode ser feito por chave de API. `demand_id` é o código público do caso; caso inexistente ou que você não pode ver responde `404`. Triagem desligada no canal responde `409`.
Desfazer reclassificação da IA
Restaura a categoria escolhida por quem relatou, a prioridade original e remove a gravidade definida pela IA, enquanto ninguém da equipe começou a tratar o caso; desfazer uma elevação para a fila protegida exige quem pode conceder acesso ao caso (`403`). Requer a permissão `requests.demands.transition`. `demand_id` é o código público do caso; caso inexistente ou que você não pode ver responde `404`. Sem reclassificação para desfazer ou caso já em tratamento responde `409`.
Registrar revisão da sugestão da IA
Registra a decisão humana sobre cada parte da sugestão (`summary`, `type`, `category`, `priority`, `conflicts`, `questions`) como `accepted`, `modified` ou `rejected`. `suggestion_id` é o UUID da sugestão. Requer a permissão `requests.demands.triage` e não pode ser feito por chave de API. Sugestão já revisada ou feita sobre um relato que mudou responde `409`.
Listar automações
Lista as automações da organização com seus destinos, os limites (ativas, passos, destinatários, avisos por hora) e se metadados do caso podem ir para endereços externos. Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Criar automação
Cria uma automação como rascunho, com nome, descrição e definição (gatilho, condições e passos); ela nunca é executada antes de ser publicada. Requer a permissão `reporting.automations.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API. Dados inválidos respondem `422`; limite de automações atingido, `409`.
Consultar opções do editor de automações
Retorna o que o editor de automações oferece: canais, empresas, categorias, etapas, membros, e-mails de aviso, webhooks, canais do Slack e do Teams e limites. Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Testar automação
Simula a definição sobre um caso que você pode ver (`demand_id` no corpo é o código público do caso): quais condições casam, quem receberia cada aviso e o texto dos avisos; nada é enviado ou registrado. Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. Definição com pendências responde `422`; caso não encontrado, `404`.
Calcular alcance da automação
Informa quantos casos abertos um gatilho de tempo alcançaria agora (eles disparam na primeira passagem), com até 20 exemplos que você pode ver; para gatilhos que não são de tempo, responde `applies: false`. Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. Definição com pendências responde `422`.
Consultar automação
Retorna uma automação pelo UUID, com estado, rascunho e versão publicada. Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Automação inexistente ou excluída responde `404`.
Salvar rascunho da automação
Edita o rascunho da automação; uma automação publicada continua executando a versão publicada até a próxima publicação. Usa concorrência otimista por `expected_version` (versão divergente responde `409`). Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. Automação inexistente responde `404`; dados inválidos, `422`.
Publicar automação
Publica o rascunho como nova versão e ativa a automação, com concorrência otimista por `expected_version` (versão divergente responde `409`). Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. Definição com pendências responde `422`; limite de automações ativas atingido, `409`.
Alterar estado da automação
Executa `action`: `pause` (cancela o que está na fila), `resume` (não reexecuta o que passou), `discard_draft` ou `delete` (só para automação não ativa). Usa concorrência otimista por `expected_version` (versão divergente responde `409`). Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. Ação incompatível com o estado atual responde `409`.
Listar versões da automação
Lista as versões publicadas da automação, da mais recente para a mais antiga, com a definição, a data e quem publicou. Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Automação inexistente responde `404`.
Listar execuções da automação
Lista as execuções e o resultado de cada aviso (estado, tentativas, erro e destinatário), nunca o corpo da mensagem; o caso só é identificado para quem pode vê-lo. Paginação por `limit` (até 100) e `before` (data/hora). Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Automação inexistente responde `404`.
Listar e-mails de aviso
Lista os e-mails externos cadastrados para receber avisos de automações, com o estado de confirmação, e o limite de endereços. Requer a permissão `reporting.automations.read` ou `reporting.automations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Cadastrar e-mail de aviso
Cadastra um e-mail externo com rótulo opcional; ele recebe um link de confirmação e nada mais até confirmar. Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API. E-mail já cadastrado ou limite atingido responde `409`.
Reenviar confirmação do e-mail de aviso
Reenvia o link de confirmação de um e-mail de aviso; um endereço já confirmado é devolvido sem novo envio. Só é possível reenviar depois de 2 minutos do último envio (`429`). Requer a permissão `reporting.automations.manage` e não pode ser feito por chave de API; endereço inexistente responde `404`.
Remover e-mail de aviso
Remove um e-mail de aviso da organização. Requer a permissão `reporting.automations.manage`. Não pode ser feito por chave de API. Endereço inexistente ou já removido responde `404`.
Consultar configurações de integrações
Retorna se avisos para endereços externos podem incluir metadados do caso (`external_metadata`). Requer uma das permissões `reporting.automations.read`, `reporting.automations.manage` ou `reporting.integrations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Atualizar configurações de integrações
Permite ou não incluir metadados do caso nos avisos para endereços externos (`external_metadata`); desligado por padrão, a alteração fica registrada na auditoria. Requer a permissão `reporting.integrations.manage` e exige acesso a todas as empresas da organização (`403` caso contrário). Não pode ser feito por chave de API.
Listar conexões do Slack
Lista os espaços de trabalho do Slack conectados e seus canais, além de se o Slack está disponível nesta instalação. Nunca retorna o token. Requer uma das permissões `reporting.automations.read`, `reporting.automations.manage` ou `reporting.integrations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Iniciar instalação do Slack
Retorna o endereço para onde levar a pessoa para instalar o app do Slack. O `state` vale uma única vez, por dez minutos, e fica vinculado a esta pessoa e a esta organização. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API; Slack não configurado responde `409`.
Concluir instalação do Slack
Conclui a instalação com o `code` e o `state` que o Slack devolveu e sincroniza os canais; o token é guardado cifrado e nunca é retornado. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API. `state` inválido, já usado ou expirado responde `409`; recusa do Slack, `502`.
Sincronizar canais do Slack
Consulta de novo os canais do espaço de trabalho; um canal privado aparece depois que o app é convidado para ele. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API. Limitado a 30 por hora por conexão (`429`). Conexão inexistente responde `404`; desconectada, `409`; falha no Slack, `502`.
Definir canais do Slack habilitados
Define exatamente quais canais do espaço de trabalho as automações podem avisar (`enabled`, até 50). Requer a permissão `reporting.integrations.manage`. Não pode ser feito por chave de API. Conexão inexistente responde `404`.
Testar canal do Slack
Envia uma mensagem de teste (sem relação com nenhum caso) para um canal e informa em `ok` e `error` o que o Slack respondeu. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API. Limitado a 30 por hora por conexão (`429`). Conexão ou canal inexistente responde `404`; conexão desconectada, `409`.
Desconectar espaço de trabalho do Slack
Revoga o token no Slack e o descarta; avisos na fila para os canais desse espaço são cancelados e as automações que os usavam precisam de atenção. Requer a permissão `reporting.integrations.manage`. Não pode ser feito por chave de API. Conexão inexistente responde `404`.
Listar canais do Teams
Lista os canais do Teams cadastrados, com disponibilidade e limite (30). Nunca retorna o endereço do webhook, apenas o host. Requer uma das permissões `reporting.automations.read`, `reporting.automations.manage` ou `reporting.integrations.manage`. Exige acesso a todas as empresas da organização (`403` caso contrário).
Cadastrar canal do Teams
Cadastra um canal pelo endereço do webhook criado nele. O endereço precisa aceitar uma mensagem de teste antes: um endereço errado ou inativo é recusado aqui (`422`), não no primeiro aviso real. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API. Nome repetido ou limite de 30 canais atingido responde `409`; limitado a 30 cadastros por hora (`429`).
Testar canal do Teams
Envia uma mensagem de teste (sem relação com nenhum caso) e informa o resultado em `ok` e `error`. Um canal que volta a responder é marcado como disponível; um cujo endereço deixou de existir, como indisponível. Requer a permissão `reporting.integrations.manage` e não pode ser feito por chave de API. Limitado a 30 por hora por canal (`429`); canal inexistente responde `404`.
Remover canal do Teams
Remove o canal do Teams, apaga o endereço guardado e cancela os avisos na fila para ele. Requer a permissão `reporting.integrations.manage`. Não pode ser feito por chave de API. Canal inexistente ou já removido responde `404`.