Client Reference

Client Reference#

Text messages are messages containing text and an optional link preview.

You can have the WhatsApp client attempt to render a preview of the first URL in the body text string, if it contains one. URLs must begin with http:// or https://. If multiple URLs are in the body text string, only the first URL will be rendered. If omitted, or if unable to retrieve a link preview, a clickable link will be rendered instead.
See Text messages.
See Markdown for formatting text messages.

Example

>>> wa = WhatsApp(...)
>>> wa.send_message(
...     to="1234567890",
...     text="Hello from PyWa! (https://github.com/david-lev/pywa)",
...     preview_url=True,
... )

Parameters:

to – The phone ID of the WhatsApp user.
text –
The text to send (markdown allowed, max 4096 characters).
header –
The header of the message (if buttons are provided, optional, up to 60 characters, no markdown allowed).
footer –
The footer of the message (if buttons are provided, optional, up to 60 characters, markdown has no effect).
buttons – The buttons to send with the message (optional).
preview_url – Whether to show a preview of the URL in the message (if any).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Image messages are messages that display a single image and an optional caption.

See Image messages.
See Supported image formats.
Images must be 8-bit, RGB or RGBA.

Example

>>> wa = WhatsApp(...)
>>> wa.send_image(
...     to="1234567890",
...     image="https://example.com/image.png",
...     caption="This is an image!",
... )

Parameters:

to – The phone ID of the WhatsApp user.
image – The image to send (either a media ID, URL, file path, bytes, or an open file object. When buttons are provided, only URL is supported).
caption –
The caption of the image (required when buttons are provided, markdown allowed).
footer –
The footer of the message (if buttons are provided, optional, markdown has no effect).
buttons – The buttons to send with the image (optional).
reply_to_message_id – The message ID to reply to (optional, only works if buttons provided).
mime_type – The mime type of the image (optional, required when sending an image as bytes or a file object, or file path that does not have an extension).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent image message.

Video messages display a thumbnail preview of a video image with an optional caption. When the WhatsApp user taps the preview, it loads the video and displays it to the user.

Only H.264 video codec and AAC audio codec supported. Single audio stream or no audio stream only.
See Video messages.
See Supported video formats.

Example

>>> wa = WhatsApp(...)
>>> wa.send_video(
...     to="1234567890",
...     video="https://example.com/video.mp4",
...     caption="This is a video",
... )

Parameters:

to – The phone ID of the WhatsApp user.
video – The video to send (either a media ID, URL, file path, bytes, or an open file object. When buttons are provided, only URL is supported).
caption –
The caption of the video (required when sending a video with buttons, markdown allowed).
footer –
The footer of the message (if buttons are provided, optional, markdown has no effect).
buttons – The buttons to send with the video (optional).
reply_to_message_id – The message ID to reply to (optional, only works if buttons provided).
mime_type – The mime type of the video (optional, required when sending a video as bytes or a file object, or file path that does not have an extension).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent video.

Audio messages display an audio icon and a link to an audio file. When the WhatsApp user taps the icon, the WhatsApp client loads and plays the audio file.

See Audio messages.
See Supported audio formats.

Example

>>> wa = WhatsApp(...)
>>> wa.send_audio(
...     to='1234567890',
...     audio='https://example.com/audio.mp3',
... )

Parameters:

to – The phone ID of the WhatsApp user.
audio – The audio file to send (either a media ID, URL, file path, bytes, or an open file object).
mime_type – The mime type of the audio file (optional, required when sending an audio file as bytes or a file object, or file path that does not have an extension).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent audio file.

Document messages are messages that display a document icon, linked to a document, that a WhatsApp user can tap to download.

See Document messages.
See Supported document types.

Example

>>> wa = WhatsApp(...)
>>> wa.send_document(
...     to="1234567890",
...     document="https://example.com/example_123.pdf",
...     filename="example.pdf",
...     caption="Example PDF"
... )

Parameters:

to – The phone ID of the WhatsApp user.
document – The document to send (either a media ID, URL, file path, bytes, or an open file object. When buttons are provided, only URL is supported).
filename – Document filename, with extension. The WhatsApp client will use an appropriate file type icon based on the extension.
caption –
The caption of the document (required when sending a document with buttons, markdown allowed).
footer –
The footer of the message (if buttons are provided, optional, markdown has no effect).
buttons – The buttons to send with the document (optional).
reply_to_message_id – The message ID to reply to (optional, only works if buttons provided).
mime_type – The mime type of the document (optional, required when sending a document as bytes or a file object, or file path that does not have an extension).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent document.

Location messages allow you to send a location’s latitude and longitude coordinates to a WhatsApp user.

Read more about Location messages.

Example

>>> wa = WhatsApp(...)
>>> wa.send_location(
...     to='1234567890',
...     latitude=37.4847483695049,
...     longitude=--122.1473373086664,
...     name='WhatsApp HQ',
...     address='Menlo Park, 1601 Willow Rd, United States',
... )

Parameters:

to – The phone ID of the WhatsApp user.
latitude – The latitude of the location.
longitude – The longitude of the location.
name – The name of the location (optional).
address – The address of the location (optional).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent location.

Location request messages display body text and a send location button. When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location.

Once the user shares their location, a Message update is triggered, containing the user’s location details.
Read more about Location request messages.

Example

>>> wa = WhatsApp(...)
>>> wa.request_location(
...     to='1234567890',
...     text='Please share your location with us.',
... )

Parameters:

to – The phone ID of the WhatsApp user.
text – The text to send with the button.
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Contacts messages allow you to send rich contact information directly to WhatsApp users, such as names, phone numbers, physical addresses, and email addresses. When a WhatsApp user taps the message’s profile arrow, it displays the contact’s information in a profile view:

Each message can include information for up to 257 contacts, although it is recommended to send fewer for usability and negative feedback reasons.
See Contacts messages.

Example

>>> from pywa.types import Contact
>>> wa = WhatsApp(...)
>>> wa.send_contact(
...     to='1234567890',
...     contact=Contact(
...         name=Contact.Name(formatted_name='David Lev', first_name='David'),
...         phones=[Contact.Phone(phone='1234567890', wa_id='1234567890', type='MOBILE')],
...         emails=[Contact.Email(email='test@test.com', type='WORK')],
...         urls=[Contact.Url(url='https://exmaple.com', type='HOME')],
...      )
... )

Parameters:

to – The phone ID of the WhatsApp user.
contact – The contact/s to send.
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Sticker messages display animated or static sticker images in a WhatsApp message.

A static sticker needs to be 512x512 pixels and cannot exceed 100 KB.
An animated sticker must be 512x512 pixels and cannot exceed 500 KB.
See Sticker messages.
See Supported sticker formats.

Example

