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. For example: v13.0 |
| User-Access-Token | Your user access token after signing up at 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. |
| Business-ID | Your Business' ID. Once you have your Phone-Number-ID, make a Get Business Profile request 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 or media template message to your customers. |
| Media-URL | URL for the media to download media content. |
Install the Package
The package is compatible with Python versions 3 >=3.7, <= 3.9.
Install the package from PyPi using the following pip command:
pip install whatsapp-python-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/whatsapp-python-sdk
Initialize the API Client
Note: Documentation for the client can be found here.
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 |
http_client_instance |
HttpClient |
The Http Client passed from the sdk user for making requests |
override_http_client_configuration |
bool |
The value which determines to override properties of the passed Http Client from the sdk user |
http_call_back |
HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
timeout |
float |
The value to use for connection timeout. Default: 60 |
max_retries |
int |
The number of times to retry an endpoint call if it fails. Default: 0 |
backoff_factor |
float |
A backoff factor to apply between attempts after the second try. Default: 2 |
retry_statuses |
Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
retry_methods |
Array of string |
The http methods on which retry is to be done. Default: ['GET', 'PUT'] |
access_token |
string |
The OAuth 2.0 Access Token to use for API requests. |
The API client can be initialized as follows:
from whatsappcloudapi.whatsappcloudapi_client import WhatsappcloudapiClient
from whatsappcloudapi.configuration import Environment
client = WhatsappcloudapiClient(
access_token='AccessToken',
environment=Environment.PRODUCTION,
version = 'v13.0',)
Authorization
This API uses OAuth 2 Bearer token.
List of APIs
Classes Documentation
1 maintainer
Metadata
1 maintainer
Release files for whatsapp-python-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| whatsapp-python-sdk-1.0.0.tar.gz | 34.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| whatsapp_python_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 123.3 kB
Release files / whatsapp-python-sdk-1.0.0.tar.gz
| Download URL | whatsapp-python-sdk-1.0.0.tar.gz |
|---|---|
| Size | 34.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
80c7bf7a76fd899ab9ce89fb314bf78fa39a0efcfa9e6874768f65d164210251
|
|
BLAKE2b-256 checksum How to use checksums |
2f985d39668d742d2fc771ff357714d6b05c2c3c954cc1d2edc6c06d06999e82
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.6.8
|
Release files / whatsapp_python_sdk-1.0.0-py3-none-any.whl
| Download URL | whatsapp_python_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 88.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c6b8c0d418393864d052f265fc0221261eca3824fed67921aa8ac0dd41c36a58
|
|
BLAKE2b-256 checksum How to use checksums |
94da981998612355d94b8919115f11007eaec98609dd2c8825165d50f1c4a8af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.6.8
|
Security for whatsapp-python-sdk 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
