Tema

Como usar a API ​

A API do WayChat liga seus sistemas (n8n, WHMCS, site, ERP) ao atendimento: envia WhatsApp, lê conversas e contatos e avisa a sua URL quando algo acontece.

1. Crie uma chave ​

Em Configurações → API → Nova chave:

  1. Dê um nome (ex.: "n8n").
  2. Marque só o que o sistema precisa.
  3. Copie a chave. Ela começa com wc_ e aparece uma vez só.
PermissãoO que libera
mensagens:enviarMandar WhatsApp para um número
conversas:lerListar conversas, mensagens, setores e canais
conversas:responderEscrever numa conversa que já existe
contatos:lerBuscar e listar contatos
contatos:escreverCriar e editar contatos
metricas:lerNúmeros das telas Ao vivo e Desempenho

2. Chame a API ​

https://api-waychat.waycloud.com.br/v1

Endereço antigo

Antes a API ficava no domínio do painel (https://<seu-painel>/api/v1). Integrações antigas continuam funcionando no endereço novo com o caminho antigo: https://api-waychat.waycloud.com.br/api/v1/... é o mesmo que /v1/.... Prefira /v1.

Mande a chave no cabeçalho Authorization:

bash
curl https://api-waychat.waycloud.com.br/v1/status \
  -H 'Authorization: Bearer wc_SUA_CHAVE'
json
{ "ok": true, "empresa": "Way Cloud", "escopos": ["mensagens:enviar", "conversas:ler"] }

Guarde a chave como uma senha

Use só no servidor, nunca no navegador ou em código público. Se vazar, revogue em Configurações → API e crie outra: a antiga para na hora.

Regras gerais ​

  • JSON no corpo e na resposta.
  • Datas em ISO 8601 (UTC).
  • Erros: { "statusCode": 400, "message": "texto em português" }.
  • 401: chave inválida ou revogada. 403: falta a permissão. 429: mais de 120 chamadas por minuto na mesma chave.
  • Telefone: DDD + número (44999998888) ou com 55 (5544999998888). O WayChat acha o contato com ou sem o 9º dígito.
  • Listas vêm em { "itens": [...], "proximo": { "antes_id": 123 } }. Para a próxima página, repita a chamada com antes_id.

Próximos passos ​