>>> wa = WhatsApp(...)
>>> wa.send_sticker(
...     to='1234567890',
...     sticker='https://example.com/sticker.webp',
... )

Parameters:

to – The phone ID of the WhatsApp user.
sticker – The sticker to send (either a media ID, URL, file path, bytes, or an open file object).
mime_type – The mime type of the sticker (optional, required when sending a sticker as bytes or a file object, or file path that does not have an extension).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Catalog messages are messages that allow you to showcase your product catalog entirely within WhatsApp.

Catalog messages display a product thumbnail header image of your choice, custom body text, a fixed text header, a fixed text sub-header, and a View catalog button.

When a customer taps the View catalog button, your product catalog appears within WhatsApp.
You must have inventory uploaded to Meta in an ecommerce catalog connected to your WhatsApp Business Account.
Read more about Catalog messages.

Example

>>> wa = WhatsApp(...)
>>> wa.send_catalog(
...     to='1234567890',
...     body='Check out our catalog!',
...     footer='Powered by PyWa',
...     thumbnail_product_sku='SKU123',
... )

Parameters:

to – The phone ID of the WhatsApp user.
body – Text to appear in the message body (up to 1024 characters).
footer – Text to appear in the footer of the message (optional, up to 60 characters).
thumbnail_product_sku – Item SKU number. Labeled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the message’s header image. If omitted, the product image of the first item in your catalog will be used.
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Send a template to a WhatsApp user.

To create a template, use create_template().
Read more about Template Messages.

Example:

from pywa.types.templates import *

wa = WhatsApp(...)
wa.send_template(
    to='1234567890',
    name='seasonal_promotion',
    language=TemplateLanguage.ENGLISH_US,
    params=[
        BodyText.params(text='Our {{season}} sale is on!', season='Summer'),
        CopyCodeButton.params(coupon_code="25OFF", index=0)
    ],
)

from pywa.types.templates import *

t = Template(
    name='seasonal_promotion',
    category=TemplateCategory.MARKETING,
    language=TemplateLanguage.ENGLISH_US,
    parameter_format=ParamFormat.NAMED,
    components=[
        header := HeaderText(text='Our {{sale_name}} is on!', sale_name='Summer Sale'),
        body := BodyText(
            text='Shop now through {{end_date}} and use code {{discount_code}} to get {{discount_amount}} off of all merchandise.',
            end_date='the end of August', discount_code='25OFF', discount_amount='25%'
        ),
        FooterText(text='Use the buttons below to manage your marketing subscriptions'),
        Buttons(
            buttons=[
                uns_from_promos := QuickReplyButton(text='Unsubscribe from Promos'),
                uns_from_all := QuickReplyButton(text='Unsubscribe from All'),
            ]
        ),
    ],
)

wa.create_template(template=t)

wa.send_template(
    to='1234567890',
    name=t.name,
    language=t.language,
    params=[
        header.params(sale_name='Summer Sale'),
        body.params(
            end_date='the end of August',
            discount_code='25OFF',
            discount_amount='25%',
        ),
        uns_from_promos.params(callback_data='uns_from_promos'),
        uns_from_all.params(callback_data='uns_from_all'),
    ],
)

Parameters:

to – The phone ID of the WhatsApp user.
name – The name of the template to send.
language – The language of the template to send.
params – The parameters to fill in the template.
use_mm_lite_api – Whether to use Marketing Messages Lite API (optional, default: False).
message_activity_sharing – Whether to share message activities (e.g. message read) for that specific marketing message to Meta to help optimize marketing messages (optional, only if use_mm_lite_api is True).
reply_to_message_id – The ID of the message to reply to (optional).
tracker – A callback data to track the message (optional, can be a string or a CallbackData object).
sender – The phone ID to send the template from (optional, if not provided, the client’s phone ID will be used).

Send a product from a business catalog to a WhatsApp user.

To send multiple products, use send_products().
See Product messages.

Example

>>> wa = WhatsApp(...)
>>> wa.send_product(
...     to='1234567890',
...     catalog_id='1234567890',
...     sku='SKU123',
...     body='Check out this product!',
...     footer='Powered by PyWa',
... )

Parameters:

to – The phone ID of the WhatsApp user.
catalog_id – The ID of the catalog to send the product from. (To get the catalog ID use get_commerce_settings() or in the Commerce Manager).
sku – The product SKU to send.
body – Text to appear in the message body (up to 1024 characters).
footer – Text to appear in the footer of the message (optional, up to 60 characters).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Send products from a business catalog to a WhatsApp user.

To send a single product, use send_product().
See Product messages.

Example

>>> from pywa.types import ProductsSection
>>> wa = WhatsApp(...)
>>> wa.send_products(
...     to='1234567890',
...     catalog_id='1234567890',
...     title='Tech Products',
...     body='Check out our products!',
...     product_sections=[
...         ProductsSection(
...             title='Smartphones',
...             skus=['IPHONE12', 'GALAXYS21'],
...         ),
...         ProductsSection(
...             title='Laptops',
...             skus=['MACBOOKPRO', 'SURFACEPRO'],
...         ),
...     ],
...     footer='Powered by PyWa',
... )

Parameters:

to – The phone ID of the WhatsApp user.
catalog_id –
The ID of the catalog to send the product from (To get the catalog ID use get_commerce_settings() or in the Commerce Manager).
product_sections – The product sections to send (up to 30 products across all sections).
title – The title of the product list (up to 60 characters).
body – Text to appear in the message body (up to 1024 characters).
footer – Text to appear in the footer of the message (optional, up to 60 characters).
reply_to_message_id – The message ID to reply to (optional).
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The sent message.

Reaction messages are emoji-reactions that you can apply to a previous WhatsApp user message that you have received.

When sending a reaction message, only a MessageStatus update (type set to SENT) will be triggered; DELIVERED and READ updates will not be triggered.
You can react to incoming messages by using the react() method on every update.

>>> wa = WhatsApp(...)
>>> @wa.on_message()
... def message_handler(_: WhatsApp, msg: Message):
...     msg.react('👍')

Example

>>> wa = WhatsApp(...)
>>> wa.send_reaction(
...     to='1234567890',
...     emoji='👍',
...     message_id='wamid.XXX='
... )

Parameters:

to – The phone ID of the WhatsApp user.
emoji – The emoji to react with.
message_id – The message ID to react to.
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The message ID of the reaction (You can’t use this message id to remove the reaction or perform any other action on it. instead, use the message ID of the message you reacted to).

Remove reaction from a message.

You can remove reactions from incoming messages by using the unreact() method on every update.

>>> wa = WhatsApp(...)
>>> @wa.on_message()
... def message_handler(_: WhatsApp, msg: Message):
...     msg.unreact()

Example

