# Calling

Endpoints for WhatsApp calling features

## Perform Call Action

> Execute call actions: pre\_accept, accept, reject, or connect for incoming calls.

```json
{"openapi":"3.1.0","info":{"title":"Messaging API","version":"1.38.1"},"tags":[{"name":"Calling","description":"Endpoints for WhatsApp calling features"}],"servers":[{"description":"Production server","url":"https://waba-v2.360dialog.io"}],"security":[{"D360-API-KEY":[]}],"components":{"securitySchemes":{"D360-API-KEY":{"description":"API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.","in":"header","name":"D360-API-KEY","type":"apiKey"}},"schemas":{"calling.CallActionRequest":{"description":"Request payload to initiate or manage a WhatsApp call","properties":{"action":{"type":"string"},"biz_opaque_callback_data":{"type":"string"},"call_id":{"type":"string"},"messaging_product":{"type":"string"},"session":{"$ref":"#/components/schemas/calling.CallSession"},"to":{"type":"string"}},"type":"object"},"calling.CallSession":{"properties":{"sdp":{"type":"string"},"sdp_type":{"type":"string"}},"type":"object"},"calling.CallActionResponse":{"description":"Response payload for a call action execution","properties":{"calls":{"items":{"$ref":"#/components/schemas/calling.CallInfo"},"type":"array","uniqueItems":false},"messaging_product":{"type":"string"},"success":{"type":"boolean"}},"type":"object"},"calling.CallInfo":{"properties":{"id":{"type":"string"}},"type":"object"},"utils.ErrorResp":{"properties":{"error":{"type":"string"}},"type":"object"}}},"paths":{"/calling/calls":{"post":{"description":"Execute call actions: pre_accept, accept, reject, or connect for incoming calls.","operationId":"perform-call-action","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/calling.CallActionRequest","summary":"requestBody","description":"Call action payload"}]}}},"description":"Call action payload","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calling.CallActionResponse"}}},"description":"Call action executed successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Internal server error"}},"summary":"Perform Call Action","tags":["Calling"]}}}}
```

## Get Call Permissions

> Retrieve calling permissions for a specific consumer WhatsApp ID.

```json
{"openapi":"3.1.0","info":{"title":"Messaging API","version":"1.38.1"},"tags":[{"name":"Calling","description":"Endpoints for WhatsApp calling features"}],"servers":[{"description":"Production server","url":"https://waba-v2.360dialog.io"}],"security":[{"D360-API-KEY":[]}],"components":{"securitySchemes":{"D360-API-KEY":{"description":"API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.","in":"header","name":"D360-API-KEY","type":"apiKey"}},"schemas":{"calling.GetCallPermissionsResponse":{"description":"Response payload containing call permission status and available actions","properties":{"actions":{"items":{"$ref":"#/components/schemas/calling.CallPermissionAction"},"type":"array","uniqueItems":false},"messaging_product":{"type":"string"},"permission":{"$ref":"#/components/schemas/calling.CallPermission"}},"type":"object"},"calling.CallPermissionAction":{"properties":{"action_name":{"type":"string"},"can_perform_action":{"type":"boolean"},"limits":{"items":{"$ref":"#/components/schemas/calling.CallPermissionLimit"},"type":"array","uniqueItems":false}},"type":"object"},"calling.CallPermissionLimit":{"properties":{"current_usage":{"type":"integer"},"limit_expiration_time":{"type":"integer"},"max_allowed":{"type":"integer"},"time_period":{"type":"string"}},"type":"object"},"calling.CallPermission":{"properties":{"expiration_time":{"type":"integer"},"status":{"type":"string"}},"type":"object"},"utils.ErrorResp":{"properties":{"error":{"type":"string"}},"type":"object"}}},"paths":{"/calling/permissions/{consumer_whatsapp_id}":{"get":{"description":"Retrieve calling permissions for a specific consumer WhatsApp ID.","operationId":"get-call-permissions","parameters":[{"description":"Consumer WhatsApp ID","in":"path","name":"consumer_whatsapp_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calling.GetCallPermissionsResponse"}}},"description":"Call permissions retrieved successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Internal server error"}},"summary":"Get Call Permissions","tags":["Calling"]}}}}
```

## Get Calling Settings

> Retrieve calling settings including SIP credentials for WhatsApp calling functionality.

