Com a API da Voxuy, você consegue criar funis personalizados e tem total controle de quando e como sua Voxuy irá trabalhar. As possibilidades com a nova API da Voxuy vão tão longe quanto a sua imaginação. Você pode, por exemplo, ter um formulário com Nome e Número no seu site, e, assim que o usuário preencher os dados, você usa nossa API para entrar em contato com esse lead automaticamente. Este é somente um de vários exemplos que a API da Voxuy torna possível.

Nesta página você verá um passo a passo de como utilizar nossa API, em detalhes.

Lembrando que a API Voxuy somente está disponível para assinantes do plano Diamond.

1 – Escolha seu produto

O primeiro passo é escolher o produto que será usado. Caso seu produto seja de alguma plataforma que integramos, basta você fazer a integração e selecionar seu Produto na tela de Funil de Conversão.


Caso o produto que você deseja utilizar vem de uma plataforma que ainda não temos integração, você pode adicionar seu produto no menu “Produtos” ao lado. Após acessar a tela de Produtos, clique na aba “API / Personalizados" e depois em "Adicionar Produto" e dê um nome ao Produto.



Após isso, vá à tela de Funil de Conversão e selecione esse novo produto da lista como mostrado na primeira imagem.

2 – Selecione o evento desejado

Após selecionar seu produto na tela Funil de Conversão, você verá a lista de eventos disponíveis. Caso você esteja usando um produto que acabou de ser adicionado em “Produtos” – “API / Personalizados” e queira usar a API para eventos que já estão na lista de eventos padrões do sistema, como por exemplo, Boleto Gerado, você pode simplesmente selecionar o evento desejado para criar seu fluxo:



Caso você selecione um produto que veio da integração da Voxuy com a sua plataforma ou queira usar um evento que não esteja listado na aba Padrão, você precisará criar um novo evento na aba Personalizado.

Para isso, clique na aba Personalizado, e crie sua primeira Categoria. Uma categoria é simplesmente um método de agrupar logicamente seus eventos para fins de organização. Digite o nome de sua nova categoria no campo “Criar nova categoria” e aperte Enter quando terminar. Ao criar a nova categoria, um novo evento também será criado. Altere este nome para o que você deseja.

3 – Crie seu fluxo de mensagens

Agora basta você criar as mensagens desse fluxo que acabou de criar. Caso precise de ajuda em configurar as mensagens, veja a seção de Funil de conversão.

4 – Criar um token para a API

Para uso da API, você precisará gerar um token. Para isso, Vá em Configurações Gerais e selecione API Voxuy.

Caso o campo Token API esteja vazio, clique no botão Gerar Novo Token.

Clique em Copiar e guarde essa informação, pois será necessária ao chamar a API daqui a pouco.

Próximos Passos

Agora você está pronto para recolher os dados necessários para chamar nossa API e agendar suas mensagens para o evento criado. Veja o próximo passo em Dados necessários para a API

Actualizado em: 14/07/2022