Calling
Endpoints for WhatsApp calling features
Execute call actions: pre_accept, accept, reject, or connect for incoming calls.
API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.
Call action payload
The action being taken: connect, pre_accept, accept, reject, or terminate
connectArbitrary string for tracking purposes, max 512 characters
The WhatsApp call ID (required for terminate action)
wamid.abc123Messaging product, must be 'whatsapp'
whatsappThe number being called (callee)
+1234567890Call action executed successfully
Response payload for a call action execution
Messaging product
whatsappWhether the action was successful (for terminate action)
trueBad request
Unauthorized
Internal server error
POST /calling/calls HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"action": "connect",
"biz_opaque_callback_data": "text",
"call_id": "wamid.abc123",
"messaging_product": "whatsapp",
"session": {
"sdp": "text",
"sdp_type": "offer"
},
"to": "+1234567890"
}{
"calls": [
{
"id": "wamid.abc123"
}
],
"messaging_product": "whatsapp",
"success": true
}Retrieve calling permissions for a specific consumer WhatsApp ID.
API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.
Consumer WhatsApp ID
Call permissions retrieved successfully
Response payload containing call permission status and available actions
Messaging product
whatsappBad request
Unauthorized
Internal server error
GET /calling/permissions/{consumer_whatsapp_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*
{
"actions": [
{
"action_name": "start_call",
"can_perform_action": true,
"limits": [
{
"current_usage": 5,
"limit_expiration_time": 1,
"max_allowed": 100,
"time_period": "daily"
}
]
}
],
"messaging_product": "whatsapp",
"permission": {
"expiration_time": 1,
"status": "granted"
}
}Retrieve calling settings including SIP credentials for WhatsApp calling functionality.
API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.
Calling settings retrieved successfully
Response payload containing phone number settings including calling, encryption, and storage configuration
Unauthorized
Internal server error
GET /calling/settings HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*
{
"calling": {
"audio": {
"status": "enabled"
},
"call_hours": {
"day_of_week_start": "MONDAY",
"status": "enabled",
"timezone": "America/New_York"
},
"call_icon_visibility": "visible",
"call_icons": {
"restrict_to_user_countries": [
"text"
]
},
"callback_permission_status": "enabled",
"ip_addresses": {
"default": [
"text"
]
},
"restrictions": {
"restrictions": [
{
"expiration": 1,
"type": "text"
}
]
},
"sip": {
"servers": [
{
"app_id": "123456789",
"hostname": "sip.example.com",
"password": "text",
"port": 5060
}
],
"status": "enabled"
},
"srtp_key_exchange_protocol": "DTLS-SRTP",
"status": "enabled",
"video": {
"status": "enabled"
}
},
"payload_encryption": {
"client_encryption_key_fingerprint": "text",
"cloud_encryption_key": "text",
"status": "enabled"
},
"storage_configuration": {
"data_localization_region": "text",
"status": "default"
}
}Update calling settings for WhatsApp calling functionality.
API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.
Calling settings payload
Calling settings updated successfully
Response payload for successful settings update
Whether the update was successful
trueBad request
Unauthorized
Internal server error
POST /calling/settings HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"calling": {
"call_icon_visibility": "visible",
"sip": {
"status": "enabled"
},
"srtp_key_exchange_protocol": "DTLS-SRTP",
"status": "enabled",
"video": {
"status": "enabled"
}
}
}{
"success": true
}Last updated
Was this helpful?