>>> wa = WhatsApp(...)
>>> wa.remove_reaction(
...     to='1234567890',
...     message_id='wamid.XXX='
... )

Parameters:

to – The phone ID of the WhatsApp user.
message_id – The message ID to remove the reaction from.
tracker – The data to track the message with (optional, up to 512 characters, for complex data You can use CallbackData).
sender – The phone ID to send the message from (optional, overrides the client’s phone ID).

Returns:

The message ID of the reaction (You can’t use this message id to re-react or perform any other action on it. instead, use the message ID of the message you unreacted to).

WhatsApp.mark_message_as_read(message_id: str, *, sender: str | int | None = None) → SuccessResult#

When you get a Message, you can use the msg.id value to mark the message as read.

You can mark incoming messages as read by using the mark_as_read() method or indicate typing by using the indicate_typing() method on every update.
It’s good practice to mark an incoming messages as read within 30 days of receipt. Marking a message as read will also mark earlier messages in the thread as read.
Read more about Mark messages as read.

Example

>>> wa = WhatsApp(...)
>>> wa.mark_message_as_read(message_id='wamid.XXX=')

Parameters:

message_id – The message ID to mark as read.
sender – The phone ID (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the message was marked as read.

WhatsApp.indicate_typing(message_id: str, *, sender: str | int | None = None) → SuccessResult#

When you get a Message, you can use the msg.id value to mark the message as read and display a typing indicator so the WhatsApp user knows you are preparing a response. This is good practice if it will take you a few seconds to respond.

You can indicate typing by using the indicate_typing() method on every update.
The typing indicator will be dismissed once you respond, or after 25 seconds, whichever comes first. To prevent a poor user experience, only display a typing indicator if you are going to respond.
Read more about Typing indicators.

Parameters:

message_id – The message ID to mark as read and display a typing indicator.
sender – The phone ID (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the message was marked as read and the typing indicator was displayed.

WhatsApp.listen(to: BaseListenerIdentifier, *, filters: Filter = None, cancelers: Filter = None, timeout: float | None = None) → BaseUpdate#

Listen to an update.

You can use one of the shortcuts to listen to a specific update type:
- wait_for_reply()
- wait_for_click()
- wait_for_selection()
- wait_for_completion()
- wait_until_read()
- wait_until_delivered()
- wait_until_approved()

Example

try:
    wa.send_message(
        to="123456",
        text="Send me a message",
        buttons=[Button(title="Cancel", callback_data="cancel")]
    )
    update: Message = wa.listen(
        to=UserUpdateListenerIdentifier(sender="123456", recipient="654321"),
        filters=filters.message & filters.text,
        cancelers=filters.callback_button & filters.matches("cancel"),
        timeout=10
    )
    print(update)
except ListenerTimeout:
    print("Listener timed out")
except ListenerCanceled:
    print("Listener was canceled")
except ListenerStopped:
    print("Listener was stopped")

Parameters:

to – The identifier of the update to listen to.
filters – The filters to apply to the update, return the update if the filters pass.
cancelers – The filters to cancel the listening, raise ListenerCanceled if the update matches.
timeout – The time to wait for the update, raise ListenerTimeout if the time passes

Returns:

The update that passed the filters

Raises:

ListenerTimeout – If the listener timed out
ListenerCanceled – If the listener was canceled by a filter
ListenerStopped – If the listener was stopped manually

WhatsApp.stop_listening(to: BaseListenerIdentifier, *, reason: str | None = None) → None#

Stop listening to updates for a specific listener

Raising ListenerStopped to the listener

Parameters:

to – The identifier of the listener to stop
reason – The reason to stop listening

Raises:

ValueError – If the listener does not exist

Upload media to WhatsApp servers.

All media files sent through this endpoint are encrypted and persist for 30 days, unless they are deleted earlier.
You can get media URL with get_media_url() and download it with download_media() or delete it with delete_media().
See Upload media.
See Supported media types.

Example

>>> wa = WhatsApp(...)
>>> wa.upload_media(
...     media='https://example.com/image.jpg',
...     mime_type='image/jpeg',
... )

Parameters:

media – The media to upload (can be a URL, bytes, or a file path).
mime_type – The MIME type of the media (required if media is bytes or a file path).
filename – The file name of the media (required if media is bytes).
dl_session – A httpx client to use when downloading the media from a URL (optional, if not provided, a new session will be created).
phone_id – The phone ID to upload the media to (optional, if not provided, the client’s phone ID will be used).

Returns:

The media ID.

Raises:

ValueError –

If provided media is file path and the file does not exist. - If provided media is URL and the URL is invalid or media cannot be downloaded. - If provided media is bytes and filename or mime_type is not provided.

WhatsApp.download_media(*, url: str, path: str | Path | None = None, filename: str | None = None, in_memory: bool = False, **httpx_kwargs: Any) → Path | bytes#

Download a media file from WhatsApp servers.

See Download media.

Example

>>> wa = WhatsApp(...)
>>> wa.download_media(
...     url='https://mmg-fna.whatsapp.net/d/f/Amc.../v2/1234567890',
...     path='/home/david/Downloads',
...     filename='image.jpg',
... )

Parameters:

url – The URL of the media file (from get_media_url()).
path – The path where to save the file (if not provided, the current working directory will be used).
filename – The name of the file (if not provided, it will be guessed from the URL + extension).
in_memory – Whether to return the file as bytes instead of saving it to disk (default: False).
**httpx_kwargs – Additional arguments to pass to httpx.get().

Returns:

The path of the saved file if in_memory is False, the file as bytes otherwise.

WhatsApp.get_media_url(media_id: str) → MediaUrlResponse#

Get a media URL for a media ID.

Note that clicking this URL (i.e. performing a generic GET) will not return the media; you must include an access token. Use the download_media() method to download the media.
The media can be downloaded directly from the message using the download_media() method.
The URL is valid for 5 minutes.
See Retrieve Media URL.

Example

>>> wa = WhatsApp(...)
>>> wa.get_media_url(media_id='wamid.XXX=')

Parameters:: media_id – The media ID.
Returns:: A MediaResponse object with the media URL.

WhatsApp.delete_media(media_id: str, *, phone_id: str | int | None = <object object>) → SuccessResult#

Delete a media file from WhatsApp servers.

See Delete media.

Example

>>> wa = WhatsApp(...)
>>> wa.delete_media(media_id='wamid.XXX=')

Parameters:

media_id – The media ID to delete.
phone_id – The phone ID to delete the media from (optional, If included, the operation will only be processed if the ID matches the ID of the business phone number that the media was uploaded on. pass None to use the client’s phone ID).

Returns:

Whether the media was deleted successfully.

WhatsApp.get_business_account(*, waba_id: str | int | None = None) → WhatsAppBusinessAccount#

Get the WhatsApp Business Account (WABA) information.

Parameters:: waba_id – The WABA ID to get the information from (optional, if not provided, the client’s WABA ID will be used).
Returns:: The WhatsApp Business Account object.

WhatsApp.get_business_profile(*, phone_id: str | int | None = None) → BusinessProfile#

Get the business profile of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> wa.get_business_profile()

Parameters:: phone_id – The phone ID to get the business profile from (optional, if not provided, the client’s phone ID will be used).
Returns:: The business profile.

WhatsApp.get_business_phone_numbers(*, waba_id: str | int | None = None, pagination: Pagination | None = None) → Result[BusinessPhoneNumber]#

Get the phone numbers of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> wa.get_business_phone_numbers()

Parameters:

waba_id – The WABA ID to get the phone numbers from (optional, if not provided, the client’s WABA ID will be used).
pagination – Pagination object to paginate through the results (optional).

Returns:

A Result object containing BusinessPhoneNumber objects.

WhatsApp.get_business_phone_number(*, phone_id: str | int | None = None) → BusinessPhoneNumber#

Get the phone number of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> wa.get_business_phone_number()

Parameters:: phone_id – The phone ID to get the phone number from (optional, if not provided, the client’s phone ID will be used).
Returns:: The phone number object.

WhatsApp.get_business_phone_number_settings(*, include_sip_credentials: bool | None = None, phone_id: str | int | None = None) → BusinessPhoneNumberSettings#

Get the settings of the WhatsApp Business phone number.

Example

>>> wa = WhatsApp(...)
>>> wa.get_business_phone_number_settings()

Parameters:

include_sip_credentials – Whether to include SIP credentials in the response (optional, default: False).
phone_id – The phone ID to get the settings from (optional, if not provided, the client’s phone ID will be used).

Returns:

The business phone number settings.

WhatsApp.update_business_phone_number_settings(settings: BusinessPhoneNumberSettings, *, phone_id: str | int | None = None) → SuccessResult#

Update the settings of the WhatsApp Business phone number.

Example

>>> from pywa.types.calls import CallingSettingsStatus
>>> wa = WhatsApp(...)
>>> s = wa.get_business_phone_number_settings()
>>> s.calling.status = CallingSettingsStatus.ENABLED
>>> wa.update_business_phone_number_settings(settings)

Parameters:

settings – The new settings to update.
phone_id – The phone ID to update the settings for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the settings were updated successfully.

WhatsApp.update_business_profile(about: str | None = <object object>, address: str | None = <object object>, description: str | None = <object object>, email: str | None = <object object>, profile_picture_handle: str | None = <object object>, industry: ~pywa.types.others.Industry | None = <object object>, websites: ~typing.Iterable[str] | None = <object object>, *, phone_id: str | int | None = None) → SuccessResult#

Update the business profile of the WhatsApp Business account.

Example

>>> from pywa.types import Industry
>>> wa = WhatsApp(...)
>>> wa.update_business_profile(
...     about='This is a test business',
...     address='Menlo Park, 1601 Willow Rd, United States',
...     description='This is a test business',
...     email='test@test.com',
...     profile_picture_handle='1234567890',
...     industry=Industry.NOT_A_BIZ,
...     websites=('https://example.com', 'https://google.com'),
... )

Parameters:

about –
The business’s About text. This text appears in the business’s profile, beneath its profile image, phone number, and contact buttons. (cannot be empty. must be between 1 and 139 characters. markdown is not supported. Hyperlinks can be included but will not render as clickable links.)
address – Address of the business. Character limit 256.
description – Description of the business. Character limit 512.
email – The contact email address (in valid email format) of the business. Character limit 128.
profile_picture_handle – Handle of the profile picture. This handle is generated when you upload the binary file for the profile picture to Meta using the Resumable Upload API.
industry – Industry of the business.
websites – The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. (You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 256 characters each.)
phone_id – The phone ID to update the business profile for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the business profile was updated.

WhatsApp.update_display_name(new_display_name: str, *, phone_id: str | int | None = None) → SuccessResult#

Update the display name of the WhatsApp Business account.

The display name is the name that appears in the WhatsApp app for your business.
The display name will undergo verification by WhatsApp, and you will receive a webhook notification when the verification is complete.
Read more about Display Name Verification.

Example

>>> wa = WhatsApp(...)
>>> wa.update_display_name()

Parameters:

new_display_name – The new display name.
phone_id – The phone ID to update the display name for (optional, if not provided, the client’s phone ID will be used).

WhatsApp.update_conversational_automation(enable_chat_opened: bool, ice_breakers: Iterable[str] | None = None, commands: Iterable[Command] | None = None, *, phone_id: str | int | None = None) → SuccessResult#

Update the conversational automation settings of the WhatsApp Business account.

You can receive the current conversational automation settings using get_business_phone_number() and accessing the conversational_automation attribute.
Read more about Conversational Automation.

Parameters:

enable_chat_opened – You can be notified whenever a WhatsApp user opens a chat with you for the first time. This can be useful if you want to reply to these users with a special welcome message of your own design (When enabled, you’ll start receiving the ChatOpened event).
ice_breakers – Ice Breakers are customizable, tappable text strings that appear in a message thread the first time you chat with a user. For example, Plan a trip or Create a workout plan.
commands – Commands are text strings that WhatsApp users can see by typing a forward slash in a message thread with your business.
phone_id – The phone ID to update the conversational automation settings for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the conversational automation settings were updated.

WhatsApp.set_business_public_key(public_key: str, *, phone_id: str | int | None = None) → SuccessResult#

Set the business public key of the WhatsApp Business account (required for end-to-end encryption in flows)

Parameters:

public_key – An public 2048-bit RSA Key in PEM format.
phone_id – The phone ID to set the business public key for (optional, if not provided, the client’s phone ID will be used).

Example

>>> wa = WhatsApp(...)
>>> wa.set_business_public_key(
...     public_key="""-----BEGIN PUBLIC KEY-----..."""
... )

Returns:: Whether the business public key was set.

WhatsApp.get_commerce_settings(*, phone_id: str | int | None = None) → CommerceSettings#

Get the commerce settings of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> wa.get_commerce_settings()

Returns:: The commerce settings.

WhatsApp.update_commerce_settings(is_catalog_visible: bool = None, is_cart_enabled: bool = None, *, phone_id: str | int | None = None) → SuccessResult#

Update the commerce settings of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> wa.update_commerce_settings(
...     is_catalog_visible=True,
...     is_cart_enabled=True,
... )

Parameters:

is_catalog_visible – Whether the catalog is visible (optional).
is_cart_enabled – Whether the cart is enabled (optional).
phone_id – The phone ID to update the commerce settings for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the commerce settings were updated.

Raises:

ValueError – If no arguments are provided.

Create a template for the WhatsApp Business account.

WhatsApp Business Accounts can only create 100 message templates per hour.
Read more about Create and Manage Templates.

Example:

from pywa.types import template as t

wa = WhatsApp(..., business_account_id='1234567890')

created = wa.create_template(
    template=t.Template(
        name='seasonal_promotion',
        category=t.TemplateCategory.MARKETING,
        language=t.TemplateLanguage.ENGLISH_US,
        parameter_format=t.ParamFormat.NAMED,
        components=[
            t.HeaderText(text='Our {{sale_name}} is on!', sale_name='Summer Sale'),
            t.BodyText(
                text='Shop now through {{end_date}} and use code {{discount_code}} to get {{discount_amount}} off of all merchandise.',
                end_date='the end of August', discount_code='25OFF', discount_amount='25%'
            ),
            t.FooterText(text='Use the buttons below to manage your marketing subscriptions'),
            t.Buttons(
                buttons=[
                    t.QuickReplyButton(text='Unsubscribe from Promos'),
                    t.QuickReplyButton(text='Unsubscribe from All'),
                ]
            ),
        ],
    ),

    print('Template created:', created.id, created.status)

Parameters:

template – The template to create.
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID, optional).
app_id – The App ID to upload the template header example media to (optional, if not provided, the client’s app ID will be used).

Returns:

The created template.

WhatsApp.upsert_authentication_template(*, name: str, languages: Iterable[TemplateLanguage], otp_button: BaseOTPButton, add_security_recommendation: bool | None = None, code_expiration_minutes: int | None = None, message_send_ttl_seconds: int | None = None, waba_id: str | int | None = None) → CreatedTemplates#

Bulk update or create authentication templates in multiple languages that include or exclude the optional security and expiration warnings.

If a template already exists with a matching name and language, the template will be updated with the contents of the request, otherwise, a new template will be created.
You can’t provide the text or autofill_text properties for the OTP Buttons. It will be automatically set to a pre-set value localized to the template’s language. For example, Copy Code for English (US) and Autofill for English (US).
Read more at developers.facebook.com.
Read more about Authentication Templates.

Example

>>> from pywa.types.templates import *
>>> wa = WhatsApp(...)
>>> templates = wa.upsert_authentication_template(
...     name='one_tap_authentication',
...     languages=[TemplateLanguage.ENGLISH_US, TemplateLanguage.FRENCH, TemplateLanguage.SPANISH],
...     otp_button=OneTapOTPButton(supported_apps=...),
...     add_security_recommendation=True,
...     code_expiration_minutes=5,
... )
... for template in templates:
...     print(f'Template {template.id} created with status {template.status}')

Parameters:

name – The name of the template (should be unique, maximum 512 characters).
languages – A list of languages and locale codes to create or update the template in (See Supported Languages).
otp_button – A OneTapOTPButton, ZeroTapOTPButton, or CopyCodeOTPButton button.
add_security_recommendation – Boolean value to add information to the template about not sharing authentication codes with anyone.
code_expiration_minutes – Integer value to add information to the template on when the code will expire.
message_send_ttl_seconds – The time-to-live (TTL) for the template message in seconds. (See Time-to-live (TTL)).
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID, optional).

Returns:

A CreatedTemplates object containing the created or updated templates.

Update an existing template.

Only templates with an APPROVED, REJECTED, or PAUSED status can be edited.
You cannot edit the category of an approved template.
Approved templates can be edited up to 10 times in a 30 day window, or 1 time in a 24 hour window. Rejected or paused templates can be edited an unlimited number of times.
After editing an approved or paused template, it will automatically be approved unless it fails template review.
Read more at developers.facebook.com.

Parameters:

template_id – The ID of the template to update.
new_category – The new category of the template (optional, cannot be changed for approved templates).
new_components – The new components of the template (optional, if not provided, the existing components will be used).
new_message_send_ttl_seconds – The new message send TTL in seconds (optional, if not provided, the existing TTL will be used).
new_parameter_format – The new parameter format (optional, if not provided, the existing format will be used).
app_id – The App ID to upload the template header example media to (optional, if not provided, the client’s app ID will be used).

Returns:

Whether the template was updated successfully.

WhatsApp.get_template(template_id: int | str) → TemplateDetails#

Get the details of a specific template.

Parameters:: template_id – The ID of the template to retrieve.
Returns:: A TemplateDetails object containing the template details.

Get templates of the WhatsApp Business account.

Example

>>> wa = WhatsApp(...)
>>> templates = wa.get_templates(
...     statuses=[TemplateStatus.APPROVED],
...     categories=[TemplateCategory.MARKETING],
...     languages=[TemplateLanguage.ENGLISH_US],
...     pagination=Pagination(limit=10)
... )

Parameters:

statuses – The statuses of the templates to filter by (optional).
categories – The categories of the templates to filter by (optional).
languages – The languages of the templates to filter by (optional).
name – The name (or part of it) of the template to filter by (optional).
content – The content of the template to filter by (optional).
name_or_content – The name or content of the template to filter by (optional).
quality_scores – The quality scores of the templates to filter by (optional).
pagination – Pagination parameters (optional).
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID, optional).

