API

Veja aqui todas as informações sobre envios e consultas via API
Hualyson Carvalho
Por Hualyson Carvalho
6 artigos

Como utilizar o Gateway para envios

1 - Enviando texto - Jquery var settings = { url:"https://zapisp.com.br/api/whatsapp/generic/v1/text", method: "POST", // ou GET data: { apiToken: "token_da_instancia", telefone: "NUMERO_DO_TELEFONE", mensagem: "mensagem" } } $.ajax(settings).done(function (response){ console.log(response); }); - PHP $mensagem = 'Meu primeiro teste com a API do zapisp!'; $telefone = 'NUMERO_DO_TELEFONE'; $apiToken = 'token_da_instancia'; $api = "https://zapisp.com.br/api/whatsapp/generic/v1/text"; $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 ]); $response = curl_exec($ch); curl_close($ch); print_r($response); 2 - Enviando PDF - PHP $telefone = 'NUMERO_DO_TELEFONE'; $title = 'Exemplo'; $pdf = 'https://expoforest.com.br/wp-content/uploads/2017/05/exemplo.pdf'; $apiToken = 'token_da_instancia'; $api = "https://zapisp.com.br/api/whatsapp/generic/v1/pdf"; $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, 'title' => $title, 'pdf' => $pdf ]); $response = curl_exec($ch); curl_close($ch); print_r($response); - Jquery var settings = { url: "https://zapisp.com.br/api/whatsapp/generic/v1/pdf", method: "POST", // ou GET data: { apiToken: "token_da_instancia", telefone: NUMERO_DO_TELEFONE", pdf: "https://expoforest.com.br/wp-content/uploads/2017/05/exemplo.pdf", title: "Exemplo" } } $.ajax(settings).done(function (response) { console.log(response); }); 3 - Envio de imagem - PHP $telefone = 'NUMERO_DO_TELEFONE'; $msg = 'Essa é uma imagem'; $img = 'https://zapisp.com.br/public/api.png'; $apiToken = 'token_da_instancia'; $api = "https://zapisp.com.br/api/whatsapp/generic/v1/img"; $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, 'msg' => $msg, 'img' => $img ]); $response = curl_exec($ch); curl_close($ch); print_r($response); - Jquery var settings = { url: "https://zapisp.com.br/api/whatsapp/generic/v1/img", method: "POST", // ou GET data: { apiToken: "token_da_instancia", telefone: "NUMERO_DO_TELEFONE", img: "https://zapisp.com.br/public/api.png", msg: "Essa é uma imagem" } } $.ajax(settings).done(function (response) { console.log(response); }); Nunca divulgue ou compartilhe esta informação com terceiros. Isto possibilitará que mensagens sejam enviadas em nome da sua empresa!

Última atualização em Feb 19, 2025

Como integrar a API da META na Zapisp

1. Cadastrando sua empresa na página de desenvolvedores do META (Facebook) https://www.youtube.com/watch?v=n4uzEsKjb6M&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - Faça login no Facebook com a conta do responsável pela empresa; - Acesse a página de desenvolvedores do Meta neste link; - Clique em Meus apps no menu superior e em Criar aplicativo; - Selecione a conta da sua empresa que será conectada à nossa plataforma e clique em Avançar; - Selecione a opção Outro, lá no final da página e clique novamente em Avançar; - Selecione a opção Empresa e o botão **Avançar **para a próxima página; - Insira um nome para essa integração (que irá aparecer na página inicial Meus Apps, no Facebook); - Selecione o perfil da sua empresa no campo Portfólio Empresarial e finalize clicando em Criar aplicativo. 2. Configurando o número do WhatsApp Business https://www.youtube.com/watch?v=pg8uyIQs2os&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - No Painel de Apps do Meta, procure o WhatsApp e clique em Configurar; - Clique em Começar a usar a API; - No campo Enviar e receber mensagens, clique em + Adicionar Telefone para cadastrar o número que aparecerá como remetente das mensagens que você enviar; - Insira o nome que será exibido no WhatsApp Business, selecione a categoria outro, uma breve descrição e clique em Avançar; - Insira o número do telefone, selecione a opção SMS e clique em Avançar; - Você receberá um código de confirmação por SMS no número cadastrado. Insira o código e clique em Avançar. 3. Ativando a integração e permissões https://www.youtube.com/watch?v=enyj0Dfl9vU&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - Na plataforma da Zapisp, acesse a página de aplicativos e selecione o Meta WhatsApp Oficial; - Na aba configurações, copie a URL de retorno de chamada; - Retorne ao Meta, procure o WhatsApp no menu do lado esquerdo, clique em Configuração e cole a URL no campo correspondente; - Volte à plataforma da Zapisp para copiar o código de Verificar Token, cole no campo correspondente no Meta e clique em Verificar e salvar; - Para finalizar esta etapa, assine todas as seguintes permissões descritas abaixo. Elas são obrigatórias para o funcionamento correto da integração. - account_review_update - account_update - business_capability_update - business_status_update - message_template_status_update - messages - phone_number_name_update - phone_number_quality_update - Security 4. Ativando a integração no Meta Business Suíte https://www.youtube.com/watch?v=ntukB8sx9yk&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - Acesse o Meta Business Suíte; - Clique em Configurações no menu esquerdo e selecione a opção Usuários do sistema; - Clique no botão +Adicionar, escreva um nome de usuário, selecione a opção Admin e clique em Create system user. É obrigatório que o usuário seja Admin para integrar na plataforma. - Selecione o usuário, clique em Atribuir Ativos, selecione a opção aplicativos, ative a permissão Gerenciar app, confirme no botão Atribuir Ativos novamente e Concluir; - Selecione o botão Gerar token, escolha o app e avance; - Selecione a opção Nunca para que o token não expire e avance; - No campo de permissões, selecione as quatro opções abaixo e clique em gerar token: - business_management - catalog_management - whatsapp_business_messaging - whatsapp_business_management - Copie o código token e conclua. 5. Conclusão https://www.youtube.com/watch?v=bJf3ISdzv9o&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - No painel de aplicativos da plataforma Zapisp, selecione o Meta WhatsApp Oficial; - No campo Configurações, role a página até o passo 2, copie o Token no campo em branco e salve; - Retorne ao painel de apps do Meta for developers, procure Whatsapp no menu esquerdo e selecione Configurações da API; - Copie a identificação da conta do WhatsApp Business, volte para o painel da Zapisp, cole o código no campo do passo 3, salve e clique em ativar. 6. Testando https://www.youtube.com/watch?v=CywccjN0_W0&embeds_referring_euri=https%3A%2F%2Fajuda.zapisp.com.br%2F&source_ve_path=OTY3MTQ - Para começar a usar as comunicações via WhatsApp direto do Meta, acesse o Meta Business Suíte; - Clique em Configurações no menu do lado esquerdo, clique em Contas do WhatsApp, selecione a conta que você vai usar e clique em Gerenciador do WhatsApp; - Ao abrir o gerenciador, clique em Gerenciar modelos. Você verá que os modelos criados na Zapisp já apareceram lá. Você pode editar os modelos que já tem ou criar um do zero clicando em Criar modelo. - Pronto, agora é só inserir o conteúdo que você deseja enviar. . 💡Dica de ouro: Precisa de mais assistência? Obtenha ainda mais dicas e suporte fazendo parte do Zapisp News , nossa comunidade no WhatsApp exclusiva para clientes para troca de dicas, insights e vivências de provedores

Última atualização em Feb 19, 2025

Como disparar múltiplas mensagens para múltiplos números API da ZAPISP

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. (OPCIONAL)OBS: Caso a instância não for informada recupera a primeira instância válida para disparo | | token | Token api do cliente. (OBRIGATÓRIO) | | body | {"telefones": ["5581900000000",...],"mensagem": ["@campanha@*********","@nps@","texto adicional",...]}"telefone": [] ➝ Adicione uma lista de telefones"mensagem": ➝ Adicione coringa de campanhas, coringa de nps ou mensagens de 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: Vá em Campanhas > Listagem de Campanhas: 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: Nessa campanha, eu tenho apenas um campo de texto para ser enviado a meu cliente, mas pode ser e-mail, sms, áudio, e-mail, todos ao mesmo tempo, em um único coringa a ser enviado pelo ERP: - 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" ] } } }

Última atualização em Feb 19, 2025

Envio via API

tençã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.

Última atualização em Feb 19, 2025