Pular para o conteúdo
Entrar

Documentação da API

Ligue o Omni ao seu CRM, formulário ou planilha: cadastre contatos, ponha cada um nas campanhas certas, diga quando o lead fechou por outro caminho e leia o que o Omni fez.

Começo rápido

  1. Crie uma chave

    Entre no Omni e abra Chaves de API. Quem tem cargo owner ou admin cria a chave, dá um nome a ela e escolhe o escopo: leitura só consulta, escrita também cadastra e altera. Para seguir este começo, escolha escrita. A chave aparece uma vez só: copie e guarde num lugar seguro. Abrir Chaves de API

  2. Mande a chave em toda chamada

    No cabeçalho Authorization, depois da palavra Bearer. Toda chave começa com omni_.

    Cabeçalho
    Authorization: Bearer omni_…
  3. Faça a primeira chamada

    Cadastre um contato. A resposta é 201, com o contato criado e o id dele.

    curl
    curl -X POST https://omni.aipecorp.com/api/contacts \
      -H "Authorization: Bearer SUA_CHAVE" \
      -H "Content-Type: application/json" \
      -d '{"name": "Maria Souza", "phoneNumber": "+551155500100"}'

Autenticação

A chave vai no cabeçalho Authorization: Bearer omni_… ou, se a sua ferramenta não deixa mexer nesse cabeçalho, em X-Api-Key: omni_…. Com os dois, vale o Authorization.

A chave alcança só as rotas desta página marcadas com «Chave de API». As demais servem à própria tela do Omni e pedem login: com chave, respondem 403.

Toda chave tem um escopo, escolhido ao criar. A de leitura (read) só consulta: usa as rotas GET. A de escrita (write) usa todas as rotas marcadas com «Chave de API», e as que escrevem dizem «Chave de API de escrita». Chave de leitura numa escrita (POST, PUT, PATCH, DELETE) recebe 403 «Esta chave de API é só de leitura: para cadastrar ou alterar, use uma chave de escrita.» O escopo não muda depois: para trocar, crie outra chave e revogue a antiga. As chaves criadas antes do escopo existir são de escrita.

Revogar a chave em Chaves de API corta o acesso na hora: a chamada seguinte já recebe 401.

A validade também se escolhe ao criar: sem validade (o padrão), 30, 90 ou 365 dias na tela, ou de 1 a 3.650 dias pela API, em expiresInDays. Vencida, a chave recebe 401 «Chave de API vencida: crie outra em Chaves de API e troque no seu sistema.»

Sem chave, o Omni trata a chamada como se viesse do navegador. Por isso uma escrita (POST, PUT, PATCH, DELETE) sem a chave recebe 403 «Origem da requisição não permitida.», e não 401.

Formato

  • Corpo e resposta em JSON, com as chaves em inglês. Mande Content-Type: application/json nas escritas; o corpo vai até 64 KB.
  • Telefone sempre no formato internacional, com + e o código do país: +551155500100. Espaço, parênteses e hífen são limpos.
  • Datas em ISO 8601, em UTC: 2026-10-11T14:30:00.000Z.
  • Nenhuma resposta fica em cache: todas saem com Cache-Control: no-store.

Erros

Todo erro vem em JSON, com a mensagem em português em error. Quando o problema é um campo, field diz qual.

Resposta 400
{
  "error": "Informe o telefone com + e o código do país, de 8 a 15 dígitos.",
  "field": "phoneNumber"
}
400
Algum dado não passou, ou o corpo trouxe um campo que a rota não conhece. A resposta diz o quê e em qual campo.
401
Chave ausente, inválida, revogada ou vencida. A resposta leva WWW-Authenticate: Bearer.
403
A rota não aceita chave de API, a chave é de leitura e a chamada escreve, ou a escrita veio sem chave.
404
O recurso não existe. Um id que não é uuid também dá 404.
409
Conflito: já existe um contato com este telefone.
413
Corpo acima de 64 KB, ou CSV acima de 1 MB na importação, ou formulário acima de 16 KB.
415
Importação com um tipo que não é CSV, ou formulário que não vem como form HTML nem JSON.
429
Só no formulário do site: envios demais em pouco tempo. Espere o que diz Retry-After.
500
Erro do Omni. A mensagem é sempre «Erro interno.», sem detalhe.

A API não limita o número de chamadas por chave e nenhuma rota com chave responde 429. Mesmo assim, prefira a importação por CSV a milhares de cadastros um por um. Só o Formulário do site, que não usa chave, tem limite de envios.

Paginação

Toda lista vem com o nome do recurso e um bloco pagination. Peça a página com page e o tamanho com limit.

Resposta 200
{
  "contacts": [ … ],
  "pagination": { "page": 1, "limit": 50, "total": 120, "totalPages": 3 }
}
pageinteiro
A página devolvida.
limitinteiro
Itens por página.
totalinteiro
Quantos itens existem com os filtros pedidos.
totalPagesinteiro
Quantas páginas há com esse limit.

page abaixo de 1 ou limit fora de 1 a 200 dá 400, com field igual a page ou limit.

Contatos

O lead que o Omni procura. Qualquer cargo e a chave cadastram, leem, atualizam, importam e concluem.

O contato

