Skip to main content

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.11. Install the package from PyPi using the following pip command:

pip install sdksio-whatsapp-cloud-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/sdksio-whatsapp-cloud-api-sdk/1.0.0

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'
)

Authorization

This API uses OAuth 2 Bearer token.

List of APIs

Classes Documentation

Metadata

Release files for sdksio-whatsapp-cloud-api-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)

Source distribution for sdksio-whatsapp-cloud-api-sdk 1.0.0
File Size Uploaded Provenance Actions
sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz 30.9 kB Without provenance Details for sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sdksio-whatsapp-cloud-api-sdk 1.0.0
File Interpreter ABI Platform Actions
sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl

Total release size: 111.4 kB

Release files / sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz

Download URL sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz
Size 30.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f7f172a32993846eb382eaeeaa92963f9a7b2850a9dbe08514d1608c86e70774
BLAKE2b-256 checksum
How to use checksums
286c8b367b2f17ad66c578f92bf71b90dcb6090ad710800c36ee1fa8155b8ce6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Release files / sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl

Download URL sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl
Size 80.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3a68e59b56b4be72ad77d97ec0803820a5f5dcad21e0ae60a074ad46931af59
BLAKE2b-256 checksum
How to use checksums
4683849cf90cd8b8c28efb1f532082a569380637a580fc28e2a4b076a6397eb9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Security for sdksio-whatsapp-cloud-api-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.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page