Referência da API v1

Documentação da API Amplific.AI

Integre atendimento omnichannel, bases de conhecimento e agentes de IA diretamente nos seus sistemas. Todos os endpoints retornam JSON e utilizam autenticação por chave de API.

Autenticação segura

Header API-KEY por empresa.

Conversas em tempo real

Envie mensagens, mídia e gerencie filas via API.

IA & conhecimento

CRUD de bases, tópicos e embeddings.

Autenticação

Todas as requisições devem incluir o header API-KEY com a chave da sua instância Amplific.AI. Você encontra essa chave em Configurações → Controle → Desenvolvedores no painel do Amplific.AI.

Exemplo de header

API-KEY: sua_chave_aqui
Content-Type: application/json

Importante: nunca exponha sua API Key em código frontend ou repositórios públicos. Faça as chamadas sempre a partir do seu backend.

Formato das requisições

A maioria dos endpoints usa POST com corpo JSON.
Parâmetros comuns: idEmpresa e idUser.
Respostas em JSON com charset UTF-8.

Auth

POST /endpoints/auth/login

Login de usuário

Autentica com email e senha e retorna dados da sessão, permissões e módulos da empresa.

Body (JSON)

{
  "email": "[email protected]",
  "password": "sua_senha"
}

Exemplo de chamada

Resposta de sucesso

{
  "logado": {
    "IsloggedIn": "true",
    "idUser": 123,
    "idEmpresa": 45,
    "UserEmail": "[email protected]",
    "UserNameL": "Nome",
    "url_aplicacao": "https://amplific.ai/"
  }
}

Conversas

Gerencie atendimentos, envie mensagens e controle filas de chat.

POST /endpoints/conversas/loadconversas

Listar conversas

Retorna atendimentos da empresa filtrados por status, fila e limite. Use para montar a fila de chat no seu sistema.

Campo	Tipo	Descrição
idEmpresa	number	ID da empresa
idUser	number	ID do usuário logado
status	string	Status do atendimento ou `Todos`
fila	number	ID da fila (opcional, padrão 0)
limit	number	Limite de resultados (padrão 300)

Exemplo de chamada

POST /endpoints/conversas/loadmensagens

Carregar mensagens

Retorna o histórico completo de mensagens de um atendimento, incluindo texto, mídia e metadados de envio.

Parâmetros: idEmpresa, idUser, idAtendimento

Exemplo de chamada

POST /endpoints/conversas/loadfilas

Listar filas

Retorna as filas de atendimento configuradas na empresa para roteamento e distribuição de conversas.

Exemplo de chamada

POST /endpoints/conversas/enviar/mensagem

Enviar mensagem Amplific.AI

Envia texto ao cliente pela instância Amplific.AI, registra no histórico e cria ou continua o atendimento em aberto.

Campo	Obrigatório	Descrição
IdNum	Sim	Número do destinatário
mensagem	Sim	Texto da mensagem
canal	Não	Canal de envio (ex: `Amplific.AI`)
idEmpresaW	Sim	ID da instância Amplific.AI
idEmpresaC	Sim	ID do contato na empresa
NovoAtendimento	Não	`Sim` para forçar novo atendimento
assinaturatexto	Não	Assinatura personalizada do agente

Exemplo de chamada

POST /endpoints/conversas/enviar/mensagem Mensagem privada

Mensagem privada no atendimento

Registra uma nota interna no atendimento aberto, visível apenas para agentes — não é enviada ao cliente via Amplific.AI.

Use o mesmo endpoint de enviar mensagem com chat igual a Privado.

Campo	Obrigatório	Descrição
idEmpresa	Sim	ID da empresa
idUser	Sim	ID do usuário que registra a mensagem
IdNum	Sim	Número do contato com atendimento aberto
mensagem	Sim	Texto da nota privada (ex: resumo gerado por IA)
idEmpresaW	Sim	ID da instância Amplific.AI do atendimento
chat	Sim	Deve ser `Privado`
idEmpresaC	Não	ID do contato na empresa. Pode ser `0` se não houver cadastro