Returns:

A Result object containing the templates

WhatsApp.delete_template(template_name: str, *, template_id: int | str | None = None, waba_id: str | int | None = None) → SuccessResult#

Delete a template.

If you delete a template that has been sent in a template message but has yet to be delivered (e.g. because the customer’s phone is turned off), the template’s status will be set to PENDING_DELETION and we will attempt to deliver the message for 30 days. After this time you will receive a “Structure Unavailable” error and the customer will not receive the message.
Names of an approved template that has been deleted cannot be used again for 30 days.
Deleting a template by name deletes all templates that match that name (meaning templates with the same name but different languages will also be deleted).
To delete a template by ID, include the template’s ID along with its name in your request; only the template with the matching template ID will be deleted.
Read more at developers.facebook.com.

Parameters:

template_name – The name of the template to delete.
template_id – The ID of the template to delete (optional, if provided, only the template with the matching ID will be deleted).
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID, optional).

Returns:

Whether the template was deleted successfully.

WhatsApp.unpause_template(template_id: int | str) → TemplateUnpauseResult#

Unpause a template that has been paused due to pacing.

You must wait 5 minutes after a template has been paused as a result of pacing before calling this method.
Read more at developers.facebook.com.

Parameters:: template_id – The ID of the template to unpause.
Returns:: A TemplateUnpauseResult object containing the result of the unpause operation.

