open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing

Licensed methods

Client methods that require a license key, grouped by tier.

Licensed methods

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

Most methods are free. 106 methods require no license. The methods below require a license key for the listed tier — calling them without one returns a licensing error.

insiders (15)

MethodNamespaceDescription
checkNumberStatuscontactsCheck if number is on WhatsApp
deleteAllStatusstatusDelete all statuses
deleteStatusstatusDelete status
getNumberProfilecontactsGet profile of number
getOrderbusinessGet order details
getStarredMessagesmessagesGet starred messages
getStatusmystatusGet specific status
getStoriesstatusGet all stories
postImageStatusstatusPost image status
postTextStatusstatusPost text status
postVideoStatusstatusPost video status
sendAdvancedButtonsmessagesSends an advanced button message with media (deprecated)
sendButtonsmessagesSends a button message (deprecated)
sendListMessagemessagesSends a list/menu message (deprecated)
setProfilePicturesessionSet profile picture

restricted (2)

MethodNamespaceDescription
createGroupgroupsCreate new group
joinGroupViaLinkgroupsJoin group via invite link
Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

On this page