iduuid
Identificador do contato.
nametexto
Nome.
phoneNumbertexto
Telefone com + e o código do país. Único entre os contatos.
timezonetexto ou null
Fuso horário IANA, como America/Sao_Paulo.
statustexto
active (ativo), paused (pausado) ou fulfilled (concluído).
customVariablesobjeto
Variáveis livres do contato: nome e valor.
voiceConsentAtdata ou null
Quando o contato aceitou receber ligação. O Omni só exige este consentimento para ligar a número dos EUA.
voiceConsentSourcetexto ou null
De onde veio: form, import, manual ou api.
voiceConsentProoftexto ou null
A prova do consentimento, como o texto aceito ou o registro do formulário.
campaignslista
Campanhas em que o contato está: { id, name, phase, phaseName }. phase é a chave da fase dele naquela campanha e phaseName o nome dela; sem fase, os dois são null.
fulfilledInlista
Campanhas em que foi concluído: { campaignId, campaignName, fulfilledAt, fulfillmentSource }
fulfilledAtdata ou null
Quando foi concluído.
fulfillmentSourcetexto ou null
Quem concluiu: o source mandado em Concluir, ou manual.
reAddedAtdata ou null
Quando saiu de concluído e voltou para ativo ou pausado.
createdAtdata
Quando foi criado.
updatedAtdata
Última alteração.

Listar contatos

GET/api/contacts

Do mais novo para o mais antigo, com filtro e busca.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
statustexto
active, paused ou fulfilled.
campaignIduuid
Só os contatos desta campanha.
phasetexto
Só os contatos nesta fase da campanha, pela chave ou pelo nome. Pede campaignId; sem ele, dá 400.
qtexto
Busca no nome e no telefone, até 100 caracteres. Acha também pelos dígitos.

Resposta

200
{ contacts, pagination }.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/contacts?status=active&limit=20" \
  -H "Authorization: Bearer SUA_CHAVE"

Cadastrar um contato

POST/api/contacts

Quando um lead chega pelo seu CRM ou formulário.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

nametextoobrigatório
De 1 a 200 caracteres.
phoneNumbertextoobrigatório
Com + e o código do país, de 8 a 15 dígitos.
timezonetexto ou null
Fuso IANA. Fuso desconhecido dá 400.
customVariablesobjeto
Até 50 variáveis. Nome até 64 caracteres; valor texto (até 1.000), número ou booleano.
campaignIdslista de uuid
Até 100 campanhas em que o contato entra.
splitterIduuid
No lugar de campaignIds: o Splitter escolhe uma campanha e registra o porquê. Os dois juntos dão 400.
voiceConsentAtdata
AAAA-MM-DD ou data ISO com fuso, nunca no futuro. Com ela, a prova é obrigatória.
voiceConsentSourcetexto
form, import, manual ou api (padrão). Sem a data, dá 400.
voiceConsentProoftexto
De 1 a 1.000 caracteres. Sem a data, dá 400.

Resposta

201
O contato criado.
400
Campo inválido. Campanha que não existe: «Uma das campanhas informadas não existe.»
409
Já existe um contato com este telefone (field: phoneNumber).
curl
curl -X POST https://omni.aipecorp.com/api/contacts \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"name": "Maria Souza", "phoneNumber": "+551155500100"}'

Ler um contato

GET/api/contacts/{id}

O contato com as campanhas em que está.

Chave de API ou login de qualquer cargo.

Resposta

200
O contato.
404
«Contato não encontrado.» Também para id que não é uuid.
curl
curl https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO \
  -H "Authorization: Bearer SUA_CHAVE"

Editar um contato

PATCH/api/contacts/{id}

Mande só o que muda; tudo grava junto ou nada grava. customVariables troca o objeto inteiro e campaignIds troca a lista inteira de campanhas. Telefone novo apaga o consentimento de voz.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

nametexto
De 1 a 200 caracteres.
phoneNumbertexto
Novo telefone, com + e o código do país.
timezonetexto ou null
Fuso IANA.
statustexto
active ou paused. Para concluir, use Concluir o atendimento. Sair de fulfilled marca reAddedAt.
customVariablesobjeto
Substitui as variáveis atuais.
campaignIdslista de uuid
Substitui as campanhas atuais.
voiceConsentAt, voiceConsentSource, voiceConsentProof
Como no cadastro, e substituem o consentimento atual. voiceConsentAt: null, sem fonte nem prova, retira o consentimento.

Resposta

200
O contato atualizado.
400
Campo inválido.
404
«Contato não encontrado.» Também para id que não é uuid.
409
Outro contato já tem este telefone.
curl
curl -X PATCH https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'

Editar pelo telefone

PATCH/api/contacts/by-phone

Igual a Editar um contato, mas acha o contato pelo telefone: útil quando o seu sistema não guarda o id do Omni. Aqui o telefone identifica e não muda.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

phoneNumbertextoobrigatório
Telefone do contato que você quer editar.
name, timezone, status, customVariables, campaignIds, voiceConsentAt, voiceConsentSource, voiceConsentProof
Como em Editar um contato.

Resposta

200
O contato atualizado.
400
Campo inválido.
404
«Nenhum contato com este telefone.»
curl
curl -X PATCH https://omni.aipecorp.com/api/contacts/by-phone \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "+551155500100", "customVariables": {"plano": "anual"}}'

Concluir o atendimento

POST/api/contacts/fulfill

Quando o lead fechou por outro caminho e o Omni deve parar de procurar por ele. O contato passa a fulfilled.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

iduuid
O contato. Sem id, vale o phoneNumber.
phoneNumbertexto
O telefone do contato, se você não tem o id.
campaignIduuid
Marca a conclusão também nesta campanha; se o contato não estava nela, entra já concluído.
sourcetexto
Quem concluiu: de 1 a 60 caracteres entre a-z, 0-9, _ e -. Padrão: manual.

Resposta

200
O contato concluído.
400
Sem id e sem telefone: «Informe o id ou o telefone do contato.» (field: id).
404
Contato não encontrado.
curl
curl -X POST https://omni.aipecorp.com/api/contacts/fulfill \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber": "+551155500100", "source": "crm"}'

Status possíveis

GET/api/contacts/statuses

A lista dos status de contato, para preencher um campo de escolha no seu sistema.

Chave de API ou login de qualquer cargo.

Resposta

200
{ "statuses": ["active", "paused", "fulfilled"] }
401
Chave ausente, inválida, revogada ou vencida.
curl
curl https://omni.aipecorp.com/api/contacts/statuses \
  -H "Authorization: Bearer SUA_CHAVE"

