Skip to main content
GET
Get calling permission

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

sender
string
required

Registered WhatsApp sender number. Must be in international format.

Required string length: 1 - 15
Pattern: [0-9]+
identifier
string
required

End user identifier — either a phone number in international format or a WhatsApp Business-Scoped User ID.

Pattern: ^([0-9]{1,15}|[A-Z]{2}\..*)$

Response

Sender’s calling permission successfully retrieved

status
enum<string>
required

The current status of sender's calling permission.
NO_PERMISSION - The end user has not granted calling permission to the sender.
TEMPORARY - The end user has granted a temporary calling permission to the sender.
PERMANENT - The end user has granted permanent calling permission to the sender.

Available options:
NO_PERMISSION,
TEMPORARY,
PERMANENT
Example:

"NO_PERMISSION"

actions
CallingPermissionAction · object[]
required

A list of actions a sender may undertake to facilitate a call permission or a business initiated call.

expirationTime
string<date-time>

Time at which the calling permission will expire. Present only when TEMPORARY permission is granted.

Example:

"2025-10-06T08:12:26.422Z"