Client Reference

Client Reference#

Send a message to a WhatsApp user.

Example

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

Example with keyboard buttons:

>>> from pywa.types import Button
>>> wa = WhatsApp(...)
>>> wa.send_message(
...     to="1234567890",
...     header="Hello from PyWa!",
...     text="What can I help you with?",
...     footer="Powered by PyWa",
...     keyboard=[
...         Button("Help", data="help"),
...         Button("About", data="about"),
...     ],
... )

Example with a section list:

>>> from pywa.types import SectionList, Section, SectionRow
>>> wa = WhatsApp(...)
>>> wa.send_message(
...     to="1234567890",
...     header="Hello from PyWa!",
...     text="What can I help you with?",
...     footer="Powered by PyWa",
...     keyboard=SectionList(
...         button_title="Choose an option",
...         sections=[
...             Section(
...                 title="Help",
...                 rows=[
...                     SectionRow(
...                         title="Help",
...                         callback_data="help",
...                         description="Get help with PyWa",
...                     ),
...                     SectionRow(
...                         title="About",
...                         callback_data="about",
...                         description="Learn more about PyWa",
...                     ),
...                 ],
...             ),
...            Section(
...                 title="Other",
...                 rows=[
...                     SectionRow(
...                         title="GitHub",
...                         callback_data="github",
...                         description="View the PyWa GitHub repository",
...                     ),
...                 ],
...             ),
...         ],
...     ),
... )

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 keyboard is provided, optional, up to 60 characters, no markdown allowed).
footer –
The footer of the message (if keyboard is provided, optional, up to 60 characters, markdown has no effect).
keyboard – The keyboard 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).

Returns:

The message ID of the sent message.

Send an image to a WhatsApp user.

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).
caption –
The caption of the image (optional, markdown allowed).
body –
The body of the message (optional, up to 1024 characters, markdown allowed, if buttons are provided and body is not provided, caption will be used as the body)
footer –
The footer of the message (if buttons is 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).

Returns:

The message ID of the sent image message.

Send a video to a WhatsApp user.

Only H.264 video codec and AAC audio codec is supported.
Videos with a single audio stream or no audio stream are supported.

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).
caption –
The caption of the video (optional, markdown allowed).
body –
The body of the message (optional, up to 1024 characters, markdown allowed, if buttons are provided and body is not provided, caption will be used as the body)
footer –
The footer of the message (if buttons is 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).

Returns:

The message ID of the sent video.

WhatsApp.send_audio(to: str | int, audio: str | bytes | BinaryIO) → str#

Send an audio file to a WhatsApp user.

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

Returns:

The message ID of the sent audio file.

Send a document to a WhatsApp user.

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).
filename – The filename of the document (optional, The extension of the filename will specify what format the document is displayed as in WhatsApp).
caption – The caption of the document (optional).
body –
The body of the message (optional, up to 1024 characters, markdown allowed, if buttons are provided and body is not provided, caption will be used as the body)
footer –
The footer of the message (if buttons is 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).

Returns:

The message ID of the sent document.

WhatsApp.send_location(to: str | int, latitude: float, longitude: float, name: str | None = None, address: str | None = None) → str#

Send a location to a WhatsApp user.

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

Returns:

The message ID of the sent location.

WhatsApp.send_contact(to: str | int, contact: Contact | Iterable[Contact], reply_to_message_id: str | None = None) → str#

Send a contact/s to a WhatsApp user.

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

Returns:

The message ID of the sent message.

WhatsApp.send_sticker(to: str | int, sticker: str | bytes | BinaryIO) → str#

Send a sticker to a WhatsApp user.

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.

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

Returns:

The message ID of the sent message.

WhatsApp.send_catalog(to: str | int, body: str, footer: str | None = None, thumbnail_product_sku: str | None = None, reply_to_message_id: str | None = None) → str#

Send the business catalog to a WhatsApp user.

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 – The thumbnail of this item will be used as the message’s header image (optional, if not provided, the first item in the catalog will be used).
reply_to_message_id – The message ID to reply to (optional).

Returns:

The message ID of the sent message.

WhatsApp.send_template(to: str | int, template: Template, reply_to_message_id: str | None = None) → str#

Send a template to a WhatsApp user.

To create a template, use create_template().

Example

>>> from pywa.types import Template as Temp
>>> wa = WhatsApp(...)
>>> wa.send_template(
...     to='1234567890',
...         template=Temp(
...         name='buy_new_iphone_x',
...         language=Temp.Language.ENGLISH_US,
...         header=Temp.TextValue(value='15'),
...         body=[
...             Temp.TextValue(value='John Doe'),
...             Temp.TextValue(value='WA_IPHONE_15'),
...             Temp.TextValue(value='15%'),
...         ],
...         buttons=[
...             Temp.UrlButtonValue(value='iphone15'),
...             Temp.QuickReplyButtonData(data='unsubscribe_from_marketing_messages'),
...             Temp.QuickReplyButtonData(data='unsubscribe_from_all_messages'),
...         ],
...     ),
... )