Importar um CSV

POST/api/contacts/import

Muitos contatos de uma vez. Cada linha passa pelas mesmas regras do cadastro; a linha com erro fica de fora e volta na lista de erros, e as boas gravam juntas.

Chave de API de escrita ou login de qualquer cargo.

Parâmetros na URL

campaignIduuid
Põe todos os contatos importados nesta campanha.
duplicatestexto
skip (padrão) deixa como está o contato cujo telefone já existe; update atualiza com a linha do CSV.
defaultCountrytexto
55 (padrão) completa com +55 o número sem + que tem DDD e 10 ou 11 dígitos; none exige o + em todos.

Corpo

O arquivo cru, com Content-Type: text/csv, até 1 MB e 5.000 contatos. Separador vírgula ou ponto e vírgula. A primeira linha é o cabeçalho: nome ou name, telefone (ou phone, phoneNumber, celular, whatsapp) e, se quiser, fuso ou timezone. Para o consentimento de voz, consentimento_voz (ou voice_consent_at) com a data e prova_consentimento (ou voice_consent_proof); gravam com a fonte import, e prova sem data é erro na linha. As outras colunas viram variáveis do contato, até 50.

Resposta

200
{ total, created, updated, skipped, errors }. Cada erro é { line, field, error }, com a linha como a planilha mostra (o cabeçalho é a linha 1); voltam até 100.
400
Arquivo sem a coluna de nome ou de telefone, vazio ou com mais de 5.000 contatos.
413
Arquivo acima de 1 MB.
415
«Envie o arquivo CSV como text/csv.»
curl
curl -X POST "https://omni.aipecorp.com/api/contacts/import?duplicates=update" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: text/csv" \
  --data-binary @contatos.csv

Não contatar

Se o número do contato pode ser procurado, e a lista interna da sua conta: o Omni não procura mais o número que entra nela, em nenhuma campanha.

Códigos de bloqueio

Em blockedBy e no reason de Quem não foi contatado. null: nada impede.

lista_interna
O número está na lista interna da sua conta.
lista_nacional
O número está na lista nacional de não ligar dos EUA.
lista_estadual
O número está numa lista estadual de não ligar.
nacional_ausente
Número dos EUA e a lista nacional não foi carregada nos últimos 31 dias.
estado_sem_regra
Número de um estado dos EUA sem regra conferida.
fora_de_regra
Número fora do Brasil e dos EUA: não há regra de contato.
tentativas
O limite de tentativas do estado foi atingido.

Ver se pode contatar

GET/api/contacts/{id}/do-not-contact

A região do número, as listas em que ele está e o motivo por que o Omni não o procuraria agora. Não conta o horário permitido nem o limite de tentativas.

Chave de API ou login de qualquer cargo.

Resposta

200
{ country, state, states, areaCode, timezones, lists, internal, blockedBy }country é BR, US ou null. Cada lista é { id, name, kind, state, listDate, source, addedAt }internal é a entrada da lista interna, ou null.
404
«Contato não encontrado.» Também para id que não é uuid.
curl
curl https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/do-not-contact \
  -H "Authorization: Bearer SUA_CHAVE"

Pôr na lista interna

PUT/api/contacts/{id}/do-not-contact

Sem corpo. Chamar de novo não muda nada. Tirar da lista pede login de owner ou admin.

Chave de API de escrita ou login de qualquer cargo.

Resposta

200
O status atualizado, como em Ver se pode contatar.
404
«Contato não encontrado.» Também para id que não é uuid.
curl
curl -X PUT https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/do-not-contact \
  -H "Authorization: Bearer SUA_CHAVE"

Campanhas do contato

Em que campanhas o contato está e em que ponto da sequência de cada uma.

Situação na campanha

Em situation. failure diz por que a última tentativa não andou: um código de bloqueio, sem_janela (sem horário permitido em 14 dias), interna (erro do Omni) ou outra (erro do provedor).

em_andamento
Na sequência: step diz o passo atual e nextRunAt a próxima ação.
na_fila
Tudo pronto; o Omni põe o contato na sequência na próxima volta.
concluida
Concluído nesta campanha.
contato_concluido
O contato foi concluído, em geral ou noutra campanha, e não recebe mais nada.
terminou
A sequência desta campanha chegou ao fim.
contato_pausado
O contato está pausado: nada anda até reativar.
campanha_pausada
A campanha está pausada: nada anda até reativar.
qualificado
A qualificação aprovou o lead antes da sequência: vai para o time e não recebe passo.
desqualificado
A qualificação descartou o lead antes da sequência: não recebe passo.
sem_passos
A campanha ainda não tem sequência.

Ver as campanhas do contato

GET/api/contacts/{id}/campaigns

Uma linha por campanha, com a situação dele nela.

Chave de API ou login de qualquer cargo.

Resposta

200
{ campaigns }. Cada uma: { campaignId, campaignName, campaignStatus, addedAt, situation, step, steps, nextRunAt, lastRunAt, fulfilledAt, finishedAt, failure }
404
«Contato não encontrado.» Também para id que não é uuid.
curl
curl https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns \
  -H "Authorization: Bearer SUA_CHAVE"

Pôr numa campanha

PUT/api/contacts/{id}/campaigns/{campaignId}

Sem corpo. Se o contato já está nela, nada muda.

Chave de API de escrita ou login de qualquer cargo.

Resposta

200
{ campaigns }, como em Ver as campanhas do contato.
404
«Contato não encontrado.» ou «Campanha não encontrada.»
curl
curl -X PUT https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns/ID_DA_CAMPANHA \
  -H "Authorization: Bearer SUA_CHAVE"

Trocar a fase na campanha

PATCH/api/contacts/{id}/campaigns/{campaignId}

