Ballerina library

whatsapp.business

Module whatsapp.business

OverviewPrerequisites

API

Client

Definitions

Address
ApplicationSettings
AudioById
AudioByProvider
BackupSettings
BackupSettingsRequestBody
BackupSettingsResponse
BusinessProfile
BusinessSettings
BusinessSettingsBusiness
CheckContact
CheckContactRequestBody
CheckContactResponse
ClientHttp1Settings
ConnectionConfig
Contact
CreateGroupRequestBody
CreateUserRequestBody
Currency
DateTimeComponent
DateTimeObject
DateTimeUnixEpoch
DetailedUserResponse
DetailedUserResponseItem
DocumentById
DocumentByProvider
Email
EnableTwoStepRequestBody
Error
GetBusinessProfileResponse
GetProfileAboutResponse
GetProfilePhotoResponse
Group
GroupAdminRequestBody
GroupInfo
GroupInvite
GroupInviteResponse
GroupResponse
GroupsResponse
Hsm
ImageById
ImageByProvider
Language
LocalizableParam
Location
LoginAdminRequestBody
MarkMessageAsReadRequestBody
Media
Message
MessageContext
MessageResponse
Meta
Name
Org
Phone
ProfileAbout
ProfileAboutSettings
ProfileAboutSettingsProfile
ProfilePhotoSettings
ProfilephotosettingsProfile
ProfilephotosettingsProfilePhoto
Provider
ProxyConfig
RegisterAccountRequestBody
RemoveGroupParticipantRequestBody
RequestCodeAccount
RequestCodeRequestBody
RequestCodeResponse
Response
RestoreSettingsRequestBody
SendMessageRequestBody
SetShardsRequestBody
Text
UpdateGroupInfoRequestBody
UpdateUserRequestBody
UploadMedia
Url
UserLoginResponse
UserLoginResponseItem
UserResponse
UserResponseItem
VideoById
VideoByProvider
WebhookAudio
WebhookContact
WebhookContactProfile
WebhookDocument
WebhookEvent
WebhookImage
WebhookLocation
WebhookMessage
Webhooks
WebhookStatus
WebhookSystem
WebhookText
WebhookVideo
WebhookVoice

Audio
Document
Image
Video

MessageType
UserRole

ballerinax/whatsapp.business Ballerina library

1.5.1

Overview

This is a generated connector for WhatsApp Business v2.21.4 OpenAPI Specification.

WhatsApp Business API provides the capability to communicate with customers all over the world, so you can connect with them on WhatsApp in a simple, secure, and reliable way.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

whatsapp.business: Client

Isolated

This is a generated connector for WhatsApp Business v2.21.4 OpenAPI Specification. WhatsApp Business connector supports to communicate with customers all over the world via WhatsApp.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create WhatsApp Business account and install client by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string - URL of the target service

requestCode

Isolated FunctionRemote Function
function requestCode(RequestCodeRequestBody payload) returns RequestCodeResponse|error?

Request-Code

Parameters
Return Type
  • RequestCodeResponse|error? - Created: the account already exists. You are already registered, so you do not need to do anything else

setShards

Isolated FunctionRemote Function
function setShards(SetShardsRequestBody payload) returns Response|error

Set-Shards

Parameters
Return Type

registerAccount

Isolated FunctionRemote Function
function registerAccount(RegisterAccountRequestBody payload) returns Response|error

Register-Account

Parameters
Return Type

uploadCertificate

Isolated FunctionRemote Function
function uploadCertificate(byte[] payload) returns Response|error

Upload-Certificate

Parameters
  • payload byte[] - Certificate
Return Type

downloadCaCertificate

Isolated FunctionRemote Function
function downloadCaCertificate() returns string|error

Download-CA-Certificate

Return Type

downloadWebhookCaCertificate

Isolated FunctionRemote Function
function downloadWebhookCaCertificate() returns string|error

Download Webhook CA Certificate

Return Type

uploadWebhookCaCertificate

Isolated FunctionRemote Function
function uploadWebhookCaCertificate(byte[] payload) returns Response|error

Upload Webhook CA Certificate

Parameters
  • payload byte[] - Certificate
Return Type

checkContact

Isolated FunctionRemote Function
function checkContact(CheckContactRequestBody payload) returns CheckContactResponse|error

Check-Contact

Parameters
Return Type

getAllGroups

