Início Outros Canais Como criar uma caixa de entrada com a API

Como criar uma caixa de entrada com a API

Última atualização em Apr 15, 2025

Na Akece, você pode configurar um canal de atendimento utilizando API, o que permite integrar um sistema personalizado de mensagens diretamente com a plataforma. Esse tipo de canal é ideal para quando você deseja utilizar uma interface própria de atendimento ao cliente ou integrar a Akece com outro sistema.

Como configurar o canal via API

1. Criar o canal

  1. Acesse o painel da Akece e vá em Configurações → Canais (Inboxes).

  2. Clique em Adicionar canal.

  3. Selecione a opção API.

  4. Preencha um nome para o canal e insira a URL de callback (endereço para onde a Akece enviará notificações quando uma nova mensagem for criada).

  5. Adicione os atendentes que deverão ter acesso ao canal.

O canal estará pronto para uso.


Como enviar mensagens para o canal via API

O fluxo de envio de mensagens por API envolve três etapas principais:

1. Criar o contato

Utilize a API de criação de contato e envie o inbox_id do canal via API junto com os dados do contato. Isso criará automaticamente uma sessão para o contato.

No retorno da requisição, localize o campo source_id dentro de contact_inboxes. Esse source_id identifica a sessão e será usado na próxima etapa.

2. Criar uma conversa

Utilize o source_id para iniciar uma nova conversa. Você receberá o conversation_id, que servirá para enviar mensagens.

3. Enviar uma mensagem

Com o conversation_id, você pode usar a API para criar mensagens. As mensagens podem ser do tipo:

  • incoming (mensagem enviada pelo contato)

  • outgoing (mensagem enviada pelo atendente)


Como receber mensagens no callback

Ao receber uma nova mensagem nesse canal, a Akece fará um POST na URL de callback informada na criação do canal. O payload enviado segue o formato padrão de webhooks, com campos como event, message_type, conversation, sender, entre outros.


Como usar as APIs de cliente

A Akece oferece APIs específicas para que você construa sua própria interface de atendimento ao cliente:

Exemplos de uso:

  • Criar uma interface de chat personalizada no seu site.

  • Integrar o atendimento a um aplicativo móvel.

  • Conectar a Akece com plataformas que não possuem SDK oficial.

Você pode usar os identificadores inbox_identifier e customer_identifier para realizar operações como:

  • Criar, consultar ou atualizar contatos

  • Criar e listar conversas

  • Criar, listar e atualizar mensagens

Consulte a documentação de APIs para cliente para detalhes.


Como autenticar com HMAC

A autenticação via HMAC garante a segurança das comunicações no canal API. Para gerar o HMAC, você precisará do hmac_token do canal, que pode ser obtido com seu time técnico no painel da Akece.

Utilize-o para gerar a assinatura identifier_hash e incluí-la junto ao identificador do cliente (identifier) nas chamadas de autenticação.


WebSockets e atualizações em tempo real

Para receber atualizações em tempo real no seu front-end, conecte-se ao WebSocket da Akece:

wss://dash.akece.com/cable

Utilize o pubsub_token retornado na criação do cliente para autenticar a conexão e escutar os eventos.


Se tiver dúvidas ou precisar de ajuda para configurar seu canal via API, fale com o nosso suporte: 📩 [email protected] | 📱 @akece.ai