Muda à mão a fase do contato numa campanha em que ele já está. As fases são as que a campanha define.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

phasetexto ou nullobrigatório
A chave ou o nome da fase, até 200 caracteres. null tira a fase.

Resposta

200
O contato inteiro, com a fase nova em campaigns.
400
Sem phase, fase que a campanha não tem ou campanha sem fases (field: phase).
404
«Contato não encontrado nesta campanha.»
curl
curl -X PATCH https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns/ID_DA_CAMPANHA \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"phase": "qualificado"}'

Ler a qualificação na campanha

GET/api/contacts/{id}/campaigns/{campaignId}/qualification

O que o contato respondeu às perguntas da campanha e em que pé está. Cada resposta diz a origem: confirmado (ele respondeu à pergunta feita, ou alguém do time confirmou) ou deduzido (o Omni achou numa mensagem que não respondia a essa pergunta).

Chave de API ou login de qualquer cargo.

Resposta

200
{ contactId, campaignId, campaignName, status, reason, decidedAt, currentQuestion, questionAskedAt, leadRequest, lastInboundChannel, lastInboundAt, conversationHoldUntil, handoffAt, criteria, answers }status é pendente, qualificado ou desqualificado; answers são { key, question, type, value, label, origin, messageId, userId, history, updatedAt }, e history guarda o que cada resposta substituiu.
404
«Contato não encontrado nesta campanha.»
curl
curl https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns/ID_DA_CAMPANHA/qualification \
  -H "Authorization: Bearer SUA_CHAVE"

Confirmar ou corrigir uma resposta

PATCH/api/contacts/{id}/campaigns/{campaignId}/qualification

Confirma uma resposta deduzida ou troca o valor. A resposta fica confirmado; a situação é decidida de novo e, com as fases dinâmicas ligadas, a fase do contato acompanha. Daqui o Omni não chama ninguém do time.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

keytextoobrigatório
A key de um dos critérios da campanha.
valuetexto, número ou nullobrigatório
A resposta: o value de uma opção, sim ou nao, um número, ou texto até 500 caracteres. null tira a resposta.

Resposta

200
A qualificação inteira, como no GET.
400
Critério que a campanha não tem ou campanha sem critérios (field: key); resposta que não serve para o critério (field: value).
404
«Contato não encontrado nesta campanha.»
curl
curl -X PATCH https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns/ID_DA_CAMPANHA/qualification \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"key": "tipo", "value": "casa"}'

Tirar de uma campanha

DELETE/api/contacts/{id}/campaigns/{campaignId}

Sem corpo. O contato sai da campanha; se ele já não estava nela, a resposta é a mesma.

Chave de API de escrita ou login de qualquer cargo.

Resposta

204
Sem corpo.
404
Contato ou campanha não encontrados.
curl
curl -X DELETE https://omni.aipecorp.com/api/contacts/ID_DO_CONTATO/campaigns/ID_DA_CAMPANHA \
  -H "Authorization: Bearer SUA_CHAVE"

Campanhas

A chave lê as campanhas para você achar o id certo. Criar, editar e apagar campanha é na tela do Omni, por quem tem cargo owner ou admin.

A campanha

Além destes campos, vem o resto da configuração que o editor grava: os horários (workingHours), os canais e os agentes.

iduuid
Identificador da campanha.
nametexto
Nome.
statustexto
active ou paused.
contactsCountinteiro
Quantos contatos estão nela.
phoneIduuid ou null
O telefone ligado à campanha.
phoneNumbertexto ou null
O número desse telefone.
goalTypetexto
O que acontece com o lead pronto: transferir, transferir_ou_agendar, receber_webhook, agendar ou so_qualificar. Com receber_webhook, a entrega fica na fila do time, como em so_qualificar, e o Omni faz um POST em JSON (evento lead.ready, cabeçalhos X-Omni-Event, X-Omni-Delivery e, com segredo, X-Omni-Signature) ao endereço da campanha.
goalWebhookUrltexto ou null
Endereço https do webhook do objetivo receber_webhook, na porta padrão; endereço privado ou interno é recusado no envio.
whatsappSenderIduuid ou null
O número de WhatsApp que a campanha usa.
qualificationCriterialista
As perguntas da qualificação, até 20: { key, question, type, options, disqualifyIf, min, max, disqualifyReason }type é options, yesno, number ou text; options são { value, label, synonyms }. disqualifyIf diz quais respostas desqualificam (no número, min e max dão a faixa aceita) e disqualifyReason vem de notQualifyingReasons. Lista vazia: a campanha não qualifica e a resposta às mensagens é a de sempre.
phaseOnQualifiedtexto ou null
Fase para onde vai quem fica pronto, quando dynamicPhasesEnabled está ligado. Tem de ser uma das contactPhases.
phaseOnDisqualifiedtexto ou null
Fase para onde vai quem é desqualificado, nas mesmas condições.
languagetexto ou null
Língua da campanha: en, es ou bilingual.
agentStrategytexto ou null
O que o agente prioriza: qualifications (qualificar por inteiro) ou transfers (transferir logo).
qualificationDepthtexto ou null
Quantas perguntas antes de qualificar: deep (4), standard (3) ou light (2).
agentTemplatetexto ou null
O template por setor de onde saiu o prompt do agente.
scheduleTypetexto
ai-driven (a sequência sai de aiSequenceConfig na criação e no PATCH que traz scheduleType ou aiSequenceConfig sem schedule, e troca os passos que havia) ou fixed (a sequência é a de schedule).
aiSequenceConfigobjeto ou null
Parâmetros do AI-driven: weeks (1 a 12), intensities (uma por semana: level high, normal, low, relaxed ou custom com perWeek), initialActions (call ou sms), inactivity (enabled e hours) e smsMessage.
schedulelista
Os passos da sequência: single (uma action depois de um delay) ou weekly (horários em days). Cada ação tem type (call, sms ou whatsapp; email ainda não existe e dá 400) e settings, com o texto em message. No WhatsApp, settings.templateId (opcional, null é sem modelo) escolhe um dos modelos de whatsappTemplateIds pelo templateId, e então o texto fica opcional; modelo fora da lista, ou templateId em passo de SMS ou ligação, dá 400.
whatsappTemplateIdslista
Os modelos de WhatsApp da campanha: { label, templateId, variableMappings }. Tirar da lista um modelo que um passo usa dá 400: troque antes o modelo do passo.
createdAtdata
Quando foi criada.
updatedAtdata
Última alteração.

