raphaelvserafim/client-php-api-wa-me

用于与api-wa.me通信的PHP类

v1.0.2 2024-06-25 02:50 UTC

This package is auto-updated.

Last update: 2024-08-31 20:45:54 UTC


README

关于我们的WhatsApp API

🔓 释放WhatsApp的潜力:通过我们非官方API实现强大的集成!

WhatsApp上的高效群组管理

📋 我们稳定但非官方的API允许高效管理WhatsApp群组。简化管理,轻松添加或删除成员。

灵活的消息发送

💬 使用我们的API,您可以快速轻松地发送文本、音频、视频和图片消息。全面适应您的业务通信需求。

接收即时事件

🔔 通过我们的API,您可以在收到新消息时实时接收事件更新。保持连接并灵活响应WhatsApp上的互动。

🔗 创建您的账户:访问 https://api-wa.me/sign-up 创建您的账户并立即开始使用我们的API!

🎁 特别优惠:使用优惠券 GIT20 在您的第一个实例上享受20%的折扣!

联系支持

通过composer安装

composer require raphaelvserafim/client-php-api-wa-me

EXAMPLES

WHATSAPP
use Api\Wame\WhatsApp;

include_once 'vendor/autoload.php';

$whatsapp     = new WhatsApp(
    ["server" => "API server", 
    "key" => "Your Key Instance"]
    );

获取webhook

    $whatsapp->constructWebhook();
    $whatsapp->from->remoteJid; //  number that sent message
    $whatsapp->from->messageType; // video | text | audio| image | sticker | document| reaction | liveLocation | 
    $whatsapp->from->msgId;
    $whatsapp->from->pushName;
    $whatsapp->from->text; 

示例

if ($whatsapp->from->messageType === "text" && $whatsapp->from->text === "Hi") {
  $whatsapp->sendText($whatsapp->from->remoteJid, "Hello!");
}

获取QrCode HTML

echo $whatsapp->connect();

信息实例

echo $whatsapp->inforInstance();

更新Webhook

$body = [
"allowWebhook" => 1, // 1=true or 0=false
"webhookMessage" => "",
"webhookGroup" => "",
"webhookConnection" => "",
"webhookQrCode" => "", 
"webhookMessageFromMe"=>"", 
"webhookHistory"=>""
]; 
echo $whatsapp->updateWebhook($body);

登出

echo $whatsapp->logout();

动作

获取联系人列表

echo $whatsapp->listContacts();

获取个人资料图片

echo $whatsapp->profilePic('556696852025');

更新个人资料名称

echo $whatsapp->updateProfileName('Raphael Serafim');

更新个人资料和群组图片

$url =''; // url image 
echo $whatsapp->updateProfilePicture($url);

发送消息

发送存在状态

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$status = 'composing';   // unavailable | available | composing | recording | paused
echo $whatsapp->sendPresence($to, $status);

发送文本

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$text   = 'Hi';   
echo $whatsapp->sendText($to, $text);

发送音频

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$url    = ''; // your MP3 or OGG audio URL    
echo $whatsapp->sendAudio($to, $url);

发送图片

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$url    = '';  
$caption = '';
echo $whatsapp->sendImage($to, $url);

发送视频

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$url    = '';  
$caption = '';
echo $whatsapp->sendVideo($to, $url);

发送文档

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$url    = '';  
$caption = '';
$mimetype = 'application/pdf'; // https://mdn.org.cn/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types 
$fileName='';
echo $whatsapp->sendDocument($to, $url, $mimetype, $fileName);

发送按钮

  $body = [
   "to" => "556696852025",
   "title" => "Are you enjoying ?",
   "footer" => "choose an option",
   "buttons" => [
       [
           "type"=> "quick_reply",
           "id" => "click_1",
           "text" => "Yes"
       ],
       [
           "type"=> "cta_copy",
           "copy_code" => "000000000000",
           "text" => "Copy barcode"
       ],
       [
           "type"=> "cta_url",
           "url" => "https://api-wa.me",
           "text" => "Access the website"
       ],
       [
           "type"=> "send_location"
       ]
   ]
];
echo $whatsapp->sendButton($body);

发送列表

  $body = [
   "to" => "556696852025",
   "buttonText" => "Menu",
   "text" => "string", 
   "title" => "Menu",
   "description" => "Description",
   "footer" => "footer", 
   "sections" => [
       [
           "title" => "Pizza",
           "rows" => [
               [
                   "title" => "Pizza 01",
                   "description" => "Example pizza 01",
                   "rowId" => "1"
               ]
           ]
       ]
   ]
];
echo $whatsapp->sendList($body);

发送联系人

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$name   = 'CACHE SISTEMAS';   
$number = '+556696883327';
echo $whatsapp->sendContact($to, $name, $number);

发送位置

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$lat    =  37.7749;   
$lon    =  -122.4194;
$address = '123 Main St, San Francisco, CA';
echo $whatsapp->sendLocation($to, $lat, $lon, $address);

发送反应

$to     = '556696852025'; // if it's a group, use full id ex: 123456789@g.us  
$text   =  '😘';   
$msgId  =  '';
echo $whatsapp->sendReaction($to, $text, $msgId);

群组

获取群组列表

   echo $whatsapp->listGroup();

获取群组信息

   $group_id = '123456789@g.us'; 
   echo $whatsapp->inforGroup($group_id);

获取群组邀请码

   $group_id = '123456789@g.us'; 
   echo $whatsapp->groupInviteCode($group_id);

创建群组

   $name = 'API PHP WhatsApp'; 
   $participants = ['556696852025'];
   echo $whatsapp->createGroup($name, $participants);

添加群组成员

   $group_id     = '123456789@g.us'; 
   $participants = ['556696852025'];
   echo $whatsapp->addParticipantsGroup($group_id, $participants);

提升群组成员为管理员

   $group_id     = '123456789@g.us'; 
   $participants = ['556696852025'];
   $action = "promote"; // demote
   echo $whatsapp->promoteParticipantsGroup($group_id, $participants, $action);

移除群组成员

   $group_id     = '123456789@g.us'; 
   $participants = ['556696852025'];
   echo $whatsapp->removeParticipantsGroup($group_id, $participants);

离开群组

   $group_id     = '123456789@g.us'; 
   echo $whatsapp->leaveGroup($group_id);