Message Status#

class pywa.types.message_status.MessageStatus#

Represents the status of a message.

‘MessageStatus’ on developers.facebook.com.

MessageStatus is a generic class, so when providing a factory parameter in callback handlers, you can specify the type of the factory to get autocomplete in the tracker attribute.

Here is an example:

>>> from pywa.types import CallbackData
>>> from dataclasses import dataclass
>>> @dataclass(frozen=True, slots=True)
>>> class UserData(CallbackData): # Subclass CallbackData
...     id: int
...     name: str
...     admin: bool

>>> from pywa import WhatsApp
>>> from pywa.types import Button, CallbackButton
>>> wa = WhatsApp(...)
>>> wa.send_message(
...     to='972987654321',
...     text='Hi user',
...     tracker=UserData(id=123, name='david', admin=True) # Here ^^^ we use the UserData class as the tracker
... )           # Here ^^^ we use the UserData class as the tracker data

>>> @wa.on_message_status(factory=UserData) # Use the factory parameter to convert the tracker data
... def on_status(_: WhatsApp, s: MessageStatus[UserData]): # For autocomplete
...    if s.tracker.admin: print(s.tracker.id) # Access the tracker data

Variables:

id – The ID of the message that the status is for.
metadata – The metadata of the message (to which phone number it was sent).
status (MessageStatusType) – The status of the message.
timestamp – The timestamp when the status was updated (in UTC).
from_user – The user who the message was sent to.
conversation (Conversation | None) – The conversation that the message was sent in (See Conversation).
pricing (Pricing | None) – The pricing of the message (Optional).
error (WhatsAppError | None) – The error that occurred (if status is MessageStatusType.FAILED).
tracker (_CallbackDataT | None) – The tracker that the message was sent with (e.g. wa.send_message(tracker=...)).
shared_data – Shared data between handlers.

class pywa.types.message_status.MessageStatusType#

Message status type.

Variables:

SENT – Indicates the message was successfully sent from our servers (WhatsApp UI equivalent: One checkmark).
DELIVERED – Indicates message was successfully delivered to the WhatsApp user’s device (WhatsApp UI equivalent: Two checkmarks).
READ – Indicates the message was displayed in an open chat thread in the WhatsApp user’s device (WhatsApp UI equivalent: Two blue checkmarks).
PLAYED – played — Indicates the first time a voice message is played to the WhatsApp user’s device (WhatsApp UI equivalent: Blue microphone).
FAILED – failed — Indicates failure to send or deliver the message to the WhatsApp user’s device (WhatsApp UI equivalent: Red error triangle).

class pywa.types.message_status.Conversation#

Conversations are 24-hour message threads between you and your customers. They are opened and charged when messages you send to customers are delivered.

‘Conversation’ on developers.facebook.com.

Variables:

id (str) – Represents the ID of the conversation the given status notification belongs to.
category (pywa.types.message_status.ConversationCategory) – The category of the conversation.
expiration (datetime.datetime | None) – The expiration date (in UTC) of the conversation (Optional, only for sent updates).

class pywa.types.message_status.ConversationCategory#

Conversation category.

Message Status

Contents

Message Status#