Listar campanhas

GET/api/campaigns

Todas as campanhas da conta.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
statustexto
active ou paused.
qtexto
Busca no nome, sem diferenciar maiúscula. Até 120 caracteres.
goaltexto
Só as campanhas com este goalType.
sorttexto
newest (padrão, a mais nova primeiro) ou oldest.

Resposta

200
{ campaigns, pagination }.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/campaigns?status=active&sort=oldest" \
  -H "Authorization: Bearer SUA_CHAVE"

Ler uma campanha

GET/api/campaigns/{id}

A campanha com a configuração inteira.

Chave de API ou login de qualquer cargo.

Resposta

200
A campanha.
404
«Campanha não encontrada.»
curl
curl https://omni.aipecorp.com/api/campaigns/ID_DA_CAMPANHA \
  -H "Authorization: Bearer SUA_CHAVE"

Painel e histórico

Os números do painel, tudo o que o Omni fez (ligações, mensagens e quem ele deixou de procurar) e se o banco de dados responde.

Números do painel

GET/api/dashboard

Os mesmos números dos cartões do painel do Omni. last24h e fulfilledLast24h contam as 24 horas corridas até agora, pelo relógio do servidor, sem fuso nem virada de dia. A faixa de hoje do painel, que segue o fuso escolhido na tela, não vem nesta rota.

Chave de API ou login de qualquer cargo.

Resposta

200
{ campaigns: { active, paused }, contacts: { active, paused, fulfilled, total }, phones: { total }, calls: { total, last24h }, fulfilledLast24h }
401
Chave ausente, inválida, revogada ou vencida.
curl
curl https://omni.aipecorp.com/api/dashboard \
  -H "Authorization: Bearer SUA_CHAVE"

Histórico de ligações e mensagens

GET/api/history

Uma aba por vez, do mais novo para o mais antigo.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

tabtexto
calls (padrão) ou messages. Outro valor dá 400 (field: tab).
pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
campaignIduuid
Só o que foi desta campanha.
statustexto
Ligações: queued, ringing, in_progress, completed, no_answer, busy ou failed. Mensagens: queued, sent, delivered, failed ou received.
channeltexto
Só em messages: sms ou whatsapp.
directiontexto
outbound (o que o Omni fez) ou inbound (o que o contato mandou ou ligou). Outro valor dá 400.

Resposta

200
{ tab, calls, pagination, counts, tabTotal }, com messages no lugar de calls na aba de mensagens. counts é { calls, messages }: o total da aba aberta com todos os filtros e o da outra só com campaignId. tabTotal é o da aba aberta sem filtro.
Ligação: { id, direction, fromNumber, status, provider, providerCallId, startedAt, endedAt, durationSeconds, summary, createdAt, contact, campaign, phone, agent }fromNumber é o número de quem ligou, na recebida, e null na feita.
Mensagem: { id, channel, direction, fromNumber, status, body, provider, providerMessageId, createdAt, contact, campaign, phone }contact vem como { id, name, phoneNumber }, campaign e agent como { id, name }, phone como { id, phoneNumber }; cada um pode ser null.
curl
curl "https://omni.aipecorp.com/api/history?tab=messages&channel=whatsapp" \
  -H "Authorization: Bearer SUA_CHAVE"

Quem não foi contatado

GET/api/history/not-contacted

Contatos que o Omni deixou de procurar numa campanha, e por quê.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.

Resposta

200
{ notContacted, pagination }. Cada um: { contactId, contactName, phoneNumber, campaignId, campaignName, reason, checkedAt, nextRunAt }reason usa os códigos de bloqueio abaixo.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl https://omni.aipecorp.com/api/history/not-contacted \
  -H "Authorization: Bearer SUA_CHAVE"

O banco responde?

GET/api/saude/db

Para vigiar o Omni de fora: faz uma consulta mínima ao banco de dados e diz se ela voltou.

Chave de API ou login de qualquer cargo.

Resposta

200
{ ok: true }: o banco respondeu.
401
Chave ausente, inválida, revogada ou vencida.
500
O banco não respondeu. A resposta não traz detalhe do erro.
curl
curl https://omni.aipecorp.com/api/saude/db \
  -H "Authorization: Bearer SUA_CHAVE"

Entrada

Por onde o provedor avisa o que o contato mandou ou ligou para um número do Omni. Hoje o provedor é o simulado: nada toca e a resposta é um texto fixo que diz que é simulação.

Mensagem recebida

POST/api/entrada/mensagens

Grava a mensagem. Palavra de saída, como STOP ou PARAR, põe o número na lista interna. Depois o agente da campanha responde, se a campanha, o canal, a lista, a janela legal e o limite de tentativas deixam; senão reply.reason diz por quê.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

fromtextoobrigatório
Número de quem mandou, com + e o código do país.
totextoobrigatório
O telefone do Omni que recebeu. Número que não é do Omni dá 400.
bodytextoobrigatório
O texto, até 4.096 caracteres.
channeltexto
sms (padrão) ou whatsapp.
providerMessageIdtexto
Id da mensagem no provedor, até 200 caracteres. O mesmo id de novo devolve a gravada, sem responder outra vez.

Resposta

