# 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). |
## 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:
```python
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.](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/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. <br> **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. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **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. <br> **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:
```python
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
* [Business Profiles](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/business-profiles.md)
* [Phone Numbers](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/phone-numbers.md)
* [Two-Step Verification](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/two-step-verification.md)
* [Messages](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/messages.md)
* [Registration](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/registration.md)
* [Media](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/media.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "sdksio-whatsapp-cloud-api-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "whatsapp,messages,api,whatsapp-api,whatsapp-sdk,chat-sdk",
"author": "",
"author_email": "developer-sdksio <developer+sdksio@apimatic.io>",
"download_url": "https://files.pythonhosted.org/packages/28/6c/8b367b2f17ad66c578f92bf71b90dcb6090ad710800c36ee1fa8155b8ce6/sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with WhatsApp Cloud API\n\n## Introduction\n\nWelcome to the WhatsApp API from Meta.\n\nIndividual 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:\n\n| Name | Description |\n| --- | --- |\n| Version | Latest [Graph API version](https://developers.facebook.com/docs/graph-api/). For example: v13.0 |\n| User-Access-Token | Your user access token after signing up at [developers.facebook.com](https://developers.facebook.com). |\n| WABA-ID | Your WhatsApp Business Account (WABA) ID. |\n| 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). |\n| 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. |\n| Recipient-Phone-Number | Phone number that you want to send a WhatsApp message to. |\n| 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. |\n| Media-URL | URL for the media to [download media content](#cbe5ece3-246c-48f3-b338-074187dfef66). |\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install sdksio-whatsapp-cloud-api-sdk==1.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/sdksio-whatsapp-cloud-api-sdk/1.0.0\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `version` | `string` | *Default*: `'v13.0'` |\n| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `access_token` | `string` | The OAuth 2.0 Access Token to use for API requests. |\n\nThe API client can be initialized as follows:\n\n```python\nfrom whatsappcloudapi.whatsappcloudapi_client import WhatsappcloudapiClient\nfrom whatsappcloudapi.configuration import Environment\n\nclient = WhatsappcloudapiClient(\n access_token='AccessToken'\n)\n```\n\n## Authorization\n\nThis API uses `OAuth 2 Bearer token`.\n\n## List of APIs\n\n* [Business Profiles](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/business-profiles.md)\n* [Phone Numbers](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/phone-numbers.md)\n* [Two-Step Verification](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/two-step-verification.md)\n* [Messages](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/messages.md)\n* [Registration](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/registration.md)\n* [Media](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/controllers/media.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/sdksio-whatsapp-cloud-api-python-sdk/tree/1.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Use cloud-hosted version of the WhatsApp Business API to send and receive messages",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://www.apimatic.io/apidocs/whatsapp-api/v/1_0#/python"
},
"split_keywords": [
"whatsapp",
"messages",
"api",
"whatsapp-api",
"whatsapp-sdk",
"chat-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4683849cf90cd8b8c28efb1f532082a569380637a580fc28e2a4b076a6397eb9",
"md5": "72fbf452515aaea33097a3eb176ff6e5",
"sha256": "e3a68e59b56b4be72ad77d97ec0803820a5f5dcad21e0ae60a074ad46931af59"
},
"downloads": -1,
"filename": "sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72fbf452515aaea33097a3eb176ff6e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 80500,
"upload_time": "2023-06-08T10:10:24",
"upload_time_iso_8601": "2023-06-08T10:10:24.264420Z",
"url": "https://files.pythonhosted.org/packages/46/83/849cf90cd8b8c28efb1f532082a569380637a580fc28e2a4b076a6397eb9/sdksio_whatsapp_cloud_api_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "286c8b367b2f17ad66c578f92bf71b90dcb6090ad710800c36ee1fa8155b8ce6",
"md5": "9330e4e3814416a8abb30203a1733fd6",
"sha256": "f7f172a32993846eb382eaeeaa92963f9a7b2850a9dbe08514d1608c86e70774"
},
"downloads": -1,
"filename": "sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9330e4e3814416a8abb30203a1733fd6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30851,
"upload_time": "2023-06-08T10:10:26",
"upload_time_iso_8601": "2023-06-08T10:10:26.108934Z",
"url": "https://files.pythonhosted.org/packages/28/6c/8b367b2f17ad66c578f92bf71b90dcb6090ad710800c36ee1fa8155b8ce6/sdksio-whatsapp-cloud-api-sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-08 10:10:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sdksio-whatsapp-cloud-api-sdk"
}
JSON