Envios via API

Atenção! Nunca deixe o seu apiToken público ou visível, sempre mantenha a lógica e implementação deste endpoint seguro em seu backend!

Visualização de exemplo:

Exemplo PHP:

$mensagem = 'Meu primeiro teste com a API do zapisp!';  
$telefone = '551199999999';  
$apiToken = 'seu-token-aqui';  
$instancia_id = 'id-da-instancia-que-sera-usada';  
$api = "https://zapisp.com.br/api/whatsapp/v2/{{instancia_id}}";

$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $api);  
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);  
curl_setopt($ch, CURLOPT_POST, 1);  
curl_setopt($ch, CURLOPT_POSTFIELDS, [  
    'apiToken' => $apiToken,  
    'telefone' => $telefone,  
    'mensagem' => $mensagem,  
    'instancia' => $instancia_id  
]);

$response = curl_exec($ch);  
curl_close($ch);  
print_r($response);

Entendendo os parâmetros:

apiToken

Identificador do provedor, pode ser solicitado com gerente de contas ou no menu Aplicativos > Z-API > Integrações

Instância

Se o provedor possui mais de uma instancia de whatsapp poderá escolher qual instancia fará o envio. O ID da instancia de whatsapp está disponível no menu Canais > Whatsapp conforme a imagem abaixo:




Ao utilizar o gateway para o envio de mensagens, é importante estar ciente das respostas possíveis que podem ser retornadas após o processo. Existem dois tipos principais de retornos que o sistema pode fornecer, “success” ou “errors”.

O retorno "success" é fornecido quando a campanha de mensagens é enviada com sucesso através do gateway. Isso significa que todas as mensagens programadas na campanha foram processadas e enviadas corretamente sem quaisquer problemas ou interrupções.

{"success":["Parâmetros recebidos com sucesso","Autenticação realizada com sucesso.","Instancia selecionada:[id da instância utilizada para o envio]","Cliente foi encontrado na base de dados.","Campanha [ID da campanha] adicionada na fila do gateway."]}

Enquanto o retorno "errors", é fornecido quando ocorre algum problema durante o processo de envio da campanha de mensagens através do gateway. Este erro pode ser causado por uma variedade de fatores, como problemas de conexão com a instância, erros no formato da campanha, confira os possíveis problemas que podem ocorrer durante o processo de envio:

{"errors":["O cliente está com o contrato bloqueado na base do Zapisp."]}

Erros relacionados a instância

Nenhuma instância disponível para essa empresa;
Instância não encontrada;
Não foi possível enviar a mensagem, pois não há nenhuma instância disponível;

Erros relacionados a contatos

O lead está arquivado;
O cliente está arquivado;
Lead não pode receber NPS;
O cliente está com o contrato bloqueado na base do Zapisp;

Erros relacionados a campanha

Campanha não foi encontrada: XXX;
A campanha: $campaignId não possui aplicativos selecionados;

É importante monitorar esses retornos para garantir que as campanhas sejam enviadas com sucesso e para identificar rapidamente quaisquer problemas que possam surgir durante o processo de envio. Isso permitirá que você corrija qualquer problema rapidamente e minimize o impacto que quaisquer erros podem ter na eficácia da entrega da campanha ou pesquisa para o seu cliente.

Atualizado em: 26/11/2024