Call permission request

Last update: 6 hours ago by Irais Aguirre

Integration summary
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: messaging token, in the Authorization: Bearer {{wa-msg-api-token}} header (how to generate it)
Common fields: from, to (phone number or BSUID) and type (details)
type values on this page: "interactive"
Response: the same for every message (see response)

Message to ask the user for permission to call them. All are sent with POST /v1/messaging; headers, common fields and the response are in HTTP connection.

Send call permission request

Sends a non-template message with a call permission request. The type field must be "interactive".

Body

Fields for Send call permission request, in addition to the common fields:

Name	Description	Type	Requirements
call_permission_request	Object for sending a call permission request	Call_permission_request object	Required

Call permission request object

Name	Description	Type	Requirements
action	Action of the interactive message	Action object	Required
body	Message content	String	Required

Action object

Name	Description	Type	Requirements
name	Action name. Value: call_permission_request	String	Required

Example

Complete Send call permission request example (HTTP request and JSON body):

HTTP request

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "call_permission_request": {
    "body": "We would like to call you to help support your query on Order No: ON-12853.",
    "action": {
        "name": "call_permission_request"
        }
    }
}'

Body

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "call_permission_request": {
    "body": "We would like to call you to help support your query on Order No: ON-12853.",
    "action": {
        "name": "call_permission_request"
        }
    }
}

Replies and reactions

Template messages