Introdução

O que a API da Vozko permite fazer, por onde começar e onde pedir ajuda.

A API da Vozko dá ao seu sistema acesso aos mesmos recursos que a equipe usa no aplicativo: conversas e mensagens, leads e CRM, campanhas de WhatsApp e de e-mail, canais como Instagram, Facebook, Telegram, TikTok, Mercado Livre e WebChat, telefonia, agentes de IA, fluxos, relatórios e a configuração do workspace.

É uma API REST: as requisições e as respostas usam JSON sobre HTTPS, e cada chamada se identifica com o token de login de um usuário, enviado no cabeçalho Authorization. O workspace da chamada é escolhido pelo cabeçalho X-Workspace-ID.

A Referência da API lista todas as rotas, com os parâmetros, os corpos, as respostas e os códigos de erro de cada uma. Você pode testar as chamadas ali mesmo, no navegador.

Por onde começar

Duas formas de autenticar

CredencialPara que serve
Token de loginVale para toda a API. É obtido com POST /auth/login e age em nome do usuário, com as permissões que ele tem no workspace.
Chave de API do workspace (wsk_)Vale hoje apenas para a API de e-mail transacional. Age em nome do workspace, não de uma pessoa.

Os detalhes estão em Autenticação.

Convenções

AssuntoRegra
FormatoRequisições e respostas em JSON, em UTF-8. Envie Content-Type: application/json nas requisições com corpo.
ContextoX-Workspace-ID escolhe o workspace e X-Department-ID restringe a um departamento. Veja Workspaces e departamentos.
ErrosAs recusas trazem um status HTTP e um corpo JSON com error, message e, na maioria das rotas, um code estável. Veja Erros.
ListasA maioria das listas é paginada por page e pageSize. Veja Paginação.
LimitesHá um limite de requisições por minuto. Veja Limites de requisição.

Ajuda

  • Dúvidas sobre uma rota: a descrição de cada rota na Referência da API explica o que ela faz, os cabeçalhos que exige e os erros que devolve.
  • Suporte: abra uma solicitação no aplicativo, em Menu lateral › Suporte.

Did this page help you?