Isolated FunctionRemote Function
function getAllGroups() returns GroupsResponse|error

Get-All-Groups

Return Type

createGroup

Isolated FunctionRemote Function
function createGroup(CreateGroupRequestBody payload) returns GroupsResponse|error

Create-Group

Parameters
Return Type

getGroupInfo

Isolated FunctionRemote Function
function getGroupInfo(string groupId) returns GroupResponse|error

Get-Group-Info

Parameters
Return Type

updateGroupInfo

Isolated FunctionRemote Function
function updateGroupInfo(string groupId, UpdateGroupInfoRequestBody payload) returns Response|error

Update-Group-Info

Parameters
Return Type

demoteGroupAdmin

Isolated FunctionRemote Function
function demoteGroupAdmin(string groupId) returns Response|error

Demote-Group-Admin

Parameters
Return Type

promoteToGroupAdmin

Isolated FunctionRemote Function
function promoteToGroupAdmin(string groupId, GroupAdminRequestBody payload) returns Response|error

Promote-To-Group-Admin

Parameters
Return Type

getGroupIconBinary

Isolated FunctionRemote Function
function getGroupIconBinary(string groupId) returns Response|error

Get-Group-Icon-Binary

Parameters
Return Type

getGroupInvite

Isolated FunctionRemote Function
function getGroupInvite(string groupId) returns GroupInviteResponse|error

Get-Group-Invite

Parameters
Return Type

removeGroupParticipant

Isolated FunctionRemote Function
function removeGroupParticipant(string groupId) returns Response|error

Remove-Group-Participant

Parameters
Return Type

checkHealth

Isolated FunctionRemote Function
function checkHealth() returns Response|error

Check-Health

Return Type

downloadMedia

Isolated FunctionRemote Function
function downloadMedia(string mediaId) returns json|error

Download-Media

Parameters
Return Type
  • json|error - JSON or else an error

sendMessage

Isolated FunctionRemote Function
function sendMessage(SendMessageRequestBody payload) returns MessageResponse|error

Send-Message

Parameters
Return Type

markMessageAsRead

Isolated FunctionRemote Function
function markMessageAsRead(string messageID, MarkMessageAsReadRequestBody payload) returns Response|error

Mark-Message-As-Read

Parameters
  • messageID string - Message ID from Webhook
Return Type

getMetrics

Isolated FunctionRemote Function
function getMetrics(string? format) returns json|error

Get-Metrics (since v2.21.3)

Parameters
  • format string? (default ()) - Required format
Return Type
  • json|error - JSON response or an error

enableTwoStep

Isolated FunctionRemote Function
function enableTwoStep(EnableTwoStepRequestBody payload) returns Response|error

Enable-Two-Step

Parameters
Return Type

getApplicationSettings

Isolated FunctionRemote Function
function getApplicationSettings() returns ApplicationSettings|error

Get-Application-Settings

Return Type

updateApplicationSettings

Isolated FunctionRemote Function
function updateApplicationSettings(ApplicationSettings payload) returns Response|error

Update-Application-Settings

Parameters
Return Type

backupSettings

Isolated FunctionRemote Function
function backupSettings(BackupSettingsRequestBody payload) returns BackupSettingsResponse|error

Backup-Settings

Parameters
Return Type

getBusinessProfile

Isolated FunctionRemote Function
function getBusinessProfile() returns GetBusinessProfileResponse|error

Get-Business-Profile

Return Type

updateBusinessProfile

Isolated FunctionRemote Function
function updateBusinessProfile(BusinessProfile payload) returns Response|error

Update-Business-Profile

Parameters
Return Type

getProfileAbout

Isolated FunctionRemote Function
function getProfileAbout() returns GetProfileAboutResponse|error

Get-Profile-About

Return Type

updateProfileAbout

Isolated FunctionRemote Function
function updateProfileAbout(ProfileAbout payload) returns Response|error

Update-Profile-About

Parameters
Return Type

getProfilePhoto

Isolated FunctionRemote Function
function getProfilePhoto(string? format) returns GetProfilePhotoResponse|error

Get-Profile-Photo

Parameters
  • format string? (default ()) - Required format
Return Type

restoreSettings

Isolated FunctionRemote Function
function restoreSettings(RestoreSettingsRequestBody payload) returns Response|error

Restore-Settings

Parameters
Return Type

getAppStats