WhatsApp.migrate_templates(source_waba_id: str | int, page_number: int | None = None, *, destination_waba_id: str | int | None = None) → MigrateTemplatesResult#

Migrate templates from one WhatsApp Business account to another.

Templates can only be migrated between WABAs owned by the same Meta business.
Only templates with a status of APPROVED and a quality_score of either GREEN or UNKNOWN are eligible for migration.
Read more at developers.facebook.com.

Parameters:

source_waba_id – The WhatsApp Business account ID to migrate templates from.
page_number – Indicates amount of templates to migrate as sets of 500. Zero-indexed. For example, to migrate 1000 templates, send one request with this value set to 0 and another request with this value set to 1, in parallel.
destination_waba_id – The WhatsApp Business account ID to migrate templates to (optional, overrides the client’s business account ID).

Returns:

A MigrateTemplatesResult object containing the migration results.

Create a flow.

This method requires the WhatsApp Business account ID to be provided when initializing the client.
New Flows are created in FlowStatus.DRAFT status unless flow_json is provided and publish is True.
To update the flow json, use update_flow().
To send a flow, use send_flow().

Parameters:

name – The name of the flow (must be unique, can be used later to update and send the flow).
categories – The categories of the flow.
flow_json – The JSON of the flow (optional, if provided, the flow will be created with the provided JSON).
publish – Whether to publish the flow after creating it, only works if flow_json is provided.
clone_flow_id – The flow ID to clone (optional).
endpoint_uri – The URL of the FlowJSON Endpoint. Starting from Flow 3.0 this property should be specified only gere. Do not provide this field if you are cloning a Flow with version below 3.0.
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID).