201
{ message, repeated, optedOut, reply }. reply é { sent, reason, message, context }: context são as mensagens que o agente leu, até o número que a campanha define. Na campanha que qualifica, reply traz também conversation: { qualificationStatus, qualificationReason, currentQuestion, action, leadRequest, found, phase, handoff }, em que action é perguntar, entregar, oferta, encerrar ou livre, found são as respostas tiradas desta mensagem e handoff diz o que a entrega fez (transferido, ofertado, sem_destino ou erro) ou, quando a mensagem respondia a horários oferecidos, o que saiu dela (marcado ou nao_entendeu).
200
A mesma mensagem de novo: a gravada, com repeated: true e reply: null.
400
Campo inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl -X POST https://omni.aipecorp.com/api/entrada/mensagens \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"from": "+551155500100", "to": "+551155500200", "body": "Quero saber mais", "channel": "whatsapp"}'

Ligação recebida

POST/api/entrada/ligacoes

Grava a ligação com o agente de atendimento da campanha do número, ou o de fora do horário. Sem campanha ativa ou sem o agente da hora, fica sem atendimento (no_answer). Lead já pronto para o time (qualificado ou que pediu uma pessoa nesta campanha) é transferido na hora, se o objetivo da campanha transfere: aos destinos de transferência cadastrados, na ordem da tela e até 2 tentativas, ou, sem destino cadastrado, a quem recebe leads e está livre.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

fromtextoobrigatório
Número de quem ligou, com + e o código do país.
totextoobrigatório
O telefone do Omni que recebeu.
durationSecondsinteiro
De 0 a 86.400.
providerCallIdtexto
Id da ligação no provedor, até 200 caracteres. O mesmo id de novo devolve a gravada.

Resposta

201
{ call, repeated, outOfHours, reason, handoff }. reason é sem_campanha, campanha_pausada, sem_agente ou null quando alguém atendeu. handoff é { tipo: "transferido", usuarioId, destinoId, entregaId, texto } quando a ligação foi transferida: destinoId é o destino cadastrado que aceitou e usuarioId a pessoa do time (o outro fica null); texto traz as falas da transferência gravadas, ou o texto padrão. Senão null.
200
A mesma ligação de novo, com repeated: true.
400
Campo inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl -X POST https://omni.aipecorp.com/api/entrada/ligacoes \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"from": "+551155500100", "to": "+551155500200", "durationSeconds": 42}'

Agenda e entregas

O que o Omni passou ao time: a transferência para quem estava livre, os horários oferecidos ao lead e o horário que ele marcou. Recebe quem tem telefone, está ativo e marcou «recebe leads» na Equipe.

Agenda do time

GET/api/appointments

Horários que cruzam o intervalo, do mais cedo ao mais tarde.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

fromdata e hora
Início, ISO com fuso. Padrão: agora.
todata e hora
Fim, ISO com fuso, depois do início e até 31 dias dele. Padrão: 7 dias depois do início.
userIduuid
Só a agenda desta pessoa.
statustexto
marcado (padrão), ofertado ou cancelado.

Resposta

200
{ appointments, from, to }. Cada horário: { id, status, startsAt, endsAt, option, handoffId, bookedAt, cancelledAt, createdAt, user, contact, campaign }
400
Filtro inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/appointments?from=2026-10-12T00:00:00Z&to=2026-10-19T00:00:00Z" \
  -H "Authorization: Bearer SUA_CHAVE"

Cancelar um horário

PATCH/api/appointments/{id}

Cancela um horário marcado; a entrega dele passa a cancelado. Cancelar de novo devolve o mesmo horário.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

statustextoobrigatório
Só cancelado.

Resposta

200
{ appointment }.
400
Corpo inválido, com field.
404
«Horário não encontrado.» Também para id que não é uuid.
409
O horário ainda é só oferta ao lead.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl -X PATCH https://omni.aipecorp.com/api/appointments/ID_DO_HORARIO \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status": "cancelado"}'

Entregas ao time

GET/api/handoffs

Da mais nova para a mais antiga, com o recado (summary), as respostas do lead e o horário marcado, se houver.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
contactIduuid
Só as entregas deste contato.
statustexto
transferido, ofertado, marcado, recusado, cancelado, sem_destino, atendido ou sem_resposta.

Resposta

200
{ handoffs, pagination }. Cada entrega: { id, status, reason, channel, summary, answers, callId, user, destination, contact, campaign, appointment, deliveredAt, createdAt, updatedAt, respondBy, attendedAt, attendedBy, expiredAt, resumedAt, resumeStatus }reason é qualificado, pediu_pessoa ou pediu_depois. destination é { id, name } quando a ligação foi para um destino de transferência, e aí user é null; destino apagado deixa id null e guarda o nome. respondBy é o prazo para alguém do time atender o repasse que ficou sem destino ou foi recusado; sem atendimento até lá, a entrega vira sem_resposta (expiredAt) e o agente retoma a conversa uma vez (resumeStatus: enviada, sem_canal ou falhou).
400
Filtro inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/handoffs?contactId=ID_DO_CONTATO" \
  -H "Authorization: Bearer SUA_CHAVE"

Marcar repasse como atendido

PATCH/api/handoffs/{id}

Diz que alguém do time atendeu o lead de um repasse sem_destino, recusado ou sem_resposta: o prazo sai, o agente não retoma mais a conversa e os avisos desse repasse ficam lidos. Marcar de novo devolve a mesma entrega.

Chave de API de escrita ou login de qualquer cargo.

Corpo em JSON

statustextoobrigatório
Só atendido.

Resposta

200
{ handoff }, com attendedAt e attendedBy (null quando veio por chave).
400
Corpo inválido, com field.
404
«Entrega não encontrada.» Também para id que não é uuid.
409
A entrega não espera ninguém do time (já foi transferida, marcada ou cancelada).
401
Chave ausente, inválida, revogada ou vencida.
curl
curl -X PATCH https://omni.aipecorp.com/api/handoffs/ID_DA_ENTREGA \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"status": "atendido"}'

