Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raphaelvserafim/classe-php-api-wa.me
API WhatsApp PHP to api-wa.me
https://github.com/raphaelvserafim/classe-php-api-wa.me
api api-client api-rest api-server api-swagger php whatsapp whatsapp-api whatsapp-bot
Last synced: about 15 hours ago
JSON representation
API WhatsApp PHP to api-wa.me
- Host: GitHub
- URL: https://github.com/raphaelvserafim/classe-php-api-wa.me
- Owner: raphaelvserafim
- Created: 2022-05-23T12:36:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T14:43:38.000Z (4 months ago)
- Last Synced: 2024-09-20T20:04:02.622Z (4 days ago)
- Topics: api, api-client, api-rest, api-server, api-swagger, php, whatsapp, whatsapp-api, whatsapp-bot
- Language: PHP
- Homepage: https://api-wa.me/?ref=1
- Size: 88.9 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WhatsApp API - PHP
##### Gerar Instância Key:
Acessar: api-wa.me## Installing via composer
```
composer require raphaelvserafim/client-php-api-wa-me
```### EXAMPLES
```phpuse Api\Wame\WhatsApp;
include_once 'vendor/autoload.php';
$whatsapp = new WhatsApp(
["server" => "API server",
"key" => "Your Key Instance"]
);
```#### Get webhook
```php
$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
```php
if ($whatsapp->from->messageType === "text" && $whatsapp->from->text === "Hi") {
$whatsapp->sendText($whatsapp->from->remoteJid, "Hello!");
}
```#### Get QrCode HTML
```php
echo $whatsapp->connect();
```#### Infor Instance
```php
echo $whatsapp->inforInstance();
```#### Update Webhook
```php
$body = [
"allowWebhook" => false,
"webhookMessage" => "",
"webhookGroup" => "",
"webhookConnection" => "",
"webhookQrCode" => "",
"webhookMessageFromMe"=>"",
"webhookHistory"=>""
];
echo $whatsapp->updateWebhook($body);
```#### Logout
```php
echo $whatsapp->logout();
```
## Actions### Get List Contacts
```php
echo $whatsapp->listContacts();
```### Get Profile Pic
```php
echo $whatsapp->profilePic('556696852025');
```### Update Profile Name
```php
echo $whatsapp->updateProfileName('Raphael Serafim');
```
### Update Profile And Group Picture
```php
$url =''; // url image
echo $whatsapp->updateProfilePicture($url);
```### Download Media
```php
$body = [
"mediaKey" => "",
"directPath" => "",
"url" => "",
] ;
$type = "image";// video | audio| image | sticker | document|
echo $whatsapp->downloadMediaMessage($type, $body);
```## Send Message
### send Presence
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$status = 'composing'; // unavailable | available | composing | recording | paused
echo $whatsapp->sendPresence($to, $status);
```### send Text
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$text = 'Hi';
echo $whatsapp->sendText($to, $text);
```### send Audio
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$url = ''; // your MP3 or OGG audio URL
echo $whatsapp->sendAudio($to, $url);
```### send Media
### Send Button
```php
$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);
```### Send List
```php
$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
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$name = 'CACHE SISTEMAS';
$number = '+556696883327';
echo $whatsapp->sendContact($to, $name, $number);
```### send Location
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$lat = 37.7749;
$lon = -122.4194;
$address = '123 Main St, San Francisco, CA';
echo $whatsapp->sendLocation($to, $lat, $lon, $address);
```### send Reaction
```php
$to = '556696852025'; // if it's a group, use full id ex: [email protected]
$text = '😘';
$msgId = '';
echo $whatsapp->sendReaction($to, $text, $msgId);
```## Group
### Get list Group
```php
echo $whatsapp->listGroup();
```### Get infor Group
```php
$group_id = '[email protected]';
echo $whatsapp->inforGroup($group_id);
```### Get Invite Code Group
```php
$group_id = '[email protected]';
echo $whatsapp->groupInviteCode($group_id);
```### create Group
```php
$name = 'API PHP WhatsApp';
$participants = ['556696852025'];
echo $whatsapp->createGroup($name, $participants);
```### add Participants Group
```php
$group_id = '[email protected]';
$participants = ['556696852025'];
echo $whatsapp->addParticipantsGroup($group_id, $participants);
```### Promote Participants Group Admin
```php
$group_id = '[email protected]';
$participants = ['556696852025'];
$action = "promote"; // demote
echo $whatsapp->promoteParticipantsGroup($group_id, $participants, $action);
```### Remove Participants Group
```php
$group_id = '[email protected]';
$participants = ['556696852025'];
echo $whatsapp->removeParticipantsGroup($group_id, $participants);
```### Leave Group
```php
$group_id = '[email protected]';
echo $whatsapp->leaveGroup($group_id);
```