Body (JSON)

{
  "idEmpresa": "135",
  "idUser": "801",
  "IdNum": "5511999999999",
  "mensagem": "Resumo do atendimento gerado pela IA.",
  "idEmpresaC": "0",
  "idEmpresaW": "395",
  "chat": "Privado"
}

Resposta de sucesso

{ "success": true }

Requer um atendimento aberto para o número e instância informados. Se não existir, retorna success: false com a mensagem Nenhum atendimento aberto encontrado para este número.

Exemplo de chamada

POST /endpoints/conversas/enviar/media

Envia arquivos de mídia (imagem, documento, vídeo) via Amplific.AI. Utiliza multipart/form-data.

Exemplo de chamada

POST /endpoints/conversas/enviar/audio

Enviar áudio

Envia mensagem de voz (arquivo de áudio) ao contato no atendimento ativo. Requisição em multipart/form-data.

Campos: file, IdNum, idEmpresa, idUser, idAtendimento, idEmpresaW

Exemplo de chamada

POST /endpoints/conversas/enviar/cloud/iniciar

Iniciar conversa com template Cloud

Cria um novo atendimento e envia um template aprovado da Amplific.AI Cloud API. O template deve estar cadastrado com tipo Amplific.AI Cloud Template.

Campo	Obrigatório	Descrição
idEmpresa	Sim	ID da empresa
idUser	Não	ID do usuário que inicia o atendimento
numero	Sim	Telefone do destinatário (apenas dígitos). Aceita também `IdNum`
id_empresas_Amplific.AI	Sim	ID da instância Amplific.AI Cloud. Aceita também `idEmpresaW`
template_iniciar_cloud	Sim	Nome do template Cloud cadastrado (ex: `acesso_area_sparkfy`). Aceita também `template`
mensagem	Não	Texto exibido no histórico. Se omitido, usa o corpo do template. Aceita também `mensagem_texto_nova_api`
templateParameters	Não	Array com variáveis do template (`{{1}}`, `{{2}}`…). Aceita também `variaveis`
fila	Não	ID da fila de atendimento (padrão: 0)

Body (JSON)

{
  "idEmpresa": "143",
  "idUser": "841",
  "numero": "5511999999999",
  "id_empresas_Amplific.AI": "414",
  "template_iniciar_cloud": "acesso_area_sparkfy",
  "mensagem": "Olá! Seu acesso está pronto."
}

Resposta de sucesso

{
  "success": true,
  "protocolo": "PRO20250623ABCD1234",
  "id_atendimento": 1001,
  "fila": 0,
  "response": { ... }
}

Exemplo de chamada

Ações de atendimento

Assumir atendimento

POST /endpoints/conversas/acoes/assumir

Atribui um atendimento aberto ao usuário informado, equivalente ao botão Assumir no painel omnichannel.

idAtendimento, idEmpresa, idUser

Exemplo de chamada

Marcar como lida

POST /endpoints/conversas/acoes/lida

Marca todas as mensagens não lidas do atendimento como lidas para o usuário logado.

Exemplo de chamada

Finalizar atendimento

POST /endpoints/conversas/acoes/finalizar

Encerra o atendimento com status Resolvidos e registra a data de fechamento.

idAtendimento, idEmpresa, idUser

Exemplo de chamada

Filas & transcrição

Transferir atendimento

POST /endpoints/conversas/filas/transferir

Move o atendimento para outra fila e/ou outro agente, mantendo o histórico da conversa.

idFilaTransfer, idUserTransfer, idAtendimento

Exemplo de chamada

Usuários da fila

POST /endpoints/conversas/filas/usuarios

Lista agentes online e disponíveis em uma fila específica, útil antes de transferir um atendimento.

Exemplo de chamada

Copiar transcrição

POST /endpoints/conversas/transcricao/copiar

