https://github.com/apimatic/whatsapp-php-sdk
https://github.com/apimatic/whatsapp-php-sdk
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/apimatic/whatsapp-php-sdk
- Owner: apimatic
- License: other
- Created: 2022-06-17T08:45:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-17T08:46:28.000Z (about 4 years ago)
- Last Synced: 2025-02-10T14:53:16.836Z (over 1 year ago)
- Language: PHP
- Size: 84 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started with WhatsApp Cloud API
## Introduction
Welcome to the WhatsApp API from Meta.
Individual developers and existing Business Service Providers (BSPs) can now send and receive messages via the WhatsApp API using a cloud-hosted version of the WhatsApp Business API. Compared to the previous solutions, the cloud-based WhatsApp API is simpler to use and is a more cost-effective way for businesses to use WhatsApp. Please keep in mind the following configurations:
| Name | Description |
| --- | --- |
| Version | Latest [Graph API version](https://developers.facebook.com/docs/graph-api/). For example: v13.0 |
| User-Access-Token | Your user access token after signing up at [developers.facebook.com](https://developers.facebook.com). |
| WABA-ID | Your WhatsApp Business Account (WABA) ID. |
| Phone-Number-ID | ID for the phone number connected to the WhatsApp Business API. You can get this with a [Get Phone Number ID request](3184f675-d289-46f1-88e5-e2b11549c418). |
| Business-ID | Your Business' ID. Once you have your Phone-Number-ID, make a [Get Business Profile request](#99fd3743-46cf-46c4-95b5-431c6a4eb0b0) to get your Business' ID. |
| Recipient-Phone-Number | Phone number that you want to send a WhatsApp message to. |
| Media-ID | ID for the media to [send a media message](#0a632754-3788-43bf-b785-ac6a73423d5a) or [media template message](#439c926a-8a6c-4972-ab2c-d99297716da9) to your customers. |
| Media-URL | URL for the media to [download media content](#cbe5ece3-246c-48f3-b338-074187dfef66). |
## Building
The generated code has dependencies over external libraries like UniRest and JsonMapper. JsonMapper requires docblock annotations like `@var`, `@maps`, and `@factory` to map JSON responses with our class definitions. Hence the docblocks in generated code cannot be disabled by deactivating the PHP configurations like `opcache.save_comments`. These dependencies are defined in the `composer.json` file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than or equal to 7.2 installed in your system. Visit [https://getcomposer.org/download/](https://getcomposer.org/download/) to download the installer file for Composer and run it in your system. Open command prompt and type `composer --version`. This should display the current version of the Composer installed if the installation was successful.
* Using command line, navigate to the directory containing the generated files (including `composer.json`) for the SDK.
* Run the command `composer install`. This should install all the required dependencies and create the `vendor` directory in your project directory.
### Configuring CURL Certificate Path in php.ini
:information_source: **Note** This is for Windows users only.
CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:
1. Download the certificate bundle (.pem file) from [https://curl.haxx.se/docs/caextract.html](https://curl.haxx.se/docs/caextract.html) on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.
```
[curl]; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
curl.cainfo = PATH_TO/cacert.pem
```
## Installation
The following section explains how to use the WhatsAppCloudAPILib library in a new project.
### 1. Open Project in an IDE
Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on `Open` in PhpStorm to browse to your generated SDK directory and then click `OK`.
### 2. Add a new Test Project
Create a new directory by right clicking on the solution name as shown below:
Name the directory as "test".
Add a PHP file to this project.
Name it "testSDK".
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.
```php
require_once "vendor/autoload.php";
```
It is important that the path inside require_once correctly points to the file `autoload.php` inside the vendor directory created during dependency installations.
After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and use the Controller methods is given in the subsequent sections.
### 3. Run the Test Project
To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.
Open `Settings` from `File` menu.
Select `PHP` from within `Languages & Frameworks`.
Browse for Interpreters near the `Interpreter` option and choose your interpreter.
Once the interpreter is selected, click `OK`.
To run your project, right click on your PHP file inside your Test project and click on `Run`.
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `version` | `string` | *Default*: `'v13.0'` |
| `environment` | Environment | The API environment.
**Default: `Environment.PRODUCTION`** |
| `timeout` | `int` | Timeout for API calls in seconds.
*Default*: `0` |
| `enableRetries` | `bool` | Whether to enable retries and backoff feature.
*Default*: `false` |
| `numberOfRetries` | `int` | The number of retries to make.
*Default*: `0` |
| `retryInterval` | `float` | The retry time interval between the endpoint calls.
*Default*: `1` |
| `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.
*Default*: `2` |
| `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.
*Default*: `0` |
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.
*Default*: `true` |
| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.
*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |
| `httpMethodsToRetry` | `array` | Http methods to retry against.
*Default*: `'GET', 'PUT'` |
| `accessToken` | `string` | The OAuth 2.0 Access Token to use for API requests. |
The API client can be initialized as follows:
```php
$client = new WhatsAppCloudAPILib\WhatsAppCloudAPIClient([
// Set authentication parameters
'accessToken' => 'AccessToken',
// Set the environment
'environment' => 'production',
// Set configuration parameters
'version' => 'v13.0',
]);
```
## Authorization
This API uses `OAuth 2 Bearer token`.
## List of APIs
* [Business Profiles](doc/controllers/business-profiles.md)
* [Phone Numbers](doc/controllers/phone-numbers.md)
* [Two-Step Verification](doc/controllers/two-step-verification.md)
* [Messages](doc/controllers/messages.md)
* [Registration](doc/controllers/registration.md)
* [Media](doc/controllers/media.md)
## Classes Documentation
* [ApiException](doc/api-exception.md)
* [HttpRequest](doc/http-request.md)
* [HttpResponse](doc/http-response.md)