henriquecacerez/whatsapp-apibrasil-php

This package is abandoned and no longer maintained. No replacement package was suggested.

SDK em PHP para consumir a API do WhatsApp através da plataforma APIBrasil.

v1.0.0 2023-04-20 13:14 UTC

Requires

• php: >=7.0

MIT

• Henrique Cacerez

• php
• api
• sdk
• notification
• whatsapp
• apibrasil
• messge

README

⚙️ Configuração - API Brasil

Cadastrando na plataforma APIBrasil.

1. 
   
2. Criando uma conta.

   Acesse https://plataforma.apibrasil.com.br/auth/register para criar uma conta na plataforma.

   

3. Preenchendo os dados da conta.

   Após ter criado a conta, vá até a página "Meu plano" e selecione um plano que melhor atende as suas necessidades.

   

   Provavelmente você encontrará um aviso para completar o seu cadastro. Clique sobre o aviso e informe todos os dados necessários

   

4. Credenciais da API WhatsApp

   Após ter preenchido os dados da sua conta e ter selecionado o plano desejado. Vá até a página "Minhas API's".

   

   Procure por "API WhatsApp" e clique na chavinha "🔑" para visualizar as suas credenciais.

   

   Nesta página, você encontrará o seu BEARER TOKEN e a sua SECRET KEY.

   

5. Configurando o dispositivo.

   Clique em "( 0 ) Dispositivos" e clique no botão "+ Adicionar".

   

   Nesta seção, você encontrará o seu DEVICE TOKEN. Informe todos os dados necessários e clique em "Salvar".

   

   Observação: em "IP PERMITIDO", você deve informar o IP do seu servidor no qual rodará a sua aplicação. Você também pode informar o IP de sua máquina para rodar em ambiente local, Xampp ou WampServer, por exemplo.

6. Public Token & Conectando o seu número de WhatsApp.

   Após ter configurado o dispositivo, você pode encontra-lo na tabela da página "Dispositivos".

   Você encontrará também o seu "PUBLIC TOKEN".
   Para vincular o seu WhatsApp, clique no icone de "QR Code".

   

   Aguarde a resposta da API. (isso pode levar alguns segundos ou até minutos).

   Assim que o carregamento for concluído, um QR Code, ficará disponível para você, escaneie o código para conectar ao WhatsApp.

   

7. Conectado! ✅🚀

   Se tudo ocorrer bem, um aviso "connected" será mostrado em "status".

   

   Agora é só pegar todas as credenciais que você anotou durante todo o processo de configuração
   
   (SecretKey, PublicToken, DeviceToken e Bearer Token)
   
   e começar a integração.

Instalação

Composer

composer require henriquecacerez/whatsapp-apibrasil-php

// Exemplo:
require_once __DIR__ . '/vendor/autoload.php';

Manual

Baixe ou clone o repositório completo. Faça o download aqui.

// Exemplo:
require_once __DIR__ . '/App/ApiBrasil/WhatsApp.php';

Métodos:

Método	Descrição
sendText	Envia uma mensagem de texto simples.
sendImage	Envia uma imagem. Formatos aceitos: (jpeg, jpg, png e gif).
sendVideo	Envia um vídeo. Formatos aceitos: (mp4)
sendPDF	Envia um arquivo .PDF
sendButton	Envia uma mensagem com botões.

Iniciando

<?php

    require_once __DIR__ . '/vendor/autoload.php';

    use ApiBrasil\WhatsApp;

    // https://plataforma.apibrasil.com.br/plataforma/myaccount/apicontrol
    $credentials = [ 
        'SecretKey:     YOUR_SECRET_KEY',
        'PublicToken:   YOUR_PUBLIC_TOKEN',
        'DeviceToken:   YOUR_DEVICE_TOKEN',
        'Authorization: Bearer YOUR_BEARER_TOKEN'
    ];

    $whatsApp = new WhatsApp($credentials);

MENSAGEM DE TEXTO 💬

    /**
      * número de WhatsApp que receberá a mensagem.
      * (obrigatório conter o código do país e o DDD).
    */
    $phoneNumber = "[phone]";

    // mensagem que será enviada.
    $message = "Testando API! 😃"; 

    try {
        // envia a mensagem de texto.
        print_r($whatsApp->sendText($phoneNumber, $message));
    } catch (Exception $e) {
        // Caso dê erro, retornará o motivo.
        die("Error: " . $e->getMessage());
    }

ENVIO DE IMAGEM 🖼️

  // caminho da imagem
  $image = "cat.jpg";

  // legenda da imagem (opcional)
  $caption = "Legenda da imagem";

  // envia a imagem
  $whatsApp->sendImage(5518999999999, $image, $caption);

ENVIO DE VÍDEO 📽️

  $whatsApp->sendVideo(5518999999999, "files/simplevideo.mp4");

ENVIO DE PDF 📁

    // titulo do arquivo (opcional)
    $title = "Aplicação";
    
    // envia o arquivo pdf
    $whatsApp->sendPDF(5518999999999, "https://www.africau.edu/images/default/sample.pdf", $title);

MENSAGEM COM BOTÕES 🔢

    $buttons = [
      [
        'id'   => 'resposta_01',
        'text' => 'Botão 1️⃣'
      ], 
      [
        'id'   => 'resposta_02',
        'text' => 'Botão 2️⃣'
      ],
      [
        'id'   => 'resposta_03',
        'text' => 'Botão 3️⃣'
      ]
    ];

    // envia a mensagem com botões.
    $whatsApp->sendButtonMessage(5518999999999, [
        'title'  => "Titulo da mensagem",
        'text'   => "Imagine um texto bem legal aqui.\n\n👋😁",
        'footer' => "Aqui vai o texto do rodapé da mensagem"
    ], $buttons);

MENSAGEM COM BOTÕES 🔢 (COMPACTO)

    // cria o botão (id, texto)
    $whatsApp->createButton('resposta_01', "Botão 1️⃣");
    $whatsApp->createButton('resposta_02', "Botão 2️⃣");
    $whatsApp->createButton('resposta_03', "Botão 3️⃣");

    // envia a mensagem com botões.
    $whatsApp->sendButtonMessage(5518999999999, [
        'title'  => "Titulo da mensagem",
        'text'   => "Imagine um texto bem legal aqui.\n\n👋😁",
        'footer' => "Aqui vai o texto do rodapé da mensagem"
    ]);