API de Aquecimento

Listar números

Todos os números com a situação, os modos ligados, o progresso do aquecimento (dia, mensagens enviadas, meta, dias restantes, mensagens de hoje), a restrição do WhatsApp (restricao_ate), o proxy e onde mais o número está em uso, mais o resumo da conta. ?precisa_de_voce=true traz só os que pedem ação: desconectado, nunca conectado ou plano vencido.

Cadastrar um número

Cria o número, ainda sem conexão, dentro do limite de números do plano. O nome tem de 3 a 50 caracteres e não pode repetir outro número da conta. Exige o cabeçalho Idempotency-Key: a mesma chave devolve o mesmo número (repetido: true). Depois, conecte com /numeros/{id}/conectar.

Aceita simular; criar exige Idempotency-Key.

{ "nome": "Vendas" }

Um número

O número no mesmo formato da lista (num_...).

Renomear

Muda o nome (de 3 a 50 caracteres, sem repetir outro número da conta).

{ "nome": "Vendas Sul" }

Apagar

Apaga o número e a conexão dele: a sessão do WhatsApp sai junto e não há como desfazer. Número em campanha ou automação de Disparos é recusado (409 numero_em_uso): tire o número de lá antes.

Conectar

metodo qr (padrão) ou codigo, com o telefone do número com DDD (o código é digitado em WhatsApp › Aparelhos conectados › Conectar com número de telefone). O código não volta aqui: consulte /numeros/{id}/codigo. Pedir de novo enquanto conecta reinicia a tentativa. Número já conectado é recusado (409 ja_conectado): desconecte antes para trocar a sessão.

{ "metodo": "codigo", "telefone": "5511999998888" }

Código de conexão

O código atual: qr_code (imagem PNG em data URL) ou codigo_pareamento, e a situacao (conectando, conectado ou desconectado). Consulte a cada 5 segundos até conectado: true; consultar não reinicia a tentativa.

Desconectar

A sessão do WhatsApp sai, o aquecimento para e as conversas da rede ficam pausadas até conectar de novo. A campanha de Disparos que usava o número passa os envios dele para os outros números. Número já desconectado não muda nada (mudou: false).

Ligar e desligar modos

Só os modos enviados mudam; desligar vem antes de ligar. Ligar confere o plano, o limite de números aquecendo, a conexão, dois números conectados para o Privado e arquivos de Status para o Status, e recusa número em campanha ou automação de Disparos (409 numero_em_uso). Repetir o pedido não muda nada (mudou: false). Se um modo for recusado, os anteriores do mesmo pedido já valeram: o erro traz detalhes.aplicadas.

{ "comunitario": true, "grupos": true, "status": true }

Progresso

Dia do aquecimento, mensagens enviadas, meta, se concluiu e quantos dias faltam, mais ou menos.

Configurações

O horário do aquecimento (Brasília), se os números salvam os contatos da rede, o limite de números aquecendo do plano e o proxy da conta.

Mudar configurações

Muda só o que vier: horario (inicio e fim, HH:MM, início antes do fim), salvar_contatos e proxy da conta (modo conta, um local para todos os números, ou numero, cada número com o seu, e o local em pais, estado e cidade). Um pedido com erro não grava nada.

{ "horario": { "inicio": "08:00", "fim": "21:00" }, "proxy": { "modo": "conta", "estado": "sp", "cidade": "campinas" } }

Cidades disponíveis

?estado=sp lista as cidades do estado; ?busca=campinas procura pelo nome. Cada cidade tem o valor, que vai no campo cidade, e o nome.

Proxy de um número

O local do número, o da conta e o que vale agora (vigente, com a origem: numero ou conta).

Mudar o proxy de um número

Grava o local do número (estado e cidade; cidade: null limpa). A cidade é conferida no catálogo. vale_na_proxima_conexao: true quando o número já está conectado.

{ "estado": "sp", "cidade": "campinas" }

Listar

Os webhooks da conta com o resumo das últimas 24 horas. O segredo nunca volta aqui.

Criar

url https pública, eventos e descricao opcional. A resposta é a única vez em que o segredo aparece. Até 5 por conta, e o dono é avisado no painel.

{ "url": "https://seu-sistema.com/protectzap", "eventos": ["aquecimento.numero.desconectado", "aquecimento.numero.concluido"] }

Um webhook

Endereço, avisos pedidos, situação e as falhas recentes (whk_...).

Mudar

Muda url, eventos, descricao ou ativo. Religar entrega o que ficou na fila.

Apagar

Apaga o webhook e o histórico de entregas dele.

Entregas

Os últimos avisos (até 200, 30 dias de histórico) com a situação e a resposta de cada um.

Testar

Manda um webhook.teste agora e devolve o que o endereço respondeu.

Trocar o segredo

Gera um segredo novo; o antigo deixa de valer na hora. A resposta é a única vez em que ele aparece.

Reenviar um aviso

Manda de novo um aviso (whe_...) com o mesmo id, para o seu sistema descartar se já recebeu.

Catálogo

Os avisos do Aquecimento que um webhook pode pedir.

Os números da conta com a situação (aquecendo, completo, desconectado, em campanha...), os modos ligados, o dia e as mensagens do aquecimento, a restrição do WhatsApp e onde mais o número está em uso, com o resumo da conta. Use os ids num_ daqui nas outras ferramentas.

Parâmetros: precisa_de_voce

Dia do aquecimento, mensagens enviadas, meta e quantos dias faltam, de um número.

Parâmetros: numero

O que pede o usuário no Aquecimento: números desconectados ou nunca conectados, plano vencido, números com restrição do WhatsApp, aquecimento pausado (e por quê) e o uso do limite de números aquecendo.

Confere, com as regras da tela (plano, limite de números aquecendo, conexão, Privado com dois números, Status com arquivos, número em campanha ou automação), ligar e desligar modos de um número. Nada muda: devolve um codigo_confirmacao (15 min) e só confirmar aplica.

Parâmetros: numero, modos

Mostra o efeito de desconectar um número (a sessão do WhatsApp sai, o aquecimento e os matchings param, e voltar exige ler o QR Code no celular). Nada muda: devolve um codigo_confirmacao (15 min) e só confirmar desconecta.

Parâmetros: numero