Business profile and phone number information.

Functions

`get-business-profile`

fn (phone-number-id: Str?): Map
fn (phone-number-id: Str?, opts: Map): Map

Get the WhatsApp Business Profile for a phone number. Returns about text, address, description, email, websites, and profile picture URL.

Example

::business ::whatsapp::business

response ::business/get-business-profile("109876543210")
response.data[0].about        // => "Hot Dev official support"
response.data[0].description  // => "We build tools for developers"

`get-phone-number`

fn (phone-number-id: Str?): Map
fn (phone-number-id: Str?, opts: Map): Map

Get information about a specific phone number. Returns the display phone number, verified name, quality rating, and status.

Example

::business ::whatsapp::business

response ::business/get-phone-number("109876543210")
response.display_phone_number // => "+1 555 123 4567"
response.verified_name        // => "Hot Dev"
response.quality_rating       // => "GREEN"

`list-phone-numbers`

fn (request: ListPhoneNumbersRequest): Map
fn (request: ListPhoneNumbersRequest, opts: Map): Map

GET /{waba-id}/phone_numbers - List the phone numbers registered to a WhatsApp Business Account (data: [{id, display_phone_number, verified_name, quality_rating, status}]). The id is the phone_number_id the send functions take.

`update-business-profile`

fn (request: UpdateBusinessProfileRequest): Map
fn (request: UpdateBusinessProfileRequest, opts: Map): Map

Update the WhatsApp Business Profile. All fields are optional -- only provided fields are updated.

vertical is the business category: "OTHER", "AUTO", "BEAUTY", "APPAREL", "EDU", "ENTERTAIN", "EVENT_PLAN", "FINANCE", "GROCERY", "GOVT", "HOTEL", "HEALTH", "NONPROFIT", "PROF_SERVICES", "RETAIL", "TRAVEL", "RESTAURANT", "ALCOHOL", "ONLINE_GAMBLING", "PHYSICAL_GAMBLING", "OTC_DRUGS". about is max 139 characters, description max 512, websites max 2. profile_picture_handle is an upload handle from Meta's Resumable Upload API (not a media id).

Example

::business ::whatsapp::business

::business/update-business-profile(::business/UpdateBusinessProfileRequest({
  phone_number_id: "109876543210",
  about: "Hot Dev - Build faster",
  description: "We build tools for developers",
  websites: ["https://hot.dev"]
}))

Types

`ListPhoneNumbersRequest`

ListPhoneNumbersRequest type {
    waba_id: Str
}

`UpdateBusinessProfileRequest`

UpdateBusinessProfileRequest type {
    phone_number_id: Str?,
    about: Str?,
    address: Str?,
    description: Str?,
    email: Str?,
    websites: Vec<Str>?,
    vertical: Str?,
    profile_picture_handle: Str?
}

::api ::core