Example

>>> from pywa.types.flows import *
>>> wa = WhatsApp(...)
>>> wa.create_flow(
...     name='Feedback',
...     categories=[FlowCategory.SURVEY, FlowCategory.OTHER],
...     flow_json=FlowJSON(...),
...     publish=True,
... )

Returns:: The created flow.
Raises:: FlowBlockedByIntegrity – If you can’t create a flow because of integrity issues.

Update the metadata of a flow.

Parameters:

flow_id – The flow ID.
name – The name of the flow (optional).
categories – The new categories of the flow (optional).
endpoint_uri – The URL of the FlowJSON Endpoint. Starting from FlowJSON 3.0 this property should be specified only gere. Do not provide this field if you are cloning a FlowJSON with version below 3.0.
application_id – The ID of the Meta application which will be connected to the Flow. All the flows with endpoints need to have an Application connected to them.

Example

>>> from pywa.types.flows import FlowCategory
>>> wa = WhatsApp(...)
>>> wa.update_flow_metadata(
...     flow_id='1234567890',
...     name='Feedback',
...     categories=[FlowCategory.SURVEY, FlowCategory.OTHER],
...     endpoint_uri='https://my-api-server/feedback_flow',
...     application_id=1234567890,
... )

Returns:: Whether the flow was updated.
Raises:: ValueError – If neither of the arguments is provided.

Update the json of a flow.

Parameters:

flow_id – The flow ID.
flow_json – The new json of the flow. Can be a FlowJSON object, dict, json string, json file path or json bytes.

Examples

>>> wa = WhatsApp(...)

Using a Flow object:

>>> from pywa.types.flows import *
>>> wa.update_flow_json(
...     flow_id='1234567890',
...     flow_json=FlowJSON(version='2.1', screens=[Screen(...)])
... )

From a json file path:

>>> wa.update_flow_json(
...     flow_id='1234567890',
...     flow_json="/home/david/feedback_flow.json"
... )

From a json string:

>>> wa.update_flow_json(
...     flow_id='1234567890',
...     flow_json="""{"version": "2.1", "screens": [...]}"""
... )

Returns:: A tuple of (success, validation_errors).
Raises:: FlowUpdatingError – If the flow json is invalid or the flow is already published.

WhatsApp.publish_flow(flow_id: str | int) → SuccessResult#

This request updates the status of the Flow to “PUBLISHED”.

This action is not reversible.
The Flow and its assets become immutable once published.
To update the Flow after that, you must create a new Flow. You specify the existing Flow ID as the clone_flow_id parameter while creating to copy the existing flow.
You can publish your Flow once you have ensured that:
- All validation errors and publishing checks have been resolved.
- The Flow meets the design principles of WhatsApp Flows
- The Flow complies with WhatsApp Terms of Service, the WhatsApp Business Messaging Policy and, if applicable, the WhatsApp Commerce Policy

Parameters:: flow_id – The flow ID.
Returns:: Whether the flow was published.
Raises:: FlowPublishingError – If the flow has validation errors or not all publishing checks have been resolved.

WhatsApp.delete_flow(flow_id: str | int) → SuccessResult#

While a Flow is in DRAFT status, it can be deleted.

Parameters:: flow_id – The flow ID.
Returns:: Whether the flow was deleted.
Raises:: FlowDeletingError – If the flow is already published.

WhatsApp.deprecate_flow(flow_id: str | int) → SuccessResult#

Once a Flow is published, it cannot be modified or deleted, but can be marked as deprecated.

Parameters:: flow_id – The flow ID.
Returns:: Whether the flow was deprecated.
Raises:: FlowDeprecatingError – If the flow is not published or already deprecated.

WhatsApp.get_flow(flow_id: str | int, *, invalidate_preview: bool = True, phone_number_id: str | int | None = None) → FlowDetails#

Get the details of a flow.

Parameters:

flow_id – The flow ID.
invalidate_preview – Whether to invalidate the preview (optional, default: True).
phone_number_id – To check that a flow can be used with a specific phone number (optional).

Returns:

The details of the flow.

Get the flows associated with the WhatsApp Business account.

This method requires the WhatsApp Business account ID to be provided when initializing the client.

Parameters:

invalidate_preview – Whether to invalidate the preview (optional, default: True).
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID).
phone_number_id – To check that the flows can be used with a specific phone number (optional).
pagination – The pagination parameters (optional).

Returns:

Result object containing the flows.

Get the metrics of a flow.

Read more at developers.facebook.com.

Parameters:

flow_id – The flow ID.
metric_name – See Available Metrics.
granularity – Time granularity.
since – Start of the time period. If not specified, the oldest allowed date will be used. Oldest allowed date depends on the specified time granularity: DAY - 90 days, HOUR - 30 days.
until – End of the time period. If not specified, the current date will be used.

Returns:

WhatsApp.get_flow_assets(flow_id: str | int, *, pagination: Pagination | None = None) → Result[FlowAsset]#

Get assets attached to a specified Flow.

Parameters:

flow_id – The flow ID.
pagination – The pagination parameters (optional).

Returns:

Result object containing the assets of the flow.

WhatsApp.migrate_flows(source_waba_id: str | int, source_flow_names: Iterable[str], *, destination_waba_id: str | int | None = None) → MigrateFlowsResponse#

Migrate flows from one WhatsApp Business Account to another.

Parameters:

