Skip to main content
POST
phone.number.voice.configure

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phoneNumber
string
required

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
enabled
boolean
required

Enable calling, or disable without editing settings.

forwardTo

Destination for inbound calls; empty clears it.

Maximum string length: 2048
recordingEnabled
boolean

Record future calls.

transcriptionEnabled
boolean

Transcribe future calls.

transcriptionLanguage
enum<string>

Speech transcription language.

Available options:
auto,
en,
es
voicemailEnabled
boolean

Enable voicemail.

voicemailGreeting
string

Spoken voicemail greeting; empty restores default.

Maximum string length: 1000
businessHoursEnabled
boolean

Route calls only during business hours.

businessHoursTimezone
string

IANA time zone.

Maximum string length: 64
businessHours
object[]

Up to 21 weekly windows; replaces the list.

Maximum array length: 21
blockedCallers
string[]

Caller numbers to reject; replaces the list.

Maximum array length: 1000

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
forwardCallerId
enum<string>

Which caller identity the forwarded leg presents.

Available options:
business,
caller
ivrEnabled
boolean

Enable the keypad menu.

ivrPrompt
string

Spoken menu prompt.

Maximum string length: 1000
ivrOptions
object[]

Up to 12 menu destinations; replaces the list.

Maximum array length: 12

Response

The result

phoneNumber
string
required

Phone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{6,14}$
enabled
boolean
required

Confirmed voice state.

settings
object
required

Allowlisted effective voice settings.