Retorna o texto transcrito dos áudios recebidos no atendimento, para uso em resumos ou integrações.

Exemplo de chamada

Todos os endpoints acima estão sob o prefixo /endpoints/conversas/.

Base de conhecimento

Gerencie conteúdos, categorias, tópicos e bases da IA.

POST /endpoints/conhecimento/listar

Listar conhecimentos

Retorna itens da base de conhecimento da empresa com paginação, para alimentar buscas e respostas da IA.

Body (JSON)

{
  "idEmpresa": 45,
  "pagina": 1,
  "limite": 10
}

Exemplo de chamada

Ver conhecimento

POST /endpoints/conhecimento/ver

Retorna o conteúdo completo de um item da base pelo ID.

Exemplo de chamada

Adicionar conhecimento

POST /endpoints/conhecimento/adicionar

Cria um novo conteúdo vinculado a uma base, categoria e tópico. Requer idBase, idCategoria, idTopico e conteudo.

Exemplo de chamada

Editar conhecimento

POST /endpoints/conhecimento/editar

Atualiza o conteúdo de um item existente na base de conhecimento.

Exemplo de chamada

Excluir conhecimento

POST /endpoints/conhecimento/deletar

Remove permanentemente um item da base de conhecimento pelo ID.

Exemplo de chamada

Sub-recursos

Cada sub-recurso possui endpoints listar, adicionar, editar e deletar:

/endpoints/conhecimento/base/ /endpoints/conhecimento/categoria/ /endpoints/conhecimento/topico/

Listar bases de conhecimento

Retorna as bases cadastradas na empresa. O mesmo padrão se aplica a categoria e topico, com as operações listar, adicionar, editar e deletar.

Exemplo de chamada

Substitua base por categoria ou topico, e listar por adicionar, editar ou deletar conforme a operação.

Agentes de IA

POST /endpoints/agentes/listar

Listar agentes de IA

Retorna todos os agentes de IA configurados na empresa, com ID e nome de cada um.

Exemplo de chamada

Resposta de sucesso

{
  "agentes": [
    { "id": 1, "nome": "Agente Vendas" },
    { "id": 2, "nome": "Agente Suporte" }
  ]
}

IA / Embeddings

POST /endpoints/ia/v1/embeddings/create

Criar embedding

Gera um vetor de embedding para um texto, usando o motor de IA configurado na empresa. Útil para busca semântica e RAG.

Campo	Obrigatório	Descrição
idEmpresa	Sim	ID numérico da empresa
texto	Sim	Texto para gerar o embedding

Body (JSON)

{
  "idEmpresa": 45,
  "texto": "Como funciona o plano Pro?"
}

Exemplo de chamada

Códigos de erro

HTTP	Mensagem típica	Causa
401	Token não autorizado / Acesso negado	API-KEY inválida ou ausente
400	Parâmetro obrigatório ausente	Body JSON incompleto ou inválido
405	Método não permitido	Verbo HTTP incorreto (use POST)
500	Erro interno	Falha no servidor ou banco de dados

Documentação da API Amplific.AI

Autenticação segura

Conversas em tempo real

IA & conhecimento

Autenticação

Formato das requisições

Auth

Login de usuário

Conversas

Listar conversas

Carregar mensagens

Listar filas

Enviar mensagem Amplific.AI

Mensagem privada no atendimento

Enviar áudio

Iniciar conversa com template Cloud

Ações de atendimento

Assumir atendimento

Marcar como lida

Finalizar atendimento

Filas & transcrição

Transferir atendimento

Usuários da fila

Copiar transcrição

Base de conhecimento

Listar conhecimentos

Ver conhecimento

Adicionar conhecimento

Editar conhecimento

Excluir conhecimento

Sub-recursos

Listar bases de conhecimento

Agentes de IA

Listar agentes de IA

IA / Embeddings

Criar embedding

Códigos de erro

Precisa de ajuda com a integração?