source_waba_id – The source WhatsApp Business Account ID.
source_flow_names – The names of the flows to migrate.
destination_waba_id – The destination WhatsApp Business Account ID (optional, if not provided, the client’s business account ID will be used).

Returns:

The response of the migration request.

WhatsApp.block_users(users: Iterable[str | int], *, phone_id: str | int | None = None) → UsersBlockedResult#

Block users from sending messages to the WhatsApp Business account.

Read more at developers.facebook.com.
You can block users with the block() or block_sender() shortcuts.

When you block a WhatsApp user, the following happens:

The user cannot contact your business or see that you are online.
Your business cannot message the user. If you do, you will encounter an error.
You can only block users that have messaged your business in the last 24 hours.
64k blocklist limit

Example

>>> wa = WhatsApp(...)
>>> res = wa.block_users(users=['1234567890', '0987654321'])
>>> if res.errors: print(res.failed_users)

Parameters:

users – The phone numbers/wa IDs of the users to block.
phone_id – The phone ID to block the users from (optional, if not provided, the client’s phone ID will be used).

Returns:

A UsersBlockedResult object with the status of the block operation.

WhatsApp.unblock_users(users: Iterable[str | int], *, phone_id: str | int | None = None) → UsersUnblockedResult#

Unblock users that were previously blocked from sending messages to the WhatsApp Business account.

Read more at developers.facebook.com.

Example

>>> wa = WhatsApp(...)
>>> res = wa.unblock_users(users=['1234567890', '0987654321'])
>>> print(res.removed_users)

Parameters:

users – The phone numbers/wa IDs of the users to unblock.
phone_id – The phone ID to unblock the users from (optional, if not provided, the client’s phone ID will be used).

Returns:

A UsersUnblockedResult object with the status of the unblock operation.

WhatsApp.get_blocked_users(*, pagination: Pagination | None = None, phone_id: str | int | None = None) → Result[User]#

Get blocked users.

Example

>>> wa = WhatsApp(...)
>>> for user in wa.get_blocked_users(): print(user)

Parameters:

pagination – The pagination parameters (optional).
phone_id – The phone ID to get the list of blocked users from (optional, if not provided, the client’s phone ID will be used).

Returns:

A Result object with the list of blocked users. You can iterate over the result to get the users.

WhatsApp.register_phone_number(pin: int | str, *, data_localization_region: str | None = None, phone_id: str | int | None = None) → SuccessResult#

Read more at developers.facebook.com

Example

>>> wa = WhatsApp(...)
>>> wa.register_phone_number(password='111111', data_localization_region='US')

Parameters:

pin – If your verified business phone number already has two-step verification enabled, set this value to your number’s 6-digit two-step verification PIN. If you cannot recall your PIN, you can uptdate it.
data_localization_region – If included, enables local storage on the business phone number. Value must be a 2-letter ISO 3166 country code (e.g. IN) indicating the country where you want data-at-rest to be stored.
phone_id – The phone ID to register (optional, if not provided, the client’s phone ID will be used).

Returns:

The success of the registration.

WhatsApp.deregister_phone_number(*, phone_id: str | int | None = None) → SuccessResult#

Deregister a Business Phone Number.

Read more at developers.facebook.com

Parameters:: phone_id – The phone ID to deregister (optional, if not provided, the client’s phone ID will be used).
Returns:: The success of the deregistration.

WhatsApp.create_qr_code(prefilled_message: str, image_type: Literal['PNG', 'SVG'] = 'PNG', *, phone_id: str | int | None = None) → QRCode#

Create a QR code for a prefilled message.

Read more at developers.facebook.com

Parameters:

prefilled_message – The prefilled message.
image_type – The type of the image (PNG or SVG. default: PNG).
phone_id – The phone ID to create the QR code for (optional, if not provided, the client’s phone ID will be used).

Returns:

The QR code.

WhatsApp.get_qr_code(code: str, *, image_type: Literal['PNG', 'SVG'] | None = None, phone_id: str | int | None = None) → QRCode | None#

Get a QR code.

Parameters:

code – The QR code.
image_type – The type of the image. if not provided, the image URL will not be returned (faster response).
phone_id – The phone ID to get the QR code for (optional, if not provided, the client’s phone ID will be used).

Returns:

The QR code if found, otherwise None.

WhatsApp.get_qr_codes(*, image_type: Literal['PNG', 'SVG'] | None = None, phone_id: str | int | None = None, pagination: Pagination | None = None) → Result[QRCode]#

Get QR codes associated with the WhatsApp Phone Number.

Parameters:

image_type – The type of the image. If not provided, the image URL will not be returned (faster response).
phone_id – The phone ID to get the QR codes for (optional, if not provided, the client’s phone ID will be used).
pagination – The pagination parameters (optional).

Returns:

Result object containing the QR codes.

WhatsApp.update_qr_code(code: str, prefilled_message: str, *, phone_id: str | int | None = None) → QRCode#

Update a QR code.

Parameters:

code – The QR code.
prefilled_message – The prefilled message.
phone_id – The phone ID to update the QR code for (optional, if not provided, the client’s phone ID will be used).

Returns:

The updated QR code.

WhatsApp.delete_qr_code(code: str, *, phone_id: str | int | None = None) → SuccessResult#

Delete a QR code.

Parameters:

code – The QR code.
phone_id – The phone ID to delete the QR code for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the QR code was deleted.

WhatsApp.get_call_permissions(wa_id: str | int, *, phone_id: str | int | None = None) → CallPermissions#

Get the call permissions for the WhatsApp Business account.

Read more at developers.facebook.com.

Parameters:

wa_id – The WhatsApp ID of the user to get the call permissions for.
phone_id – The phone ID to get the call permissions from (optional, if not provided, the client’s phone ID will be used).

Returns:

The call permissions for the user.

WhatsApp.pre_accept_call(call_id: str, sdp: SessionDescription, *, phone_id: str | int | None = None) → SuccessResult#

Pre-accept a call.

Read more at developers.facebook.com.

In essence, when you pre-accept an inbound call, you are allowing the calling media connection to be established before attempting to send call media through the connection.

When you then call the accept call endpoint, media begins flowing immediately since the connection has already been established

Pre-accepting calls is recommended because it facilitates faster connection times and avoids audio clipping issues.

There is about 30 to 60 seconds after the Call Connect webhook is sent for the business to accept the phone call. If the business does not respond, the call is terminated on the WhatsApp user side with a “Not Answered” notification and a Terminate Webhook is delivered back to you.

Parameters:

