WhatsApp

Ask a user for permission to call them

Sends Meta's interactive call_permission_request message from number_id to user with your text. Meta limits this to 1 request per 24 hours and 2 per 7 days per user; the user's reply is recorded from the webhook and gates POST /v1/whatsapp/calls. Requires the telephony:manage scope.

post/v1/whatsapp/call-permissions

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/whatsapp/call-permissions
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

number_idstring required
tostring required

The user's WhatsApp number (E.164).

textstring required

Why you want to call, shown in the permission prompt.

Example request

{
  "to": "+919876543210"
}

Response

Request sent

objectstring
number_idstring
userstring
message_idstring nullable

Example response

{
  "object": "whatsapp.call_permission_request"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.