Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Phone Number Configurations

Update a phone number with voice settings

patch/phone_numbers/{id}/voice

Path parameters

idstring required
Example:1293384261075731499

Identifies the resource.

Request body

caller_id_name_enabledboolean

Controls whether the caller ID name is enabled for this phone number.

inbound_call_screening'disabled' | 'reject_calls' | 'flag_calls'

The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.

tech_prefix_enabledboolean

Controls whether a tech prefix is enabled for this phone number.

translated_numberstring

This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.

usage_payment_method'pay-per-minute' | 'channel'

Controls whether a number is billed per minute or uses your concurrent channels.

Example request

{
  "call_forwarding": {
    "call_forwarding_enabled": true,
    "forwarding_type": "always",
    "forwards_to": "+13035559123"
  },
  "call_recording": {
    "inbound_call_recording_channels": "single",
    "inbound_call_recording_enabled": true,
    "inbound_call_recording_format": "wav"
  },
  "caller_id_name_enabled": true,
  "cnam_listing": {
    "cnam_listing_details": "example",
    "cnam_listing_enabled": true
  },
  "inbound_call_screening": "disabled",
  "media_features": {
    "accept_any_rtp_packets_enabled": true,
    "rtp_auto_adjust_enabled": true,
    "t38_fax_gateway_enabled": true
  },
  "tech_prefix_enabled": true,
  "translated_number": "+13035559999",
  "usage_payment_method": "pay-per-minute"
}

Response

Successful response with details about a phone number including voice settings.

Example response

{
  "data": {
    "call_forwarding": {
      "call_forwarding_enabled": true,
      "forwarding_type": "always",
      "forwards_to": "+13035559123"
    },
    "call_recording": {
      "inbound_call_recording_channels": "single",
      "inbound_call_recording_enabled": true,
      "inbound_call_recording_format": "wav"
    },
    "cnam_listing": {
      "cnam_listing_details": "example",
      "cnam_listing_enabled": true
    },
    "connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
    "customer_reference": "customer-reference",
    "emergency": {
      "emergency_address_id": "1315261609962112019",
      "emergency_enabled": true,
      "emergency_status": "active"
    },
    "id": "1293384261075731499",
    "inbound_call_screening": "disabled",
    "media_features": {
      "accept_any_rtp_packets_enabled": true,
      "rtp_auto_adjust_enabled": true,
      "t38_fax_gateway_enabled": true
    },
    "record_type": "voice_settings",
    "tech_prefix_enabled": false,
    "translated_number": "+13035559999",
    "usage_payment_method": "pay-per-minute"
  }
}