call_id – The ID of the call to pre-accept.
sdp – Contains the session description protocol (SDP) type and description language.
phone_id – The phone ID to pre-accept the call from (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the call was pre-accepted.

WhatsApp.accept_call(call_id: str, sdp: SessionDescription, *, tracker: str | CallbackData | None = None, phone_id: str | int | None = None) → SuccessResult#

Connect to a call by providing a call agent’s SDP.

Read more at developers.facebook.com.

You have about 30 to 60 seconds after the Call Connect Webhook is sent to accept the phone call. If your business does not respond, the call is terminated on the WhatsApp user side with a “Not Answered” notification and a Terminate Webhook is delivered back to you.

Parameters:

call_id – The ID of the call to accept.
sdp – Contains the session description protocol (SDP) type and description language.
tracker – The data to track the call with (optional, up to 512 characters, for complex data You can use CallbackData).
phone_id – The phone ID to accept the call from (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the call was accepted.

WhatsApp.reject_call(call_id: str, *, phone_id: str | int | None = None) → SuccessResult#

Reject a call.

Read more at developers.facebook.com.

You have about 30 to 60 seconds after the Call Connect webhook is sent to accept the phone call. If the business does not respond the call is terminated on the WhatsApp user side with a “Not Answered” notification and a Terminate Webhook is delivered back to you.

Parameters:

call_id – The ID of the call to reject.
phone_id – The phone ID to reject the call from (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the call was rejected.

WhatsApp.terminate_call(call_id: str, *, phone_id: str | int | None = None) → SuccessResult#

Terminate an active call.

Read more at developers.facebook.com.

This must be done even if there is an RTCP BYE packet in the media path. Ending the call this way also ensures pricing is more accurate. When the WhatsApp user terminates the call, you do not have to call this endpoint. Once the call is successfully terminated, a Call Terminate Webhook will be sent to you.

Parameters:

call_id – The ID of the call to terminate.
phone_id – The phone ID to terminate the call from (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the call was terminated.

WhatsApp.get_app_access_token(app_id: int, app_secret: str) → str#

Get an access token for an app.

Read more at developers.facebook.com.

Parameters:

app_id – The ID of the app in the App Basic Settings
app_secret – The app secret.

Returns:

The access token.

WhatsApp.set_app_callback_url(app_id: int, app_access_token: str, callback_url: str, verify_token: str, fields: Iterable[str]) → SuccessResult#

Set the callback URL for the webhook.

Read more at developers.facebook.com.

Parameters:

app_id –
The ID of the app in the App Basic Settings
app_access_token – The app access token from get_app_access_token().
callback_url – The URL to receive the webhook.
verify_token – The token to verify the webhook.
fields – The fields to subscribe to. See Available Fields.

Returns:

Whether the callback URL was set.

WhatsApp.override_waba_callback_url(callback_url: str, verify_token: str, *, waba_id: str | int | None = None) → SuccessResult#

Override the callback URL for the WhatsApp Business account.

Read more at developers.facebook.com.

Parameters:

callback_url – The URL to receive the webhook.
verify_token – The token to verify the webhook.
waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID).

Returns:

Whether the callback URL was overridden.

WhatsApp.delete_waba_callback_url(*, waba_id: str | int | None = None) → SuccessResult#

Delete the callback URL for the WhatsApp Business account.

Read more at developers.facebook.com.

Parameters:: waba_id – The WhatsApp Business account ID (Overrides the client’s business account ID).
Returns:: Whether the callback URL was deleted.

WhatsApp.override_phone_callback_url(callback_url: str, verify_token: str, *, phone_id: str | int | None = None) → SuccessResult#

Override the callback URL for the phone.

Read more at developers.facebook.com.
To access to the current webhook configuration use get_business_phone_number() and access the webhook_configuration attribute.

Parameters:

callback_url – The URL to receive the webhook.
verify_token – The token to verify the webhook.
phone_id – The phone ID to override the callback URL for (optional, if not provided, the client’s phone ID will be used).

Returns:

Whether the callback URL was overridden.

WhatsApp.delete_phone_callback_url(*, phone_id: str | int | None = None) → SuccessResult#

Delete the callback URL for the phone.

Read more at developers.facebook.com.

Parameters:: phone_id – The phone ID to delete the callback URL for (optional, if not provided, the client’s phone ID will be used).
Returns:: Whether the callback URL was deleted.

WhatsApp.webhook_update_handler(update: bytes, hmac_header: str = None) → tuple[str, int]#

Handle the incoming update from the webhook manually.

Use this function only if you are using a custom server (e.g. Django etc.).

Parameters:

update – The incoming raw update from the webhook (bytes)
hmac_header – The X-Hub-Signature-256 header (to validate the signature, use utils.HUB_SIG for the key).

Returns:

A tuple containing the response and the status code.

WhatsApp.webhook_challenge_handler(vt: str, ch: str) → tuple[str, int]#

Handle the verification challenge from the webhook manually.

Use this function only if you are using a custom server (e.g. Django etc.).

Parameters:

vt – The verify token param (utils.HUB_VT).
ch – The challenge param (utils.HUB_CH).

Returns:

A tuple containing the challenge and the status code.

WhatsApp.get_flow_request_handler(endpoint: str, callback: Callable[[WhatsApp, FlowRequest], FlowResponse | dict | None | Awaitable[FlowResponse | dict | None]], acknowledge_errors: bool = True, private_key: str | None = None, private_key_password: str | None = None, request_decryptor: Callable[[str, str, str, str, str | None], tuple[dict, bytes, bytes]] | None = None, response_encryptor: Callable[[dict, bytes, bytes], str] | None = None) → FlowRequestCallbackWrapper#

Get a function that handles the incoming flow requests.

Use this function only if you are using a custom server (e.g. Django etc.), else use the WhatsApp.on_flow_request() decorator.

Parameters:

endpoint – The endpoint to listen to (The endpoint uri you set to the flow. e.g /feedback_flow).
callback – The callback function to call when a flow request is received.
acknowledge_errors – Whether to acknowledge errors (The return value of the callback will be ignored, and pywa will acknowledge the error automatically).
private_key – The private key to use to decrypt the requests (Override the global business_private_key).
private_key_password – The password to use to decrypt the private key (Override the global business_private_key_password).
request_decryptor – The function to use to decrypt the requests (Override the global flows_request_decryptor)
response_encryptor – The function to use to encrypt the responses (Override the global flows_response_encryptor)

Returns:

A function that handles the incoming flow request and returns (response, status_code).

WhatsApp.load_handlers_modules(*modules: ModuleType) → None#

Load handlers from modules.

Example

my_handlers.py#

from pywa import WhatsApp, types, filters as fil

@WhatsApp.on_message(fil.text)
def on_text_message(wa: WhatsApp, msg: types.Message):
    ...

@WhatsApp.on_callback_button
def on_callback_button(wa: WhatsApp, msg: types.CallbackButton):
    ...

main.py#

from pywa import WhatsApp
from . import my_handlers

wa = WhatsApp(..., handlers_modules=[my_handlers])

Client Reference

Contents

Client Reference#