Example for Authentication Template:

>>> from pywa.types import Template as Temp
>>> wa = WhatsApp(...)
>>> wa.send_template(
...     to='1234567890',
...         template=Temp(
...         name='auth_with_otp',
...         language=Temp.Language.ENGLISH_US,
...         buttons=Temp.OTPButtonCode(code='123456'),
...     ),
... )

Parameters:

to – The phone ID of the WhatsApp user.
template – The template to send.
reply_to_message_id – The message ID to reply to (optional).

Returns:

The message ID of the sent template.

Raises:

WhatsApp.send_product(to: str | int, catalog_id: str, sku: str, body: str | None = None, footer: str | None = None, reply_to_message_id: str | None = None) → str#

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

To send multiple products, use send_products().

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

Returns:

The message ID of the sent message.

WhatsApp.send_products(to: str | int, catalog_id: str, product_sections: Iterable[ProductsSection], title: str, body: str, footer: str | None = None, reply_to_message_id: str | None = None) → str#

Send products from a business catalog to a WhatsApp user.

To send a single product, use send_product().

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

Returns:

The message ID of the sent message.

WhatsApp.send_reaction(to: str | int, emoji: str, message_id: str) → str#

React to a message with an emoji.

You can react to incoming messages by using the react() method.

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.

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

WhatsApp.remove_reaction(to: str | int, message_id: str) → str#

Remove a reaction from a message.

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

Example

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

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) → bool#

Mark a message as read.

You can mark incoming messages as read by using the mark_as_read() method.

Example

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

Parameters:: message_id – The message ID to mark as read.
Returns:: Whether the message was marked as read.

WhatsApp.upload_media(media: str | bytes | BinaryIO, mime_type: str, filename: str | None = None) → str#

Upload media to WhatsApp servers.

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

Returns:

The media ID.

Raises:

ValueError – If the file is not found or the URL is invalid or if the media is bytes and the filename is not provided.

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

Download a media file from WhatsApp servers.

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

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 the URL of a media.

The URL is valid for 5 minutes.
The media can be downloaded directly from the message using the download_media() method.

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.get_business_profile() → BusinessProfile#

Get the business profile of the WhatsApp Business account.

Example

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

Returns:: The business profile.

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>) → bool#

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

Returns:

Whether the business profile was updated.

WhatsApp.get_commerce_settings() → 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) → bool#

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

Returns:

Whether the commerce settings were updated.

Raises:

ValueError – If no arguments are provided.

WhatsApp.create_template(template: NewTemplate, placeholder: tuple[str, str] | None = None) → TemplateResponse#

`Create Templates` on developers.facebook.com.

To send a template, use send_template().

ATTENTION: In case of an errors, WhatsApp does not return a proper error message, instead, it returns a message of invalid parameter with error code of 100. You need to pay attention to the following:

The template name must be unique.
The limitiations of the characters in every field (all documented).
The order of the buttons.

Templates can be created and managed in the WhatsApp Message Templates dashboard.

Example

>>> from pywa.types import NewTemplate as NewTemp
>>> wa = WhatsApp(...)
>>> wa.create_template(
...     template=NewTemp(
...         name='buy_new_iphone_x',
...         category=NewTemp.Category.MARKETING,
...         language=NewTemp.Language.ENGLISH_US,
...         header=NewTemp.Text('The New iPhone {15} is here!'),
...         body=NewTemp.Body('Buy now and use the code {WA_IPHONE_15} to get {15%} off!'),
...         footer=NewTemp.Footer('Powered by PyWa'),
...         buttons=[
...             NewTemp.UrlButton(title='Buy Now', url='https://example.com/shop/{iphone15}'),
...             NewTemp.PhoneNumberButton(title='Call Us', phone_number='1234567890'),
...             NewTemp.QuickReplyButton('Unsubscribe from marketing messages'),
...             NewTemp.QuickReplyButton('Unsubscribe from all messages'),
...         ],
...     ),
... )

Example for Authentication Template:

>>> from pywa.types import NewTemplate as NewTemp
>>> wa = WhatsApp(...)
>>> wa.create_template(
...     template=NewTemp(
...         name='auth_with_otp',
...         category=NewTemp.Category.AUTHENTICATION,
...         language=NewTemp.Language.ENGLISH_US,
...         body=NewTemp.AuthBody(
...             code_expiration_minutes=5,
...             add_security_recommendation=True,
...         ),
...         buttons=NewTemp.OTPButton(
...             otp_type=NewTemp.OTPButton.OtpType.ONE_TAP,
...             title='Copy Code',
...             autofill_text='Autofill',
...             package_name='com.example.app',
...             signature_hash='1234567890ABCDEF1234567890ABCDEF12345678'
...         )
...     ),
... )

Parameters:

template – The template to create. <https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/supported-languages>`_).
placeholder – The placeholders start & end (optional, default: ('{', '}'))).

Returns:

The template created response. containing the template ID, status and category.

Client Reference

Contents

Client Reference#