Isolated FunctionRemote Function
function getAppStats(string? format) returns json|error

Get-App-Stats

Parameters
  • format string? (default ()) - Required format
Return Type
  • json|error - JSON response or an error

getDbStats

Isolated FunctionRemote Function
function getDbStats(string? format) returns json|error

Get-DB-Stats

Parameters
  • format string? (default ()) - Required format
Return Type
  • json|error - JSON response or an error

getSupportInfo

Isolated FunctionRemote Function
function getSupportInfo() returns json|error

Get-Support-Info

Return Type
  • json|error - JSON response or an error

createUser

Isolated FunctionRemote Function
function createUser(CreateUserRequestBody payload) returns UserResponse|error

Create-User

Parameters
Return Type

loginUser

Isolated FunctionRemote Function
function loginUser(LoginAdminRequestBody payload) returns UserLoginResponse|error

Login-User

Parameters
Return Type

getUser

Isolated FunctionRemote Function
function getUser(string userUsername) returns DetailedUserResponse|error

Get-User

Parameters
  • userUsername string - User's username
Return Type

updateUser

Isolated FunctionRemote Function
function updateUser(string userUsername, UpdateUserRequestBody payload) returns UserResponse|error

Update-User

Parameters
  • userUsername string - User's username
Return Type

Records

whatsapp.business: Address

Represents address

Fields
  • country string - Full country name
  • country_code string - Two-letter country abbreviation
  • state string - State abbreviation
  • street string - Street number and name
  • 'type string - Standard Values: HOME, WORK

whatsapp.business: ApplicationSettings

Represents application settings.

Fields
  • callback_backoff_delay_ms string? - Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.
  • callback_persist boolean? - Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.
  • heartbeat_interval int? - Multiconnect: Interval of the Master node monitoring of Coreapp nodes in seconds
  • max_callback_backoff_delay_ms string? - Maximum delay for a failed callback in milliseconds
  • media Media? - Represents media.
  • on_call_pager string? - Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.
  • pass_through boolean? - When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted. When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required.
  • sent_status boolean? - Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.
  • unhealthy_interval int? - Multiconnect: Maximum amount of seconds a Master node waits for a Coreapp node to respond to a heartbeat before considering it unhealthy and starting the failover process.

whatsapp.business: AudioById

Audio by ID

Fields

whatsapp.business: AudioByProvider

Audio by ID.

Fields
  • provider Provider - Represents provider.

whatsapp.business: BackupSettings

Represents backup settings

Fields
  • data string? - The data that has been backed up, encrypted for security.

whatsapp.business: BackupSettingsRequestBody

Represents backup setting body

Fields
  • password string - Used to encrypt backup data for security

whatsapp.business: BackupSettingsResponse

Save the data value as that will be used along with your password to restore the information.

Fields

whatsapp.business: BusinessProfile

Represents business profile

Fields
  • address string - Address of the business Maximum of 256 characters
  • description string - Description of the business Maximum of 256 characters
  • email string - Email address to contact the business Maximum of 128 characters
  • vertical string - Industry of the business Maximum of 128 characters
  • websites string[] - URLs associated with business (e.g., website, Facebook page, Instagram) Maximum of 2 websites with a maximum of 256 characters each

whatsapp.business: BusinessSettings

Represents business settings

Fields

whatsapp.business: BusinessSettingsBusiness

Represents business settings

Fields

whatsapp.business: CheckContact

Check contact

Fields
  • input string? - The value you sent in the contacts field of the JSON request.
  • status string? - Status of the user.
  • wa_id string? - WhatsApp user identifier that can be used in other API calls. Only returned if the status is valid.

whatsapp.business: CheckContactRequestBody

Parameters required to check contact.

Fields
  • blocking string(default "no_wait") - Blocking determines whether the request should wait for the processing to complete (synchronous) or not (asynchronous).
  • contacts string[] - Array of contact phone numbers. The numbers can be in any standard telephone number format.

whatsapp.business: CheckContactResponse

Check contact response

Fields

whatsapp.business: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

whatsapp.business: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

whatsapp.business: Contact

Contact

Fields
  • addresses Address[]? - Full contact address(es)
  • birthday string? - YYYY-MM-DD formatted string
  • emails Email[]? - Contact email address(es)
  • name Name? - Full contact name
  • org Org? - Contact organization information
  • phones Phone[]? - Contact phone number(s)
  • urls Url[]? - Contact URL(s)

