What It Does
This package makes it easy for developers to access WhatsApp Cloud API service in their PHP code.
The first 1,000 conversations each month are free from WhatsApp Cloud API. A conversation.
Getting Started
Please create and configure your Facebook WhatsApp application following the "Get Stared" section of the official guide.
Minimum requirements – To run the SDK, your system will require PHP >= 7.4 with a recent version of CURL >=7.19.4 compiled with OpenSSL and zlib.
Installation
compose require netflie/whatsapp-cloud-api
Quick Examples
Send a text message
// Require the Composer autoloader.
require 'vendor/autoload.php';
use Netflie\WhatsAppCloudApi\WhatsAppCloudApi;
// Instantiate the WhatsAppCloudApi super class.
$whatsapp_cloud_api = new WhatsAppCloudApi([
'from_phone_number_id' => 'your-configured-from-phone-number-id',
'access_token' => 'your-facebook-whatsapp-application-token',
]);
$whatsapp_cloud_api->sendTextMessage('34676104574', 'Hey there! I\'m using WhatsApp Cloud API. Visit https://www.netflie.es');
Send a document
You can send documents in two ways: by uploading a file to the WhatsApp Cloud servers (where you will receive an identifier) or from a link to a document published on internet.
use Netflie\WhatsAppCloudApi\Message\Media\LinkID;
use Netflie\WhatsAppCloudApi\Message\Media\MediaObjectID;
$document_id = '341476474779872';
$document_name = 'whatsapp-cloud-api-from-id.pdf';
$document_caption = 'WhastApp API Cloud Guide';
// With the Media Object ID of some document upload on the WhatsApp Cloud servers
$media_id = new MediaObjectID($document_id);
$whatsapp_cloud_api->sendDocument('34676104574', $media_id, $document_name, $document_caption);
// Or
$document_link = 'https://netflie.es/wp-content/uploads/2022/05/image.png';
$link_id = new LinkID($document_link);
$whatsapp_cloud_api->sendDocument('34676104574', $link_id, $document_name, $document_caption);
Send a template message
$whatsapp_cloud_api->sendTemplate('34676104574', 'hello_world', 'en_US'); // Language is optional
You also can build templates with parameters:
$component_header = [];
$component_body = [
[
'type' => 'text',
'text' => '*Mr Jones*',
],
];
$component_buttons = [
[
'type' => 'button',
'sub_type' => 'quick_reply',
'index' => 0,
'parameters' => [
[
'type' => 'text',
'text' => 'Yes',
]
]
],
[
'type' => 'button',
'sub_type' => 'quick_reply',
'index' => 1,
'parameters' => [
[
'type' => 'text',
'text' => 'No',
]
]
]
];
$components = new Component($component_header, $component_body, $component_buttons);
$whatsapp_cloud_api->sendTemplate('34676104574', 'sample_issue_resolution', 'en_US', $components); // Language is optional
Send an audio message
$audio_link = 'https://netflie.es/wp-content/uploads/2022/05/file_example_OOG_1MG.ogg';
$link_id = new LinkID($audio_link);
$whatsapp_cloud_api->sendAudio('34676104574', $link_id);
Send an image message
$link_id = new LinkID('http(s)://image-url');
$whatsapp_cloud_api->sendImage('' , $link_id);
//or
$media_id = new MediaObjectID('' );
$whatsapp_cloud_api->sendImage('' , $media_id);
Send a video message
$link_id = new LinkID('http(s)://video-url');
$whatsapp_cloud_api->sendVideo('' , $link_id, '' );
//or
$media_id = new MediaObjectID('' );
$whatsapp_cloud_api->sendVideo('' , $media_id, '' );
Send a sticker message
Stickers sample: https://github.com/WhatsApp/stickers
$link_id = new LinkID('http(s)://sticker-url');
$whatsapp_cloud_api->sendSticker('' , $link_id);
//or
$media_id = new MediaObjectID('' );
$whatsapp_cloud_api->sendSticker('' , $media_id);
Send a location message
$whatsapp_cloud_api->sendLocation('' , $longitude, $latitude, $name, $address);
Send a contact message
$name = new ContactName('Adams', 'Smith');
$phone = new Phone('34676204577', PhoneType::CELL());
$whatsapp_cloud_api->sendContact('' , $name, $phone);
Features
- Send Text Messages
- Send Documents
- Send Templates with parameters
- Send Audios
- Send Images
- Send Videos
- Send Stickers
- Send Locations
- Send Contacts
Getting Help
- Ask a question on the Discussions forum
- To report bugs, please open an issue
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
composer unit-test
You also can run tests making real calls to the WhastApp Clou API. Please put your testing credentials on WhatsAppCloudApiTestConfiguration file.
composer integration-test
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information. Please see License file for more information.
Disclaimer
This package is not officially maintained by Facebook. WhatsApp and Facebook trademarks and logos are the property of Meta Platforms, Inc.
7 Nov 23, 2022
2 Jan 18, 2022
12 Dec 26, 2022
77 Nov 29, 2022
3 Jun 23, 2022
33 Nov 16, 2022
493 Dec 16, 2022
804 Dec 19, 2022
2 Sep 28, 2021
2 Dec 12, 2022
0 Aug 10, 2022
10 Sep 2, 2021
3 Jul 31, 2021
39 Nov 22, 2022
2.5k Dec 29, 2022
10 Nov 12, 2022
12 Sep 23, 2022
7 Jun 26, 2022