Cloud API Calling API

Overview

The WhatsApp Business Calling API enables you to initiate and receive calls with users on WhatsApp using Voice over Internet Protocol (VoIP).

Architecture

(Right click image and choose "Open in new tab" for enlarged image)

Get started

Step 1: Prerequisites

Before you get started with the Calling API, ensure that:

1. Your business number is in use with Cloud API (not the WhatsApp Business app)
2. Subscribe your app to the calls webhook field (unless you plan to use SIP)
   1. The same app should also be subscribed to the WhatsApp Business Account of your business phone number.
   2. This app should have messaging permissions (whatsapp_business_messaging) for the business number
3. The business must have a messaging limit of at least 2000 business-initiated conversations in a rolling 24-hour period. More details on scaling your account capabilities.
4. Enable Calling features on your business phone number

Step 2: Configure optional calling features

The WhatsApp Business Calling API offers a number of features that affect when and how calling features appear to users on your WhatsApp profile

• Inbound call control allows you to prevent users from placing calls from your business profile
• Business call hours allows you to avoid missed calls and direct users to message when your call center is closed
• Callback requests offer users the option to request a callback when you don’t pick up a call or if your call center is closed

Learn more about call control settings

Step 3: Make and receive calls

Cloud API Calling offers two call initiation paths:

• User-initiated calls: Calls that are made from a WhatsApp user to your business
• Business-initiated calls: Calls that are made from your business to a WhatsApp user

Testing and Sandbox accounts

Sandbox accounts and public test numbers enable you to test you WhatsApp Calling API integration with relaxed calling limitations.

You obtain a public test number after completing the Get Started flow.

You are also not required to have a messaging limit of at least 2000 business-initiated conversations in a rolling 24-hour period to test Calling API features when using public test numbers and Sandbox accounts.

Calling is disabled by default on test numbers. You must configure calling features in phone number call settings before using the Calling API on a test number.

Learn more about Sandbox Accounts for Calling

Availability

User-initiated calling

User-initiated calling is available in every location Cloud API is available

Business-initiated calling

Business-initiated calling is currently available in every location Cloud API is available, except the following countries:

• USA
• Canada
• Turkey
• Egypt
• Vietnam
• Nigeria

Note: The business phone number’s country code must be in this supported list. The consumer phone number can be from any country where Cloud API is available.

Next steps

Use our guides below to help you get started with integrating and using calling features in your application:

• Learn how to receive user-initiated calls
• Learn how to place business-initiated calls
• Learn how to drive consumer awareness of calling availability in your business

Changelog

Use this table as a centralized place to keep track of feature updates related to WhatsApp Business Calling APIs