whatsapp.business: CreateGroupRequestBody

Create group request body.

Fields

whatsapp.business: CreateUserRequestBody

Create user request body.

Fields

whatsapp.business: Currency

Represents currency.

Fields
  • amount_1000 int - Amount
  • currency_code string - Currency code

whatsapp.business: DateTimeComponent

Date/time by component.

Fields
  • day_of_month int? - The day of month
  • day_of_week int? - Both strings and numbers are accepted. If different from the value derived from the date (if specified), use the derived value.
  • hour int? - The hour
  • minute int? - The minute
  • month int? - The month
  • year int? - The year

whatsapp.business: DateTimeObject

The Whatsapp Business API Client will attempt to format the date/time based on a specified localization.

Fields

whatsapp.business: DateTimeUnixEpoch

Date/time by Unix epoch.

Fields
  • timestamp int? - Epoch timestamp in seconds

whatsapp.business: DetailedUserResponse

Represents detailed user response.

Fields

whatsapp.business: DetailedUserResponseItem

Represents detailed user response item

Fields

whatsapp.business: DocumentById

Document by ID.

Fields

whatsapp.business: DocumentByProvider

Document by provider.

Fields
  • provider Provider - Represents provider.

whatsapp.business: Email

Represents email.

Fields

whatsapp.business: EnableTwoStepRequestBody

Enable two step request body

Fields

whatsapp.business: Error

Represents error.

Fields
  • code int? - See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.
  • details string? - error detail
  • href string? - location for error detail

whatsapp.business: GetBusinessProfileResponse

Represents get business profile response

Fields

whatsapp.business: GetProfileAboutResponse

Represents get about profile response.

Fields

whatsapp.business: GetProfilePhotoResponse

Represents get profile photo response

Fields

whatsapp.business: Group

Represents group

Fields
  • creation_time int? - timestamp

whatsapp.business: GroupAdminRequestBody

Group admin request body.

Fields
  • wa_ids string[] - The WhatsApp IDs of the people to be added or removed as group admins

whatsapp.business: GroupInfo

Represents group information.

Fields
  • admins string[]? - Group administrators Lists IDs of the creator of the group and any administrators added
  • creation_time int? - Group creation time
  • creator string? - ID of the creator of this group
  • participants string[]? - Participants of the group This is an array of all the IDs of the participants in the group. Initially, this will be the creator of the group.
  • subject string? - Subject of the group

whatsapp.business: GroupInvite

Represents group invite.

Fields

whatsapp.business: GroupInviteResponse

Represents group invite response

Fields

whatsapp.business: GroupResponse

Represents group response

Fields

whatsapp.business: GroupsResponse

Represents groups response

Fields
  • groups Group[]? - Group list

whatsapp.business: Hsm

The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure.

Fields
  • element_name string - The element name that indicates which template to use within the namespace
  • localizable_params LocalizableParam[] - This field is an array of values to apply to variables in the template
  • namespace string - The namespace that will be used

whatsapp.business: ImageById

Image by ID

Fields

whatsapp.business: ImageByProvider

Image by provider

Fields
  • provider Provider - Represents provider.

whatsapp.business: Language

Language

Fields
  • code string - The code of the language or locale to use — Accepts both language and language_locale formats (e.g., en and en_US).
  • policy string - The language policy the message should follow

whatsapp.business: LocalizableParam

Localisable parameters.

Fields
  • currency Currency? - Represents currency.
  • date_time DateTimeObject? - The Whatsapp Business API Client will attempt to format the date/time based on a specified localization.
  • default string - Default text if localization fails

whatsapp.business: Location

Represents location.

Fields
  • address string - Address of the location. Only displayed if name is present.
  • latitude string - Latitude of the location
  • longitude string - Longitude of the location
  • name string - Name of the location

whatsapp.business: LoginAdminRequestBody

Represents login admin request body.

Fields
  • new_password string - New password

whatsapp.business: MarkMessageAsReadRequestBody

Represents mark message as read request body.

Fields

whatsapp.business: Media

Represents media.

Fields
  • auto_download string[] - An array specifying which types of media to automatically download.

whatsapp.business: Message

Represents message.

Fields

whatsapp.business: MessageContext

Represents message context.

Fields
  • 'from string? - Sender Whatsapp id of context-message
  • group_id string? - GroupId of context message
  • mentions string[]? - Whats app ids