Avisos ao dono

O que pede a atenção de alguém do time: repasse sem destino ou sem resposta no prazo, tentativa que falhou 3 vezes seguidas e lead que o motor não contata por um dos motivos de bloqueio. O mesmo caso não repete enquanto o aviso estiver aberto.

Avisos

GET/api/alerts

Do mais novo para o mais antigo, com quantos seguem sem leitura.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
statustexto
nao_lido ou lido. Sem ele, todos.

Resposta

200
{ alerts, unread, pagination }. Cada aviso: { id, kind, code, channel, detail, contact, campaign, handoffId, createdAt, readAt, readBy }kind é sem_resposta, sem_destino, falha ou bloqueio; code é o código do bloqueio (o mesmo reason de GET /api/history/not-contacted); detail, o erro do provedor na falha.
400
Filtro inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/alerts?status=nao_lido" \
  -H "Authorization: Bearer SUA_CHAVE"

Marcar aviso como lido

POST/api/alerts/{id}/read

Sem corpo. Aviso já lido fica como estava, com quem leu primeiro.

Chave de API de escrita ou login de qualquer cargo.

Resposta

200
{ alert }, com readAt e readBy (null quando veio por chave).
404
«Aviso não encontrado.» Também para id que não é uuid.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl -X POST https://omni.aipecorp.com/api/alerts/ID_DO_AVISO/read \
  -H "Authorization: Bearer SUA_CHAVE"

Reuniões

Reunião que o agente de IA marcou com o lead no calendário de quem fecha, pelo SMS ou pelo WhatsApp, quando a campanha tem a ferramenta book-meeting() ligada. Quem fecha recebe o convite por e-mail; o lead também, quando tem e-mail. Confirmar, cancelar e baixar o .ics ficam no painel, em Reuniões.

Reuniões

GET/api/meetings

Da mais à frente para a mais antiga.

Chave de API ou login de qualquer cargo.

Parâmetros na URL

pageinteiro
Página, a partir de 1. Padrão: 1.
limitinteiro
Itens por página, de 1 a 200. Padrão: 50.
statustexto
marcada, confirmada ou cancelada. Sem ele, todas.

Resposta

200
{ meetings, pagination }. Cada reunião: { id, status, startsAt, endsAt, leadTimezone, channel, provider, uid, sequence, contact, campaign, closer, createdAt, confirmedAt, canceledAt }contact é { id, name, phoneNumber }; closer, { id, name, email }; provider é simulado (gravada sem convite) ou ical.
400
Filtro inválido, com field.
401
Chave ausente, inválida, revogada ou vencida.
curl
curl "https://omni.aipecorp.com/api/meetings?status=marcada" \
  -H "Authorization: Bearer SUA_CHAVE"

Formulário do site

O formulário do seu site manda o lead direto para uma campanha, sem chave e sem programador. Quem tem cargo owner ou admin gera o endereço na página da campanha, em Formulário, e lá mesmo copia um HTML de exemplo. Trocar o endereço faz o antigo parar na hora. O endereço fica no HTML do seu site, à vista de quem abrir o código: por isso um envio nunca troca o que o contato já tem, e o nome e as variáveis passam por uma limpeza antes de chegar ao texto do SMS e do WhatsApp.

Enviar um lead

POST/api/formulario/{token}

Cria o contato pelo telefone, ou completa o que já existe, e põe na campanha. O corpo vem como formulário HTML (application/x-www-form-urlencoded) ou em JSON, até 16 KB e 50 campos. Se a chamada pede JSON, no Content-Type ou no Accept, a resposta é JSON; senão, é uma página curta de «Recebido». Contato que já existe só ganha o que falta: o nome, se ainda não tem; variável que ele não tem, menos o e-mail; e o consentimento, se ainda não tem. Número em não contatar não entra na campanha: se é novo, vira contato; se já existe, nada nele muda. A resposta não conta isso a quem enviou. Contato que já estava na campanha segue como estava.

Sem chave e sem login: basta o endereço, que fica à vista no HTML do site.

Campos, no form HTML ou em JSON

telefonetextoobrigatório
Também phone, phoneNumber, whatsapp ou celular. Com + e o código do país; sem o +, vale como número do Brasil com DDD.
nometexto
Também name. Até 60 caracteres, só letras (com acento), espaço, apóstrofo, hífen e ponto. Fora disso, o contato fica sem nome e o envio segue.
emailtexto
Também mail. Fica na variável email do contato que o envio cria; contato que já existe não ganha e-mail por aqui, nem se não tem.
consentimentotexto
Também consent. Marcado (on, true, sim ou 1), grava o consentimento de voz com fonte form e, de prova, a campanha, a hora, o IP e a origem declarada pelo navegador (Referer), que quem envia pode forjar. Contato que já tinha consentimento fica com o dele. O Omni só exige este consentimento para ligar a número dos EUA.
_iscatexto
Campo escondido contra robô. Preenchido, o envio é descartado e a resposta é a de sucesso. Outro campo que começa com _ é ignorado.
qualquer outrotexto
Vira variável do contato, com o nome do campo; letra com acento, espaço e sinal viram _. Quebra de linha vira espaço; valor vazio ou com cara de link (http, https, www. ou site.com) não grava. Variável que o contato já tem fica como estava. uf, estado e state são ignorados: a UF sai do DDD.

Resposta

