For the complete documentation index, see llms.txt. This page is also available as Markdown.

Calling

Endpoints for WhatsApp calling features

Perform Call Action

post

Execute call actions: pre_accept, accept, reject, or connect for incoming calls.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

Call action payload

actionstringOptional

The action being taken: connect, pre_accept, accept, reject, or terminate

Example: connect
biz_opaque_callback_datastringOptional

Arbitrary string for tracking purposes, max 512 characters

call_idstringOptional

The WhatsApp call ID (required for terminate action)

Example: wamid.abc123
messaging_productstringOptional

Messaging product, must be 'whatsapp'

Example: whatsapp
tostringOptional

The number being called (callee)

Example: +1234567890
Responses
200

Call action executed successfully

application/json

Response payload for a call action execution

messaging_productstringOptional

Messaging product

Example: whatsapp
successbooleanOptional

Whether the action was successful (for terminate action)

Example: true
post/calling/calls
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
}

Get Call Permissions

get

Retrieve calling permissions for a specific consumer WhatsApp ID.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
consumer_whatsapp_idstringRequired

Consumer WhatsApp ID

Responses
200

Call permissions retrieved successfully

application/json

Response payload containing call permission status and available actions

messaging_productstringOptional

Messaging product

Example: whatsapp
get/calling/permissions/{consumer_whatsapp_id}
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"
  }
}

Get Calling Settings

get

Retrieve calling settings including SIP credentials for WhatsApp calling functionality.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Responses
200

Calling settings retrieved successfully

application/json

Response payload containing phone number settings including calling, encryption, and storage configuration

get/calling/settings
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

post

Update calling settings for WhatsApp calling functionality.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

Calling settings payload

Responses
200

Calling settings updated successfully

application/json

Response payload for successful settings update

successbooleanOptional

Whether the update was successful

Example: true
post/calling/settings
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?