whatsapp.business: MessageResponse

Represents message response

Fields

whatsapp.business: Meta

Contains generic information such as WhatsApp Business API Client version.

Fields
  • api_status string? - API status

whatsapp.business: Name

Full contact name

Fields
  • first_name string? - First name
  • formatted_name string - Full name as it normally appears

whatsapp.business: Org

Contact organization information

Fields
  • company string - Name of the contact's company
  • department string? - Name of the contact's department
  • title string? - Contact's business title

whatsapp.business: Phone

Phone

Fields
  • 'type string? - Standard Values: CELL, MAIN, IPHONE, HOME, WORK

whatsapp.business: ProfileAbout

Profile about

Fields
  • text string - Text to display in your profile's About section The max length for the string is 139 characters.

whatsapp.business: ProfileAboutSettings

Represents profile about settings

Fields

whatsapp.business: ProfileAboutSettingsProfile

Represents about in profile settings

Fields

whatsapp.business: ProfilePhotoSettings

Represents profile photo settings

Fields

whatsapp.business: ProfilephotosettingsProfile

Represents profile

Fields

whatsapp.business: ProfilephotosettingsProfilePhoto

Represents photo

Fields

whatsapp.business: Provider

Represents provider.

Fields

whatsapp.business: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

whatsapp.business: RegisterAccountRequestBody

Represents register account request body.

Fields

whatsapp.business: RemoveGroupParticipantRequestBody

Fields
  • wa_ids string[] - Represents remove group participant request body

whatsapp.business: RequestCodeAccount

Request code account

Fields
  • vname string? - Decoded name from cert

whatsapp.business: RequestCodeRequestBody

Represents required parameters to request code

Fields
  • cc string - Numerical country code for the phone number you are registering
  • cert string - Base64-encoded Verified Name certificate
  • method string - Method of receiving your registration code
  • phone_number string - Phone number you are registering, without the country code or plus symbol (+)
  • pin string? - Existing 6-digit PIN — This is only required when two-factor verification is enabled on this account.

whatsapp.business: RequestCodeResponse

Request code response

Fields

whatsapp.business: Response

Response

Fields
  • errors Error[]? - Only returned with a failed request. Contains an array of error objects that are present when there is an error.
  • meta Meta? - Contains generic information such as WhatsApp Business API Client version.

whatsapp.business: RestoreSettingsRequestBody

Restore settings request body

Fields
  • data string - The data that was returned by the /v1/settings/backup API call
  • password string - The password you used in the /v1/settings/backup API call to encrypt the backup data

whatsapp.business: SendMessageRequestBody

Send message request body

Fields
  • audio Audio? - The media object containing audio
  • contacts Contact[]? - Contacts list
  • document Document? - The media object containing a document.
  • hsm Hsm? - The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure.
  • image Image? - The media object containing an image.
  • location Location? - Represents location.
  • preview_url boolean? - Specifying preview_url in the request is optional when not including a URL in your message. To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. For more information, see the Sending URLs in Text Messages section.
  • recipient_type string(default "individual") - Determines whether the recipient is an individual or a group Specifying recipient_type in the request is optional when the value is individual. However, recipient_type is required when using group. If sending a text message to a group, see the Sending Group Messages documentation.
  • to string - When recipient_type is individual, this field is the WhatsApp ID (phone number) returned from contacts endpoint. When recipient_type is group, this field is the WhatsApp group ID.
  • ttl record {}? - TTL
  • video Video? - The media object containing a video

whatsapp.business: SetShardsRequestBody

Set shards request body

Fields
  • phone_number string - Phone number
  • shards int - Shards

whatsapp.business: Text

Text

Fields

whatsapp.business: UpdateGroupInfoRequestBody

Represents update group info request body.

Fields

whatsapp.business: UpdateUserRequestBody

Update user request body.

Fields

whatsapp.business: UploadMedia

Represents upload media

Fields

whatsapp.business: Url

Standard Values: HOME, WORK

Fields
  • 'type string? - Standard Values: HOME, WORK

whatsapp.business: UserLoginResponse

Represents user login response

Fields

whatsapp.business: UserLoginResponseItem

Represents user login response item

Fields
  • expires_after string? - Token expiration timestamp. By default, this is 7 days.
  • token string? - Authentication token to be used for all other WhatsApp Business API calls. The token must be sent in the authorization header in the format: Authorization: Bearer <authentication-token>

