Pular para o conteúdo

Introdução à API do Vizus Chat

Como autenticar com o api_access_token, qual a URL base e como encontrar o ID da conta para fazer a primeira chamada.

Tempo
~10 min
Quem faz
Desenvolvedor
Telas conferidas em
out/2026

A API do Vizus Chat permite ler e criar conversas, mensagens, contatos e outros recursos a partir dos seus sistemas. O Vizus Chat é construído sobre o Chatwoot, então a API segue o mesmo formato da API de aplicação do Chatwoot.

A referência completa dos endpoints será publicada em breve nesta Central. Enquanto isso, fale com a Vizus se precisar de um endpoint específico.

  • A conta precisa estar no plano Profissional ou Escala. O plano Essencial não inclui API nem webhooks. Veja os planos no site.
  • Um usuário no Vizus Chat com acesso à conta que você quer integrar.
  • Uma ferramenta para fazer requisições HTTP (curl, Postman, Insomnia ou o próprio “Testar” da Referência da API).
  1. Pegue seu token de acesso. No Vizus Chat, clique na sua foto no rodapé da barra lateral, abra Configurações do Perfil e copie o campo Token de acesso. É o token do seu próprio usuário no Vizus Chat: ele age em seu nome, com as mesmas permissões.
  2. Descubra o ID da conta. Com o Vizus Chat aberto no navegador, o número depois de /accounts/ na barra de endereço é o account_id. Exemplo: em https://app.vizus.chat/app/accounts/12/dashboard, o account_id é 12.
  3. Faça a primeira chamada. Envie o token no cabeçalho api_access_token:
Janela do terminal
curl https://app.vizus.chat/api/v1/accounts/12/conversations \
-H "api_access_token: SEU_TOKEN"
Item Valor
URL base https://app.vizus.chat
Prefixo dos endpoints da conta /api/v1/accounts/{account_id}/
Autenticação cabeçalho api_access_token: SEU_TOKEN
Formato JSON (Content-Type: application/json)
  • Resposta 401. O token está ausente, errado ou foi trocado. Confira o cabeçalho api_access_token.
  • Resposta 402. O plano da conta não inclui API. A integração por token e a criação de webhooks exigem o plano Profissional ou Escala.
  • Resposta 404 numa conta que existe. Confira o account_id e se o seu usuário tem acesso a essa conta.
  • Resposta 429. Você passou do limite de requisições por minuto. Espere alguns segundos e tente de novo; em importações grandes, espace as chamadas em vez de disparar tudo de uma vez.