PHPackages                             raphaelvserafim/client-php-api-wa-me - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. raphaelvserafim/client-php-api-wa-me

ActiveLibrary[API Development](/categories/api)

raphaelvserafim/client-php-api-wa-me
====================================

Classe PHP para comunicação com api-wa.me

V1.0.4(7mo ago)102.4k↑25%10[1 issues](https://github.com/raphaelvserafim/client-php-api-wa-me/issues)MITPHP

Since Jun 3Pushed 7mo ago3 watchersCompare

[ Source](https://github.com/raphaelvserafim/client-php-api-wa-me)[ Packagist](https://packagist.org/packages/raphaelvserafim/client-php-api-wa-me)[ Docs](https://github.com/raphaelvserafim/client-php-api-wa-me)[ RSS](/packages/raphaelvserafim-client-php-api-wa-me/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)DependenciesVersions (6)Used By (0)

WhatsApp API
============

[](#whatsapp-api)

About Our WhatsApp API
----------------------

[](#about-our-whatsapp-api)

🔓 **Unlock the Potential of WhatsApp:** Powerful Integration with Our Unofficial API!

### Efficient Group Management on WhatsApp

[](#efficient-group-management-on-whatsapp)

📋 Our stable, though unofficial, API allows for efficient management of WhatsApp groups. Simplify administration, and easily add or remove members.

### Versatile Message Sending

[](#versatile-message-sending)

💬 With our API, you can send text, audio, video, and image messages quickly and easily. Adapt to your business communication needs comprehensively.

### Receive Instant Events

[](#receive-instant-events)

🔔 Stay updated with our API, receiving real-time events when new messages are received. Stay connected and agile in responding to interactions on WhatsApp.

🔗 **Create Your Account:** Visit  to create your account and start using our API today!

🎁 **Special Discount:** Use the coupon **GIT20** and get 20% off on your first instance!

Contact Support
---------------

[](#contact-support)

- **Name:** Raphael Serafim
- **Email:**
- **Website:**

Installing via composer
-----------------------

[](#installing-via-composer)

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

```

### EXAMPLES

[](#examples)

##### WHATSAPP

[](#whatsapp)

```
use Api\Wame\WhatsApp;

include_once 'vendor/autoload.php';

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

#### Get webhook

[](#get-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;
```

#### Exemple

[](#exemple)

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

#### Get QrCode HTML

[](#get-qrcode-html)

```
echo $whatsapp->connect();
```

#### Infor Instance

[](#infor-instance)

```
echo $whatsapp->inforInstance();
```

#### Update Webhook

[](#update-webhook)

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

#### Logout

[](#logout)

```
echo $whatsapp->logout();
```

Actions
-------

[](#actions)

### Get List Contacts

[](#get-list-contacts)

```
echo $whatsapp->listContacts();
```

### Get Profile Pic

[](#get-profile--pic)

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

### Update Profile Name

[](#update-profile-name)

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

### Update Profile And Group Picture

[](#update-profile-and-group--picture)

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

Send Message
------------

[](#send-message)

### send Presence

[](#send-presence)

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

### send Text

[](#send-text)

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

### send Audio

[](#send-audio)

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

### send Image

[](#send-image)

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

### send Video

[](#send-video)

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

### send Document

[](#send-document)

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

### Send Button Action

[](#send-button-action)

```
  $body = [
     'to' => '14375223417',
     'header' => [
       'title' => 'Example Title',
       'hasMediaAttachment' => true,
       'imageMessage' => [
         'url' => 'https://raphaelvserafim.com/og-image.png'
       ]
     ],
     'text' => 'This is a test',
     'footer' => 'choose an option',
     'buttons' => [
       [
         'type' => 'cta_copy',
         'copy_code' => '1234567890',
         'text' => 'Copy barcode'
       ],
       [
         'type' => 'cta_url',
         'url' => 'https://api-wa.me',
         'text' => 'Access the website'
       ],
       [
         'type' => 'cta_call',
         'phone_number' => '+14375223417',
         'text' => 'Call us'
       ]
     ]
   ];
echo $whatsapp->sendButton($body);
```

### Send Button Reply

[](#send-button-reply)

```
  {
 "to": "14375223417",
 "header": {
   "title": "Example Header",
   "hasMediaAttachment": true,
   "imageMessage": {
     "url": "https://raphaelvserafim.com/og-image.png"
   }
 },
 "text": "This is a test",
 "footer": "choose an option",
 "buttons": [
   {
     "type": "quick_reply",
     "id": "uniqId1",
     "text": "Yes"
   },
   {
     "type": "quick_reply",
     "id": "uniqId2",
     "text": "No"
   }
 ]
}
echo $whatsapp->sendButtonReply($body);
```

### Send List

[](#send-list)

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

### send Contact

[](#send-contact)

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

### send Location

[](#send-location)

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

### send Reaction

[](#send-reaction)

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

Group
-----

[](#group)

### Get list Group

[](#get-list-group)

```
   echo $whatsapp->listGroup();
```

### Get infor Group

[](#get-infor-group)

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

### Get Invite Code Group

[](#get-invite-code-group)

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

### create Group

[](#create-group)

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

### add Participants Group

[](#add-participants-group)

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

### Promote Participants Group Admin

[](#promote-participants-group-admin)

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

### Remove Participants Group

[](#remove-participants-group)

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

### Leave Group

[](#leave-group)

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

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance60

Regular maintenance activity

Popularity31

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 98.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~119 days

Total

5

Last Release

238d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/de9becc93ce316ba0bc340d1d5600aa9c16e2ae2607f7e6f763e4f9db10287a8?d=identicon)[cachesistemas](/maintainers/cachesistemas)

---

Top Contributors

[![raphaelvserafim](https://avatars.githubusercontent.com/u/68257896?v=4)](https://github.com/raphaelvserafim "raphaelvserafim (116 commits)")[![diogodourado](https://avatars.githubusercontent.com/u/3443210?v=4)](https://github.com/diogodourado "diogodourado (2 commits)")

---

Tags

phpphp-librarywhatsappwhatsapp-apiwhatsapp-botwhatsapp-chat

### Embed Badge

![Health badge](/badges/raphaelvserafim-client-php-api-wa-me/health.svg)

```
[![Health](https://phpackages.com/badges/raphaelvserafim-client-php-api-wa-me/health.svg)](https://phpackages.com/packages/raphaelvserafim-client-php-api-wa-me)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