whatsapp.business: UserResponse

Represents user response

Fields

whatsapp.business: UserResponseItem

Represents user response item

Fields

whatsapp.business: VideoById

Video by ID

Fields

whatsapp.business: VideoByProvider

Video by provider

Fields
  • provider Provider - Represents provider.

whatsapp.business: WebhookAudio

Webhook audio

Fields
  • caption string? - Optional. Only present if specified.
  • file string? - Absolute filename and location on media volume. This parameter is deprecated.
  • filename string? - Filename on the sender's device. This will only be present in audio and document media messages.
  • id string? - ID of the media. Can be used to delete the media if stored locally on the client.
  • mime_type string? - Mime type of media

whatsapp.business: WebhookContact

Webhook contact

Fields
  • wa_id string? - The WhatsApp ID of the contact

whatsapp.business: WebhookContactProfile

Webhook contact profile

Fields
  • name string? - Optional. As of v2.21.4, contains the sender's profile name.

whatsapp.business: WebhookDocument

Webhook document

Fields
  • caption string? - Optional. Only present if specified.
  • file string? - Absolute filename and location on media volume. This parameter is deprecated.
  • filename string? - Filename on the sender's device. This will only be present in audio and document media messages.
  • id string? - ID of the media. Can be used to delete the media if stored locally on the client.
  • mime_type string? - Mime type of media

whatsapp.business: WebhookEvent

Webhook event

Fields
  • errors Error[]? - Error list

whatsapp.business: WebhookImage

Webhook image

Fields
  • caption string? - Optional. Only present if specified.
  • file string? - Absolute filename and location on media volume. This parameter is deprecated.
  • id string? - ID of the media. Can be used to delete the media if stored locally on the client.
  • mime_type string? - Mime type of media

whatsapp.business: WebhookLocation

Webhook location

Fields
  • address string? - Address of the location
  • latitude decimal? - Latitude of location being sent
  • longitude decimal? - Longitude of location being sent
  • name string? - Name of the location
  • url string? - URL for the website where the user downloaded the location information

whatsapp.business: WebhookMessage

Webhook message

Fields
  • errors Error[]? - Error list
  • 'from string? - WhatsApp ID of the sender
  • group_id string? - Optional. WhatsApp group ID
  • timestamp string? - Message received timestamp

whatsapp.business: Webhooks

Webhooks

Fields
  • max_concurrent_requests int? - Configures the maximum number of inflight callback requests that are sent out. Can be set to 6 (default), 12, 18, or 24.
  • url string? - Inbound and outbound notifications are routed to this URL. A HTTPS-based endpoint is required; HTTP will not work.

whatsapp.business: WebhookStatus

Webhook status

Fields
  • errors Error[]? - Error list
  • recipient_id string? - WhatsApp ID of recipient
  • status string? - Status of message
  • timestamp string? - Timestamp of the status message

whatsapp.business: WebhookSystem

Webhook system

Fields

whatsapp.business: WebhookText

Webhook text

Fields

whatsapp.business: WebhookVideo

Webhook video

Fields
  • caption string? - Optional. Only present if specified
  • file string? - Absolute filename and location on media volume. This parameter is deprecated
  • id string? - ID of the media. Can be used to delete the media if stored locally on the client
  • mime_type string? - Mime type of media

whatsapp.business: WebhookVoice

Webhook voice

Fields
  • caption string? - Optional. Only present if specified.
  • file string? - Absolute filename and location on media volume. This parameter is deprecated.
  • id string? - ID of the media. Can be used to delete the media if stored locally on the client.
  • mime_type string? - Mime type of media

Union types

whatsapp.business: Audio

AudioById|AudioByProvider

Audio

The media object containing audio

whatsapp.business: Document

DocumentById|DocumentByProvider

Document

The media object containing a document.

whatsapp.business: Image

ImageById|ImageByProvider

Image

The media object containing an image.

whatsapp.business: Video

VideoById|VideoByProvider

Video

The media object containing a video

String types

whatsapp.business: MessageType

string

MessageType

type of the message

whatsapp.business: UserRole

string

UserRole

Represents user role

Import

import ballerinax/whatsapp.business;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 12

Current verison: 1

Weekly downloads

Source repository

Keywords

Communication/Call & SMS

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC