README

生成实例密钥

访问： api-wa.me

Swagger

Postman

通过composer安装

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

示例

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

下载媒体

    $body = [
    "mediaKey" => "", 
    "directPath" => "", 
    "url" => "",
    ] ;
$type = "image";// video | audio| image | sticker | document|
echo $whatsapp->downloadMediaMessage($type, $body);

发送消息

发送存在状态

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

发送媒体

发送按钮

  $body = [
   "to" => "556696852025",
   "title" => "Are you enjoying ?",
   "footer" => "choose an option",
   "buttons" => [
       [
           "id" => "click_1",
           "text" => "Yes"
       ],
       [
           "id" => "click_2",
           "text" => "No"
       ]
   ]
];
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);