henriquecacerez/whatsapp-apibrasil-php

此包已被废弃，不再维护。未建议替代包。

PHP SDK，用于通过APIBrasil平台消费WhatsApp API。

维护者

详细信息

github.com/HenriqueCacerez/whatsapp-apibrasil-php

源代码

问题

安装: 14

依赖: 0

建议者: 0

安全性: 0

星标: 2

关注者: 2

分支: 0

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

Requires

  • php: >=7.0

MIT 2c2cbdb937cff3d459911c663b81f59f64664671

  • Henrique Cacerez <cacerezhenrique.woop@gmail.com>

phpapisdknotificationwhatsappapibrasilmessge

This package is auto-updated.

Last update: 2024-05-20 15:41:03 UTC

README

⚙️ 配置 - API Brasil

在APIBrasil平台注册。


  2. 创建一个账户。

    访问 https://plataforma.apibrasil.com.br/auth/register 在平台上创建账户。

    68747470733a2f2f692e6962622e636f2f58436a527338702f53637265656e73686f742d323032332d30332d30352d61742d30382d31352d32332d43726961722d6d696e68612d636f6e74612d41504942726173696c2d53697465732d652d536f667477617265732d4c5444412e706e67

  3. 填写账户信息。

    创建账户后，前往“我的计划”页面，选择一个满足您需求的计划。

    68747470733a2f2f692e6962622e636f2f763130376347362f6d65752d706c616e6f2e706e67 68747470733a2f2f692e6962622e636f2f5774396d7967762f636164617374726f2d696e636f6d706c65746f2e706e67

    您可能会收到一个提示，要求您完成注册。点击提示并填写所有必要的数据。

    68747470733a2f2f692e6962622e636f2f56714a7752344d2f636164617374726f2d696e636f6d706c65746f322e706e67

  4. WhatsApp API凭据

    填写完账户信息和选择好计划后，前往“我的API”页面。

    68747470733a2f2f692e6962622e636f2f505139625257462f6d696e6861732d617069732e706e67

    搜索"API WhatsApp"，并点击钥匙图标“🔑”来查看您的凭据。

    68747470733a2f2f692e6962622e636f2f733633387a78422f6170692d77686174736170702d312e706e67

    在这个页面上，您将找到您的BEARER TOKEN和SECRET KEY。

    68747470733a2f2f692e6962622e636f2f39676b393558542f63726564656e63696169732d312e706e67

  5. 配置设备。

    点击"( 0 ) 设备"，然后点击"+ 添加"按钮。

    68747470733a2f2f692e6962622e636f2f304b4a664868382f646973706f73697469766f732d312e706e67

    在这个部分，您将找到您的DEVICE TOKEN。填写所有必要的数据，然后点击"保存"。

    68747470733a2f2f692e6962622e636f2f584c74734262532f6465766963652d746f6b656e2e706e67

    注意：在"IP 允许"中，您应提供运行您的应用程序的服务器IP地址。您也可以提供您机器的IP地址以在本地环境运行，例如Xampp或WampServer。

  6. 公共令牌 & 连接WhatsApp号码。

    配置设备后，您可以在“设备”页面的表格中找到它。

    您还可以找到您的"PUBLIC TOKEN"。
    要连接您的WhatsApp，请点击"QR Code"图标。

    68747470733a2f2f692e6962622e636f2f3359586d7230392f7075626c69632d746f6b656e2e706e67

    等待API的响应。（这可能需要几秒钟到几分钟）。

    加载完成后，将出现一个QR Code，扫描此代码以连接到WhatsApp。

    68747470733a2f2f692e6962622e636f2f44704c747452642f7172636f64652e706e67

  7. 连接成功！✅🚀

    如果一切顺利，"status"中将显示"connected"提示。

    68747470733a2f2f692e6962622e636f2f565668595139322f636f6e6e65637465642e706e67

    现在只需取出您在整个配置过程中记录的所有凭据

    (SecretKey，PublicToken，DeviceToken和BEARER TOKEN)

    即可开始集成。

安装

Composer

composer require henriquecacerez/whatsapp-apibrasil-php

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

手册

下载或克隆完整存储库。 下载链接。

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

方法

方法 描述
sendText 发送简单文本消息。
sendImage 发送图片。支持的格式：(jpeg, jpg, png 和 gif)。
sendVideo 发送视频。支持的格式：(mp4)
sendPDF 发送PDF文件。
sendButton 发送带按钮的消息。

开始

<?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 = "+55 (18) 99999-9999";

    // 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());
    }

图片发送 🖼️

Mensagem de Imagem

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

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

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

视频发送 📽️

68747470733a2f2f692e6962622e636f2f4b4c6a365659392f6578616d706c652d566964656f2e6a7067

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

PDF发送 📁

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);

按钮消息 🔢 (紧凑型)

    // 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"
    ]);