Access Tokens1

Addresses6

Advanced Number Orders4

AI Collections14

Anthropic Messages1

Assistants46

Audio1

Audit Logs1

Authentication Providers5

AutoRechargePreferences2

Billing1

Billing Groups5

Brands16

Bucket SSL Certificate3

Bucket Usage2

Bulk Phone Number Campaigns3

Bulk Phone Number Operations5

Bundles2

Call Commands42

Call Control Applications5

Call Information2

Call Recordings11

Campaign15

CDR Reports10

CDR Usage Reports9

Chat4

cloudfs filesystems6

Clusters5

Comments2

Conference Commands23

Connections2

Contents1

Conversation Histories1

Conversations21

Country Coverage2

Coverage1

Credential Connections6

Credentials5

CSV Downloads3

Customer Service Record4

Data Migration9

Debugging1

Detail Records1

Dialogflow Integration4

DIR References3

Display Identity Records8

Documents8

Dynamic Emergency Addresses4

Dynamic Emergency Endpoints4

Email Domain DNS Records2

Email Domains6

Email Drafts8

Email Events2

Email Inboxes19

Email Messages10

Email Suppression Imports2

Email Suppressions6

Email Templates7

Email Threads2

Email Unsubscribe Groups8

Email Validations3

Email Verification3

Email Webhooks5

Embeddings8

Enterprises6

Enum1

External Connections23

Fine Tuning4

FQDN Connections7

FQDNs5

Global IPs21

Hosted Numbers9

Inexplicit Number Orders3

Infringement Claims4

Integration Secrets3

Integrations5

Inventory Level1

IP Addresses4

IP Connections5

IP Ranges3

IPs5

kv keys4

kv namespaces4

Managed Accounts8

MCP Servers5

MDR Detail Reports1

MDR Detailed Reports8

MDR Usage Reports13

Media Storage API6

Meeting Session Actions3

Meeting Session Artifacts3

Meeting Session Data4

Meeting Sessions5

Messages11

Messaging15

Messaging URL Domains1

Missions41

Mobile Network Operators1

Mobile Number Settings2

Mobile Phone Numbers3

Mobile Voice Connections5

Networks9

Notifications16

Number Lookup1

Number Portout14

Number Settings7

numbers features1

OAuth Clients10

OAuth Discovery2

OAuth Grants5

OAuth Protocol7

OpenAI Chat3

OpenAI Embeddings2

Opt-Out Management6

Organization Users4

OTA updates2

Outbound Voice Profiles5

Phone Number Batches2

Phone Number Block Orders3

Phone Number Blocks Background Jobs3

Phone Number Campaigns5

Phone Number Configurations11

Phone Number Orders21

Phone Number Porting1

Phone Number Reservations4

Phone Number Search2

Phone Numbers3

Porting Orders53

Presigned Object URLs1

Pricing2

Private Wireless Gateways4

Profiles7

Programmable Fax Applications5

Programmable Fax Commands6

Pronunciation Dictionaries5

Public Internet Gateways4

Push Credentials4

Queue Commands9

RCS9

RCS Agents10

RCS Brands5

Reference Data3

Regions1

Regulatory Requirements3

Reporting8

Reports2

Reputation17

Requirement Groups8

Requirement Types2

Requirements4

Research2

Room Compositions4

Room Participants2

Room Recordings4

Room Sessions7

Rooms6

Rooms Client Tokens2

Session Analysis3

SETI Observability1

Shared Campaigns5

Short Codes3

SIM Card Actions4

SIM Card Group Actions2

SIM Card Groups9

SIM Card Orders4

SIM Cards26

SIPREC Connectors4

Speech to Text Batch Reports8

Speech To Text Capabilities1

Speech To Text over WebSockets1

Speech to text Usage Reports2

sql databases5

Stored Payment Transactions1

Telco Data Usage Reports8

Terms of Service6

TeXML Applications5

TeXML REST Commands34

Text To Speech Commands3

Traffic Policy Profiles12

UAC Connections7

Usage Reports (BETA)2

User Bundles6

User Tags1

UserAddresses6

Verification Requests7

Verified Numbers5

Verify16

Virtual Cross Connects7

Voice Channels6

Voice Clones6

Voice Designs7

Voice SDK Stats2

Voicemail3

WDR Detail Reports1

Web Search1

Webhooks2

Whatsapp Business Accounts14

Whatsapp Message Templates10

Whatsapp messaging1

Whatsapp Phone Numbers30

WireGuard Interfaces10

Wireless Blocklists6

Wireless Regions1

x402 Payment Transactions2

Webhooks

Callbacks89

Meeting Session Webhooks5

Phone Number Configurations

Update a phone number with voice settings

Updates the voice configuration for the specified phone number. The response contains the phone number with its updated 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"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.20515

Aug 17, 20261571b0380bd7155See the full diff
- ▲
  the response property errors/items/code became optional for the status 400
  response-property-became-optional
- ▲
  the response property errors/items/code became optional for the status 401
  response-property-became-optional
- ▲
  the response property errors/items/code became optional for the status 404
  response-property-became-optional
- ▲
  the response property errors/items/code became optional for the status 422
  response-property-became-optional
- ▲
  the response property errors/items/code became optional for the status 500
  response-property-became-optional
- ▲
  the response property errors/items/title became optional for the status 400
  response-property-became-optional
- ▲
  the response property errors/items/title became optional for the status 401
  response-property-became-optional
- ▲
  the response property errors/items/title became optional for the status 404
  response-property-became-optional
- ▲
  the response property errors/items/title became optional for the status 422
  response-property-became-optional
- ▲
  the response property errors/items/title became optional for the status 500
  response-property-became-optional
- ▲
  the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500
  response-property-type-changed
- ○
  added the optional property errors/items/meta/url to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/meta/url to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/meta/url to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property errors/items/meta/url to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property errors/items/meta/url to the response with the 500 status
  response-optional-property-added
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 20268f5f4e5379945510See the full diff
- ▲
  the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422
  response-property-type-changed
- ▲
  the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500
  response-property-type-changed
- ●
  removed the optional property errors/items/meta/url from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property errors/items/meta/url from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property errors/items/meta/url from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property errors/items/meta/url from the response with the 422 status
  response-optional-property-removed
- ●
  removed the optional property errors/items/meta/url from the response with the 500 status
  response-optional-property-removed
- ○
  the response property errors/items/code became required for the status 400
  response-property-became-required
- ○
  the response property errors/items/code became required for the status 401
  response-property-became-required
- ○
  the response property errors/items/code became required for the status 404
  response-property-became-required
- ○
  the response property errors/items/code became required for the status 422
  response-property-became-required
- ○
  the response property errors/items/code became required for the status 500
  response-property-became-required
- ○
  the response property errors/items/title became required for the status 400
  response-property-became-required
- ○
  the response property errors/items/title became required for the status 401
  response-property-became-required
- ○
  the response property errors/items/title became required for the status 404
  response-property-became-required
- ○
  the response property errors/items/title became required for the status 422
  response-property-became-required
- ○
  the response property errors/items/title became required for the status 500
  response-property-became-required
This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history