WhatsApp Web Business Tool

The WhatsApp Web Business Tool is a graphic user interface that gives you access to some of the WhatsApp Business API client's settings and features.

This document covers:

The WhatsApp Web Business Tool is only supported for Chrome version 63.0.3239 and above.

Accessing the Web Business Tool

To access the Web Business Tool, visit the URL and port of the Webapp.

https://your-webapp-hostname:your-webapp-port

You must log into the WhatsApp Web Business Tool with the admin account to access all the settings.

If you have already logged into your WhatsApp Business API client, use the credentials that were set with the initial login API call.

Alternatively, you can use the default credentials specified in the Login and Authentication documentation to log into the WhatsApp Business API client for the first time via the Web Business Tool. Note: You must change the default password the first time you log into the WhatsApp Business API client, so you will be prompted to change the password.

Before you complete registration of your phone number, you will only be able to access the Registration and Application Settings tabs in the Web Business Tool.

Registration

Instead of making an API call requesting a registration code for your phone number, you can submit the registration form in the Web Business Tool to obtain a registration code and complete registration.

Registration

See the Phone Number and Certificate section of the Registration documentation for instructions on adding a phone number to your WhatsApp business account and downloading its certificate. Once you have done that, you can register the phone number in the Web Business Tool.

  1. Enter the phone number, and select how you wish to receive the registration code, either SMS or voice call.
  2. Either upload a file containing the certificate or paste it into the text field.
  3. If desired, set a two-step verification PIN.
  4. Click Submit.
  5. When you receive the 6-digit registration code, enter it in the Verification Code text field, and click Verify.
Verification Code

Once your phone number has been successfully registered, you will gain access to the Business Account Settings and Messaging tabs.

Application Settings

The Application Settings tab allows you to set many of the settings associated with Webhooks, and the /v1/settings/application endpoint.

Application Settings

Business Account Settings

Business Account Settings can only be configured after successful registration of the WhatsApp Business API client.

The Business Account Settings tab allows you to set settings associated with the /v1/settings/business/profile and /v1/settings/profile endpoints.

Business Account Settings

Messaging

Messaging can only be configured after successful registration of the WhatsApp Business API client.

You can test your WhatsApp Business API setup by sending different types of messages to a test phone number using the Web Business Tool. Note: Restrictions such as cut-off control still apply for messages sent via the messaging form.

Messages sent using the Web Business Tool will appear in the conversation panel at the right of the Messaging tab, however incoming messages will not appear here. To handle incoming messages, set up a Webhook. Messages are not retained in the Web Business Tool long term and will disappear if the page is refreshed

Messaging

Test Messages

You can test four types of messages: message templates, text, document, and media.

Message Templates

If you have approved message templates in your WhatsApp business account, you can test sending message templates by doing the following:

  1. Select the Template tab.
  2. Enter the Namespace and Element Name info for the message template you wish to test.
  3. Select your language settings. See Sending Message Templates - Language for more information about the language settings.
  4. Use the Default, Currancy, Time Component, and Unix Epoch buttons to set any needed parameters. See the Localization documentation for more information on Currancy, Time Components, and Unix Epoch parameters.
  5. Click Send Message.

Information about the template message will appear in the conversation pane.

Text

You can test sending free-form text messages by doing the following:

  1. Select the Text tab.
  2. Enter the text message you wish to send in the text box.
  3. Click Send Message.

The text message will appear in the conversation pane.

Document

You can test sending document files by doing the following:

  1. Select the Document tab.
  2. Click on Click here to select and attach file.
  3. Select the document file you wish to send.
  4. Click Send Message.

The document message will appear in the conversation pane.

Media

You can test sending photos by doing the following:

  1. Select the Media tab.
  2. Click on Click here to attach photos.
  3. Select the media file you wish to send.
  4. Add a caption to the text box.
  5. Click Send Message.

The media message will appear in the conversation pane.