200
JSON { "received": true } ou a página «Recebido».
400
Corpo vazio ou inválido, sem telefone, telefone inválido, campo grande demais ou campos demais. No JSON vem com field; a página HTML não repete o nome do campo.
404
«Formulário não encontrado.» Endereço errado ou trocado, mesmo no meio do envio.
413
Corpo acima de 16 KB.
415
Corpo que não vem como form HTML nem JSON.
429
Mais de 10 envios do mesmo IP em 10 minutos (todo envio conta, até o recusado), ou 100 envios no mesmo formulário em 10 minutos que gravaram, completaram ou inscreveram um contato (isca, envio inválido, número em não contatar e envio repetido sem nada novo não contam aqui). Também quando dois envios do mesmo IP chegam juntos. Retry-After diz quantos segundos esperar.
curl
curl -X POST https://omni.aipecorp.com/api/formulario/SEU_TOKEN \
  -H "Accept: application/json" \
  --data-urlencode "nome=Maria Souza" \
  --data-urlencode "telefone=+551155500100" \
  --data-urlencode "[email protected]"

Só com login

Estas rotas servem à própria tela do Omni e pedem login; com chave, respondem 403 «Esta rota não aceita chave de API.». Ligações e mensagens você lê pela chave em Histórico de ligações e mensagens.

Rotas que pedem login
RotaO que fazCargo
DELETE /api/contacts/{id}Apagar um contatoowner ou admin
DELETE /api/contacts/{id}/do-not-contactTirar da lista internaowner ou admin
POST /api/campaignsCriar campanhaowner ou admin
POST /api/campaigns/draft-promptMontar o prompt do agente pelo template, sem gravar: agentTemplate, goalType, agentStrategy, qualificationDepth e languageowner ou admin
PATCH /api/campaigns/{id}Editar campanha: com scheduleType ou aiSequenceConfig e sem schedule, a sequência AI-driven é refeitaowner ou admin
DELETE /api/campaigns/{id}Apagar campanhaowner ou admin
GET /api/campaigns/{id}/queueFila da campanha: ações previstas, por canalowner ou admin
POST /api/campaigns/{id}/rescheduleReagendar todos os contatos da campanhaowner ou admin
PUT /api/campaigns/{id}/phonesTrocar o pool de números da campanha: phones, cada um com phoneId, maxContacts e smsEnabledowner ou admin
GET /api/campaigns/{id}/toolsFerramentas do agente da campanha: ligada, configuração e se está completaowner ou admin
PUT /api/campaigns/{id}/toolsLigar, desligar ou configurar uma ferramenta: tool, enabled e config (senha nunca, só o nome da variável)owner ou admin
GET /api/campaigns/{id}/throttle-eventsPausas e retomadas do limite de conclusões, as 20 mais recentesqualquer cargo
GET /api/campaigns/{id}/triggersTriggers da campanha: id, name, description e url (https; null nos de antes da migração 052, que o agente não chama)qualquer cargo
POST /api/campaigns/{id}/triggersCriar trigger: name, description e url (https; sem url o agente não o chama)owner ou admin
DELETE /api/campaigns/{id}/triggers/{triggerId}Apagar triggerowner ou admin
GET /api/campaigns/{id}/workflowsAvisos da campanha: e-mail e webhook por mudança de statusqualquer cargo
PUT /api/campaigns/{id}/workflowsTrocar os avisos: emailNotifications, webhookEnabled, webhookUrl e webhookStatusesowner ou admin
GET /api/campaigns/{id}/talk-to-humanAviso por e-mail quando o lead pede uma pessoaqualquer cargo
PUT /api/campaigns/{id}/talk-to-humanTrocar o aviso: emailNotificationsowner ou admin
GET /api/campaigns/{id}/auto-endEncerramento automático por dias úteisqualquer cargo
PUT /api/campaigns/{id}/auto-endTrocar o encerramento automático: enabled, days, fromStatuses e toStatusowner ou admin
GET /api/callsLigaçõesqualquer cargo
GET /api/calls/{id}Uma ligaçãoqualquer cargo
GET /api/messagesMensagensqualquer cargo
GET /api/phonesTelefonesqualquer cargo
POST /api/phonesCadastrar telefoneowner ou admin
PATCH /api/phones/{id}Editar telefoneowner ou admin
DELETE /api/phones/{id}Apagar telefoneowner ou admin
GET /api/agentsAgentesqualquer cargo
POST /api/agentsCriar agenteowner ou admin
GET /api/agents/{id}Um agentequalquer cargo
PATCH /api/agents/{id}Editar agenteowner ou admin
DELETE /api/agents/{id}Apagar agenteowner ou admin
GET /api/providersProvedoresqualquer cargo
PUT /api/providers/{kind}Configurar provedor (chave ou variável)owner ou admin
DELETE /api/providers/{kind}Remover provedorowner ou admin
POST /api/providers/{kind}/testTestar provedorowner ou admin
GET /api/dnc-listsListas de não ligarqualquer cargo
POST /api/dnc-listsCarregar listaowner ou admin
DELETE /api/dnc-lists/{id}Apagar listaowner ou admin
GET /api/keysChaves de APIowner ou admin
POST /api/keysCriar chave, de leitura ou de escrita, com validade opcional em diasowner ou admin
DELETE /api/keys/{id}Revogar chaveowner ou admin
GET /api/help-requestsPedidos de ajuda da conta, com protocolo, estado e respostaqualquer cargo
POST /api/help-requestsAbrir pedido de ajuda (subject, message); devolve o protocolo; 429 no limitequalquer cargo
GET /api/splittersSplittersqualquer cargo
POST /api/splittersCriar splitter (Percentage, Time-weighted ou Adaptive)owner ou admin
GET /api/splitters/{id}Um splitterqualquer cargo
PATCH /api/splitters/{id}Editar splitterowner ou admin
DELETE /api/splitters/{id}Apagar splitterowner ou admin
GET /api/splitters/{id}/decisionsÚltimas decisões do splitterqualquer cargo
GET /api/throttleThrottle da conta (o webhook do Slack volta só como dica)qualquer cargo
PUT /api/throttleGravar o Throttle da conta e o aviso no Slackowner ou admin
GET /api/throttle/eventsPausas e retomadas da conta e das campanhasqualquer cargo