1. Como disparar mensagem
Tipo da requisição:
POST
URL: https://zapisp.com.br/api/whatsapp/v2/list/{##...INSTANCIA_ID....##}?token=API_TOKEN
Content-Type: 'application/json'
INSTANCIA_ID | Número da instância por onde deseja enviar as mensagens. OBS: Caso a instância não for informada recupera a primeira instância válida para disparo |
token | Token api do cliente. |
body | { "telefones": [ "5581900000000", ... ], "mensagem": [ "@campanha@*********", "@nps@", "texto adicional", ... ] }
|
2. Como disparar textos avulsos
Para mensagens de texto comuns, você pode mandar, na lista de mensagem o texto que deseja enviar;
{ "telefones": [ "5581900000000", ... ], "mensagem": [ "essa mensagem é só de teste" ] }
Resposta:
[ { "success": [ "Parâmetros recebidos com sucesso", "Autenticação realizada com sucesso.", "Instância não informada, usando a instancia: 401" ] }, { "errors": [] }, { "clients": { "5581900000000": { "success": [ "Cliente foi encontrado na base de dados.", "Mensagem enviada com sucesso: 'essa mensagem é só de teste'" ] } } } ]
No WhatsApp:
3. Como disparar pesquisa de NPS
Para envio de nps utilize o "coringa" @nps@:
{ "telefones": [ "5581900000000", ... ], "mensagem": [ "@nps@", ] }
Resposta:
[ { "success": [ "Parâmetros recebidos com sucesso", "Autenticação realizada com sucesso.", "Instância não informada, usando a instancia: 401" ] }, { "errors": [] }, { "clients": { "5581900000000": { "success": [ "Cliente foi encontrado na base de dados.", "NPS enviado. Email: Cliente não possui e-mail cadastrado" ] } } } ]
Seguindo a mesma lógica, mas, agora você vai, antes pegar o código do coringa da campanha na plataforma.
Veja:
Na listagem de campanhas clique em:
E, agora, no campo de mensagem use o coringa da campanha para que todos os itens da campanha sejam enviados pelo seu ERP:
Veja o exemplo:
Agora que o coringa está copiado, use-o na listagem de mensagem:
{ "telefones": [ "5581900000000", ... ], "mensagem": [ "@camapanha@xxxxxxxxx" ] }
Resposta:
[ { "success": [ "Parâmetros recebidos com sucesso", "Autenticação realizada com sucesso.", "Instância não informada, usando a instancia: 401" ] }, { "errors": [] }, { "clients": { "5581900000000": { "success": [ "Cliente foi encontrado na base de dados.", "Campanha enviada: @camapanha@xxxxxxxxx" ] } } } ]
A campanha:
No Whatsapp:
5. Limites e tratamentos
Limite de envio para 50 números
Limite de envio de 20 mensagens
Tratamento de números e mensagens repetidas
Tratamento de números inválidos
Exemplo de mensagem:
{ "telefones": [ "849000000000", "123abc456789", "45!67890@12", "5555999999999", ... "98765432 10", "+1 23 456 7890", "1#23*45_67890", "abcdefghij" ], "mensagem": [ "@campanha@aaa", "@campanha@1386005154", ... "texto adicional", "texto 2", "mensagem extra" ] }
Resposta:
[ { "success": [ "Parâmetros recebidos com sucesso", "Autenticação realizada com sucesso.", "Instância não informada, usando a instancia: 401" ] }, { "errors": [], "phone_limits": [ "98765432 10", "+1 23 456 7890", "1#23*45_67890", "abcdefghij" ], "campaign_limits": [ "texto adicional", "texto 2", "mensagem extra" ] }, { "clients": { "5584900000000": { "success": [ "Cliente foi encontrado na base de dados." ], "error": [ "Campanha não foi encontrada: @campanha@aaa" ] }, "123abc456789": { "error": [ "O número de telefone fornecido não é válido." ] }, "45!67890@12": { "error": [ "O número de telefone fornecido não é válido." ] }, "5555999999999": { "success": [ "Cliente não existe na base de dados", "Cliente foi adicionado na base de dados" ], "error": [ "Campanha não foi encontrada: @campanha@aaa" ] } } }