```json
{"openapi":"3.1.0","info":{"title":"Messaging API","version":"1.38.1"},"tags":[{"name":"Calling","description":"Endpoints for WhatsApp calling features"}],"servers":[{"description":"Production server","url":"https://waba-v2.360dialog.io"}],"security":[{"D360-API-KEY":[]}],"components":{"securitySchemes":{"D360-API-KEY":{"description":"API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.","in":"header","name":"D360-API-KEY","type":"apiKey"}},"schemas":{"calling.GetCallingSettingsResponse":{"description":"Response payload containing phone number settings including calling, encryption, and storage configuration","properties":{"calling":{"$ref":"#/components/schemas/calling.CallingSettingsResponse"},"payload_encryption":{"$ref":"#/components/schemas/calling.PayloadEncryptionSettingsResponse"},"storage_configuration":{"$ref":"#/components/schemas/calling.StorageConfigurationSettingsResponse"}},"type":"object"},"calling.CallingSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/calling.AudioSettingsResponse"},"call_hours":{"$ref":"#/components/schemas/calling.CallHoursSettings"},"call_icon_visibility":{"type":"string"},"call_icons":{"$ref":"#/components/schemas/calling.CallIconsSettings"},"callback_permission_status":{"type":"string"},"ip_addresses":{"$ref":"#/components/schemas/calling.IPAddresses"},"restrictions":{"$ref":"#/components/schemas/calling.CallingRestrictionsResponse"},"sip":{"$ref":"#/components/schemas/calling.SIPSettingsResponse"},"srtp_key_exchange_protocol":{"type":"string"},"status":{"type":"string"},"video":{"$ref":"#/components/schemas/calling.VideoSettingsResponse"}},"type":"object"},"calling.AudioSettingsResponse":{"properties":{"status":{"type":"string"}},"type":"object"},"calling.CallHoursSettings":{"properties":{"day_of_week_start":{"type":"string"},"status":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"calling.CallIconsSettings":{"properties":{"restrict_to_user_countries":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"calling.IPAddresses":{"properties":{"default":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"type":"object"},"calling.CallingRestrictionsResponse":{"properties":{"restrictions":{"items":{"$ref":"#/components/schemas/calling.Restriction"},"type":"array","uniqueItems":false}},"type":"object"},"calling.Restriction":{"properties":{"expiration":{"type":"integer"},"type":{"type":"string"}},"type":"object"},"calling.SIPSettingsResponse":{"properties":{"servers":{"items":{"$ref":"#/components/schemas/calling.SIPServerInfo"},"type":"array","uniqueItems":false},"status":{"type":"string"}},"type":"object"},"calling.SIPServerInfo":{"properties":{"app_id":{"type":"string"},"hostname":{"type":"string"},"password":{"type":"string"},"port":{"type":"integer"}},"type":"object"},"calling.VideoSettingsResponse":{"properties":{"status":{"type":"string"}},"type":"object"},"calling.PayloadEncryptionSettingsResponse":{"properties":{"client_encryption_key_fingerprint":{"type":"string"},"cloud_encryption_key":{"type":"string"},"status":{"type":"string"}},"type":"object"},"calling.StorageConfigurationSettingsResponse":{"properties":{"data_localization_region":{"type":"string"},"status":{"type":"string"}},"type":"object"},"utils.ErrorResp":{"properties":{"error":{"type":"string"}},"type":"object"}}},"paths":{"/calling/settings":{"get":{"description":"Retrieve calling settings including SIP credentials for WhatsApp calling functionality.","operationId":"get-calling-settings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calling.GetCallingSettingsResponse"}}},"description":"Calling settings retrieved successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Internal server error"}},"summary":"Get Calling Settings","tags":["Calling"]}}}}
```

## Update Calling Settings

> Update calling settings for WhatsApp calling functionality.

```json
{"openapi":"3.1.0","info":{"title":"Messaging API","version":"1.38.1"},"tags":[{"name":"Calling","description":"Endpoints for WhatsApp calling features"}],"servers":[{"description":"Production server","url":"https://waba-v2.360dialog.io"}],"security":[{"D360-API-KEY":[]}],"components":{"securitySchemes":{"D360-API-KEY":{"description":"API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.","in":"header","name":"D360-API-KEY","type":"apiKey"}},"schemas":{"calling.UpdateCallingSettingsRequest":{"description":"Request payload to update calling settings. Only one feature setting can be specified per request.","properties":{"calling":{"$ref":"#/components/schemas/calling.CallingSettings"}},"type":"object"},"calling.CallingSettings":{"properties":{"call_icon_visibility":{"type":"string"},"sip":{"$ref":"#/components/schemas/calling.SIPSettings"},"srtp_key_exchange_protocol":{"type":"string"},"status":{"type":"string"},"video":{"$ref":"#/components/schemas/calling.VideoSettings"}},"type":"object"},"calling.SIPSettings":{"properties":{"status":{"type":"string"}},"type":"object"},"calling.VideoSettings":{"properties":{"status":{"type":"string"}},"type":"object"},"calling.UpdateCallingSettingsResponse":{"description":"Response payload for successful settings update","properties":{"success":{"type":"boolean"}},"type":"object"},"utils.ErrorResp":{"properties":{"error":{"type":"string"}},"type":"object"}}},"paths":{"/calling/settings":{"post":{"description":"Update calling settings for WhatsApp calling functionality.","operationId":"update-calling-settings","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/calling.UpdateCallingSettingsRequest","summary":"requestBody","description":"Calling settings payload"}]}}},"description":"Calling settings payload","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calling.UpdateCallingSettingsResponse"}}},"description":"Calling settings updated successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Internal server error"}},"summary":"Update Calling Settings","tags":["Calling"]}}}}
```