Ctrl+K

Others

Others#

class pywa.types.others.BusinessProfile#

Represents a business profile.

Variables:

  • about (str) – This text appears in the business’s profile, beneath its profile image, phone number, and contact buttons.

  • address (str | None) – Address of the business. Character limit 256.

  • description (str | None) – Description of the business. Character limit 512.

  • email (str | None) – The contact email address (in valid email format) of the business. Character limit 128.

  • industry (pywa.types.others.Industry) – The industry of the business.

  • profile_picture_url (str | None) – URL of the profile picture that was uploaded to Meta.

  • websites (tuple[str, ...] | None) – The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. There is a maximum of 2 websites with a maximum of 256 characters each.

class pywa.types.others.BusinessPhoneNumber#

Represents a WhatsApp Business Phone Number.

See WhatsApp Business Phone Number.

Variables:

  • id (str) – The ID of the phone number.

  • verified_name (str | None) – The name that appears in WhatsApp Manager and WhatsApp client chat thread headers, chat lists, and profile, if display criteria is met.

  • display_phone_number (str | None) – International format representation of the phone number.

  • conversational_automation (pywa.types.others.ConversationalAutomation | None) – Conversational Automation feature config for this phone number.

  • status (str | None) – The operating status of the phone number (eg. connected, rate limited, warned).

  • quality_rating (str | None) – The quality rating of the phone number.

  • quality_score (dict[str, str] | None) – Quality score of the phone.

  • webhook_configuration (dict[str, str] | None) – The webhook configuration of the phone number.

  • name_status (str | None) – The status of the name review.

  • new_name_status (str | None) – The status of the review of the new name requested.

  • code_verification_status (str | None) – Indicates the phone number’s one-time password (OTP) verification status. Values can be NOT_VERIFIED, VERIFIED, or EXPIRED. Only phone numbers with a VERIFIED status can be registered. See Manage Phone Numbers and Certificates.

  • account_mode (str | None) – The account mode of the phone number. See Filtering Phone Numbers.

  • is_official_business_account (bool) – Indicates if phone number is associated with an Official Business Account.

  • is_pin_enabled (bool) – Returns True if a pin for two-step verification is enabled.

  • is_preverified_number (bool) – Returns true if the phone number was pre-verified

  • messaging_limit_tier (str | None) – Current messaging limit tier.

  • search_visibility (str | None) – The availability of the phone_number in the WhatsApp Business search.

  • platform_type (str | None) – Platform the business phone number is registered with. Values can be CLOUD_API, ON_PREMISE, or NOT_APPLICABLE. If NOT_APPLICABLE, the number is not registered with Cloud API or On-Premises API.

  • throughput (dict[str, str] | None) – The business phone number’s Cloud API throughput level. See Phone Number Throughput.

  • eligibility_for_api_business_global_search (str | None) – Status of eligibility in the API Business Global Search.

  • health_status (dict[str, str] | None) – health_status

  • certificate (str | None) – Certificate of the phone number

  • new_certificate (str | None) – Certificate of the new name that was requested

  • last_onboarded_time (str | None) – Indicates when the user added the business phone number to their WhatsApp Business Account (when the user completed the Embedded Signup flow).

class pywa.types.others.ConversationalAutomation#

Represents a conversational automation.

See Conversational Automation.

Variables:
class pywa.types.others.Command#

Represents a command in a conversational automation.

See Conversational Automation.

Variables:

  • name (str) – The name of the command (without the slash).

  • description (str) – The description of the command.

class pywa.types.others.CommerceSettings#

Represents the WhatsApp commerce settings.

Variables:

  • catalog_id (str) – The ID of the catalog associated with the business.

  • is_catalog_visible (bool) – Whether the catalog is visible to customers.

  • is_cart_enabled (bool) – Whether the cart is enabled.

class pywa.types.others.Industry#

Represents the industry of a business.

Variables:

  • UNDEFINED – Undefined.

  • OTHER – Other.

  • AUTO – Automotive.

  • BEAUTY – Beauty.

  • APPAREL – Apparel.

  • EDU – Education.

  • ENTERTAIN – Entertainment.

  • EVENT_PLAN – Event planning.

  • FINANCE – Finance.

  • GROCERY – Grocery store.

  • GOVT – Government.

  • HOTEL – Hotel.

  • HEALTH – Health.

  • NONPROFIT – Nonprofit.

  • PROF_SERVICES – Professional services.

  • RETAIL – Retail.

  • TRAVEL – Travel.

  • RESTAURANT – Restaurant.

  • NOT_A_BIZ – Not a business.

class pywa.types.others.WhatsAppBusinessAccount#

Represents a WhatsApp Business Account.

Variables:

  • id (str) – The ID of the account.

  • message_template_namespace (str) – The namespace of the message templates.

  • name (str) – The name of the account.

  • timezone_id (str) – The timezone ID of the account.

class pywa.types.others.FacebookApplication#

Represents a Facebook Application.

Variables:

  • id (str) – The ID of the application.

  • name (str) – The name of the application.

  • link (str) – The link to the application.

class pywa.utils.Version#

Enum for the latest and minimum versions of the Graph API and WhatsApp Flows.

  • Use the constant to get the latest version. Example: WhatsApp(..., api_version=Version.GRAPH_API)

  • Use the min attribute to get the minimum version. Example: Version.GRAPH_API.min

Variables:

  • GRAPH_API – (MIN_VERSION: str, LATEST_VERSION: str)

  • FLOW_JSON – (MIN_VERSION: str, LATEST_VERSION: str)

  • FLOW_DATA_API – (MIN_VERSION: str, LATEST_VERSION: str)

  • FLOW_MSG – (MIN_VERSION: str, LATEST_VERSION: str)

Contents