Update PBX Call Settings

User Guide > Resources > Update PBX Call Settings

This request changes call settings attributes.

Resource

PATCH /server/pbx

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

Name	Patch Operations
asteriskTransferEnabled	`replace`
recordingRetentionDays	`replace`
savedRecordingRetentionDays	`replace`
doNotRecordInternalCalls	`replace`
disableDeleteRecording	`replace`
enablePauseCallRecording	`replace`
hideCallsOverview	`replacee`
blindTransferSPhoneDisabled	`replace`
twinThroughSoftphone	`replace`
callInfoFormat	`replace`
callParkingTime	`replace`
maxActiveChannels	`replace`
externalChannelsLimited	`replace`
internalChannelsLimited	`replace`
reservedIncomingChannelsCount	`replace`
testNumber	`replace`
voicemailMenuNumber	`replace`
vmMenuSkipPhoneNumber	`replace`
vmMenuSkipMsgAnnouncement	`replace`
vmMenuMsgDateFormat	`replace`
callPickupCode	`replacee`
callForwardingNumber	`replacee`
pbxCallInitiationDisabled	`replace`
appCallApiDisabled	`replace`
appCallSipDisabled	`replace`
appCallDirectDisabled	`replace`
dialWithoutConfirmation	`replace`
defaultCallStrategy	`replace`
defaultMusicOnHoldCategory	`replace`
isPickupVisible	`replace`
pickupVisibleTime	`replace`
trafficClasses	`add, remove`
localCallForwardingNumber	`add, remove, replace submember`

asteriskTransferEnabled

replace

recordingRetentionDays

replace

savedRecordingRetentionDays

replace

doNotRecordInternalCalls

replace

disableDeleteRecording

replace

enablePauseCallRecording

replace

hideCallsOverview

replacee

blindTransferSPhoneDisabled

replace

twinThroughSoftphone

replace

callInfoFormat

replace

callParkingTime

replace

maxActiveChannels

replace

externalChannelsLimited

replace

internalChannelsLimited

replace

reservedIncomingChannelsCount

replace

testNumber

replace

voicemailMenuNumber

replace

vmMenuSkipPhoneNumber

replace

vmMenuSkipMsgAnnouncement

replace

vmMenuMsgDateFormat

replace

callPickupCode

replacee

callForwardingNumber

replacee

pbxCallInitiationDisabled

replace

appCallApiDisabled

replace

appCallSipDisabled

replace

appCallDirectDisabled

replace

dialWithoutConfirmation

replace

defaultCallStrategy

replace

defaultMusicOnHoldCategory

replace

isPickupVisible

replace

pickupVisibleTime

replace

trafficClasses

add, remove

localCallForwardingNumber

add, remove, replace submember

Master Tenant Fields

Name Patch Operations

Name	Patch Operations
noDirectTenantDial	`replace`

noDirectTenantDial

replace

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request

PATCH https://xelion.nl/api/v1/master/server/pbx

Payload

replace a call setting direct member

{
    "operations": [
            {
        "op": "replace",
            "path": "/testNumber",
            "value": "600"
            }
    ]
}

add new traffic class to the call settings, first add a path with a virtual id '1' and insert the oid of the traffic class as value

{
    "operations": [
            {
        "op": "add",
            "path": "/trafficClasses/1",
            "value": "1756113"
            }
    ]
}

remove a traffic class from the call settings, <OID> is the oid of the XCCTrafficClassDefaults relation object

{
     "operations": [
            {
            "op": "remove",
            "path": "/trafficClasses/321443"
            }
    ]
}