Skip to main content
PATCH
Edit Voice Extension

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Extension ID

Pattern: ^[1-9]\d*$

Body

application/json
name
string
Minimum string length: 3
email
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
emergencyLocationId
number
emergencyLocation
string | null
recording
enum<string>
Available options:
yeschange,
no,
nochange
recordingEmail
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
callerIdNumber
string | null
Pattern: ^[1-9]\d{9}$
branchId
number
enableMeet
number
Required range: 0 <= x <= 1
enableTranscription
number
Required range: 0 <= x <= 1
musicOnHoldId
number
routingProfileId
number
dialTimeout
number
Required range: x <= 180Must be a multiple of 5
outboundDialPrefix
Pattern: ^[1-9][0-9]{6}$
sendInvite
number
Required range: 0 <= x <= 1
enableVoicemailIndicator
number
Required range: 0 <= x <= 1
dnd
boolean
enableDirectFax
number
Required range: 0 <= x <= 1
faxCallerIdNumber
string | null
Pattern: ^[1-9]\d{9}$
enableForwarding
boolean
forwardingDestinations
object[]
busyDestinations
object[]
offlineDestinations
object[]
noAnswerDestinations
object[]
deviceId
number

Response

200 - application/json

Updated voice extension

id
number
required

Extension ID

name
string | null
required

Extension name

number
string | null
required

Extension number

email
string | null
required

Extension email

peerName
string | null
required

SIP peer name

dnd
string | null
required

Do not disturb state

callerIdNumber
string | null
required

Outbound caller ID number

enableMeet
number
required

Meet enabled (1 = yes, 0 = no)

enableTranscription
number
required

Transcription enabled (1 = yes, 0 = no)

trunk
string | null
required

Trunk state

trunkHost
string | null
required

Trunk host

trunkCallerIdSource
string | null
required

Trunk caller ID source

trunkEmergencyCallerIdOverride
string | null
required

Trunk emergency caller ID override

callLimit
number | null
required

Concurrent call limit

mailbox
string | null
required

Mailbox address

recording
string | null
required

Call recording mode

dialTimeout
number | null
required

Inbound ring timeout (seconds)

outboundDialPrefix
string | null
required

Outbound dial prefix

enableDirectFax
number
required

Direct fax enabled (1 = yes, 0 = no)

recordingEmail
string | null
required

Recording delivery email

includeInDialByName
string | null
required

Dial-by-name inclusion

includeInPhonebook
string | null
required

Phonebook inclusion

enableForwarding
string | null
required

Forwarding state

emergencyLocationComment
string | null
required

Free-text emergency location comment

tenant
object
required

Owning tenant

branch
object
required

Branch

routingProfile
object
required

Routing profile

musicOnHold
object | null
required

Music on hold

user
object | null
required

Linked user

efaxUser
object | null
required

eFax user mapping

emergencyLocation
object | null
required

Emergency location

devices
object[]
required

Assigned devices

noAnswerDestinations
object[]
required

No-answer routing

busyDestinations
object[]
required

Busy routing

offlineDestinations
object[]
required

Offline routing

forwardingDestinations
object[]
required

Unconditional forwarding