Pular para o conteúdo principal

API Reference

Bem-vindo à referência da API da Z-API! Aqui você encontrará todos os endpoints disponíveis para interagir com o WhatsApp através da nossa plataforma.

Base URL

Todas as requisições devem ser feitas para a seguinte URL base:
https://api.z-api.io/instances/{instanceId}/token/{token}
ParâmetroDescrição
instanceIdID da sua instância, obtido no painel da Z-API
tokenToken da sua instância, obtido no painel da Z-API

Autenticação

Além do ID e Token na URL, todas as requisições precisam do header de segurança:
HeaderDescrição
Client-TokenToken de segurança da conta. Saiba mais

Formato das requisições

  • Todas as requisições devem incluir o header Content-Type: application/json
  • Os corpos das requisições e respostas são em formato JSON

Códigos de resposta comuns

CódigoDescrição
200Requisição realizada com sucesso
400Requisição inválida. Verifique os dados enviados
405Método HTTP incorreto
415Header Content-Type não informado