Update Phone Line

User Guide > Resources > Update Phone Line

This request changes the attributes of a phone line.

Resource

PATCH /phonelines/<OID>

Where OID is the object ID of the phone line.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations Editable by Manager Comment

commonName

replace

callerName

replace

associatedAddressable

replace

defaultFallback

replace

externalNumber

replace

extensions

add, remove

phones

add, remove

musicOnHoldCategory

replace

V

saveCallRecording

replace

summaryPrompt

replace

See Get Summary Prompts for valid prompt ids.

transcribeCallRecording

replace

doNotRecordInternalCalls

replace

unlimitedChannelCount

replace

hideInPhoneList

replace

linkedPresenceGroup

replace

announcementEnabled

replace

announcement

remove, replace submember

announcement.audioMessage.commonName

replace

announcement.audioMessage.originalLocation

replace

announcement.audioMessage.mimeType

replace

announcement.audioMessage.contentsB64String

replace

announcement.textToSpeech.message

replace

announcement.textToSpeech.language

replace

announcement.textToSpeech.speaker

replace

callerAnnouncementEnabled

replace

callerAnnouncement

remove, replace submember

callerAnnouncement.audioMessage.commonName

replace

callerAnnouncement.audioMessage.originalLocation

replace

callerAnnouncement.audioMessage.mimeType

replace

callerAnnouncement.audioMessage.contentsB64String

replace

callerAnnouncement.textToSpeech.message

replace

callerAnnouncement.textToSpeech.language

replace

callerAnnouncement.textToSpeech.speaker

replace

hideNumbers

replace

isConferenceRoom

replace

conferenceRoomListenOnly

replace

conferenceRoomCallerId

replace

allowedNumbers

add, remove, replace submember

forwardCallerIdMap

add, remove, replace submember

isChatable

replace

V

groupChatActive

replace

chatHuntingTimeout

replace

V

chatIdleTimeout

replace

V

chatEndedTimeout

replace

V

chatHeartbeatInterval

replace

V

chatHeartbeatMessage

replace

V

chatNoAgentsAvailableMessage

replace

V

limitAccessToCallRecording

replace

showAgentNameWhenDialing

replace

callRecordingUsers

add, remove

callLogUsers

add, remove

managers

add, remove

trafficClasses

add, remove

afterCallTypes

add, remove

minNumberOfActiveUsersInLine

replace

alertInfoRingtoneOutgoing

replace

alertInfoRingtoneIncoming

replace

Users

users

add, remove, replace submember

V

users.user

replace

V

users.skillNumber

replace

V

users.incoming

replace

V

users.outgoing

replace

V

users.editable

replace

V

users.lineOrder

replace

V

User Phone Line

userPhoneLine.timeout

replace

V

userPhoneLine.redirectionTimeout

replace

V

userPhoneLine.listeners

add, remove

V

userPhoneLine.userStatus

replace

V

userPhoneLine.message

replace

V

userPhoneLine.location

replace

V

userPhoneLine.voicemailActive

replace

V

userPhoneLine.voicemailGreeting

remove, replace submember

V

userPhoneLine.voicemailGreeting.audioMessage.commonName

replace

V

userPhoneLine.voicemailGreeting.audioMessage.originalLocation

replace

V

userPhoneLine.voicemailGreeting.audioMessage.mimeType

replace

V

userPhoneLine.voicemailGreeting.audioMessage.contentsB64String

replace

V

userPhoneLine.voicemailGreeting.textToSpeech.message

replace

V

userPhoneLine.voicemailGreeting.textToSpeech.language

replace

V

userPhoneLine.voicemailGreeting.textToSpeech.speaker

replace

V

userPhoneLine.workSchedule.enabled

replace

V

userPhoneLine.workSchedule.disableOverrideUnavWarn

replace

V

userPhoneLine.workSchedule.template

replace

V

userPhoneLine.workSchedule.times

add, remove, replace submember

V

Day Night Mode

dayNightMode.enableDayNightMode

replace

V

dayNightMode.manualNightMode

replace

V

dayNightMode.oneOffOverrideDateTime

replace

V

dayNightMode.oneOffOverrideMode

replace

V

dayNightMode.disableNotReachableWarning

replace

V

dayNightMode.switchTimeTemplate

replace

V

dayNightMode.syncSwitchTimeTemplate

replace

V

dayNightMode.switchTime

add, remove, replace submember

V

dayNightMode.mainOverrides

replace

V

dayNightMode.overrides

add, remove, replace submember

V

Queue

processQueueInOrder

replace

answerWithMusicOnHold

replace

V

lineHuntingPolicy

replace

lineHuntingTimeout

replace

connectFirstAvailable

replace

ringLastTalkedToFirst

replace

callQueueWrapupTime

replace

manualWrapUp

replace

maxQueueLength

replace

positionReportPolicy

replace

positionReportTime

replace

positionMOH

replace

dtmfBreakoutEnabled

replace

toWhenNotAnsweredIfNoFreeAgent

replace

dtmfDigitQueueCallback

replace

Wallboard

showWaitingQueue

replace

wallboardResetTime

replace

onlyExternalCalls

replace

missedCallThreshold

replace

durationThresholdMin

replace

durationThreshold

replace

agentShowInbound

replace

agentShowOutbound

replace

agentShowTotal

replace

wallboardEntries

add, remove, replace submember

wallboardEntries.parameter

replace

wallboardEntries.direction

replace

wallboardEntries.formulaName

replace

wallboardEntries.formula

replace

wallboardEntries.orderNr

replace

wallboardEntries.threshold1

replace

wallboardEntries.threshold2

replace

Voicemail

enableVoicemailDelivery

replace

enableVoicemailSms

replace

voicemailDeliveryNumber

replace

voicemailDeliveryMessage

remove, replace

voicemailDeliveryMessage.audioMessage.commonName

replace

voicemailDeliveryMessage.audioMessage.originalLocation

replace

voicemailDeliveryMessage.audioMessage.mimeType

replace

voicemailDeliveryMessage.audioMessage.contentsB64String

replace

voicemailDeliveryMessage.textToSpeech.message

replace

voicemailDeliveryMessage.textToSpeech.language

replace

voicemailDeliveryMessage.textToSpeech.speaker

replace

voicemailDeliveryTimeout

replace

additionalVoicemailEmailText

replace

enableVoicemailToEmail

replace

voicemailRecipientAddress

replace

enableVoicemailTranscribe

replace

Auto Attendant

autoAttendantOn

replace

V

autoAttendant.audio

remove, replace submember

V

autoAttendant.audio.audioMessage.commonName

replace

V

autoAttendant.audio.audioMessage.originalLocation

replace

V

autoAttendant.audio.audioMessage.mimeType

replace

V

autoAttendant.audio.audioMessage.contentsB64String

replace

V

autoAttendant.audio.textToSpeech.message

replace

V

autoAttendant.audio.textToSpeech.language

replace

V

autoAttendant.audio.textToSpeech.speaker

replace

V

autoAttendant.allowDirectNumber

replace

V

autoAttendant.action1

replace

V

autoAttendant.voicemail1

replace

V

autoAttendant.action2

replace

V

autoAttendant.voicemail2

replace

V

autoAttendant.action3

replace

V

autoAttendant.voicemail3

replace

V

autoAttendant.action4

replace

V

autoAttendant.voicemail4

replace

V

autoAttendant.action5

replace

V

autoAttendant.voicemail5

replace

V

autoAttendant.action6

replace

V

autoAttendant.voicemail6

replace

V

autoAttendant.action7

replace

V

autoAttendant.voicemail7

replace

V

autoAttendant.action8

replace

V

autoAttendant.voicemail8

replace

V

autoAttendant.action9

replace

V

autoAttendant.voicemail9

replace

V

autoAttendant.fallback

replace

V

Wallboard security

wallboard.accessRights

replace

wallboard.domain

add, remove, replace submember

wallboard.domain.writeObject

replace

Chat auto replies

chatAutoReplies

add, remove, replace submember

V

chatAutoReplies.xelionStatus

replace

V

chatAutoReplies.message

replace

V

Response

None

Context

Authorization

Administrator or User(manager of the line)

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/phonelines/10317713
Payload

change phone line direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/callerName",
            "value": "test777"
        }
    ]
}

add a user to the phone line, '1' is the virtual ID, value is the User Profile oid

{
    "operations": [
        {
            "op": "add",
            "path": "/users/1",
            "value": "1651479"
        },
        {
            "op": "replace",
            "path": "/users/1/editable",
            "value": "NONE"
        }
    ]
}

remove a user from the phone line, value is the relation connected user oid

{
    "operations": [
        {
            "op": "remove",
            "path": "/users/1651479"
        }
    ]
}

add a phone to the phone line, '1' is the virtual ID, value is the Base Phone oid

{
    "operations": [
        {
            "op": "add",
            "path": "/phones/1",
            "value": "1651479"
        }
    ]
}

remove a phone from the phone line, value is the relation connected phone oid

{
    "operations": [
        {
            "op": "remove",
            "path": "/phones/1651479"
        }
    ]
}

add extension to the phone line, first add a operation add with a virtual number '1'
then add an extra operation replace to set the address / number of the extension.

{
    "operations": [
        {
            "op": "add",
            "path": "/extensions/1",
        },
        {
            "op": "replace",
            "path": "/extensions/1/address",
            "value": "432"
        }
    ]
}

remove extension from the phone line, value is the TelecomAddress oid

{
    "operations": [
        {
            "op": "remove",
            "path": "/extensions/1458789"
        }
    ]
}

add new allowed number to phone line, first add a new object with virtual id 1 and then set the submember(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/allowedNumbers/1",
        },
        {
            "op": "replace",
            "path": "/allowedNumbers/1/externalNumber",
            "value": "0151234567"
        }
    ]
}

remove allowed number from phone line, <OID> is the oid of the allowed number

{
    "operations": [
        {
            "op": "remove",
            "path": "/allowedNumbers/1726623"
        }
    ]
}

change allowed number submember, <OID> is the oid of the allowed number

{
    "operations": [
        {
            "op": "replace",
            "path": "/allowedNumbers/1726623/externalNumber",
            "value": "0151234568"
        }
    ]
}

add new forward caller id map / automatic transfer to phone line, first add a new object with virtual id 1 and then set the submember(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/forwardCallerIdMap/1",
        },
        {
            "op": "replace",
            "path": "/forwardCallerIdMap/1/addressStart",
            "value": "0900"
        }
    ]
}

remove forward caller id map / automatic transfer from phone line, <OID> is the oid of the forward caller id map

{
    "operations": [
        {
            "op": "remove",
            "path": "/forwardCallerIdMap/1726623"
        }
    ]
}

change forward caller id map / automatic transfer submember, <OID> is the oid of the forward caller id map

{
    "operations": [
        {
            "op": "replace",
            "path": "/forwardCallerIdMap/1726623/addressStart",
            "value": "0800"
        }
    ]
}

change user line direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/userPhoneLine/message",
            "value": "hello world"
        }
    ]
}

change user line workschedule direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/userPhoneLine/workSchedule/enabled",
            "value": true
        }
    ]
}

add new time to user line work schedule, first add a new time with virtual id 1 and then set the time member(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/userPhoneLine/workSchedule/times/1"
        },
        {
            "op": "replace",
            "path": "/userPhoneLine/workSchedule/times/1/day",
            "value": "tuesday"
        }
    ]
}

remove time from user line work schedule, <OID> is the oid of the time

{
    "operations": [
        {
            "op": "remove",
            "path": "/userPhoneLine/workSchedule/times/1458789"
        }
    ]
}

change user line work schedule time submember

{
    "operations": [
        {
            "op": "replace",
            "path": "/userPhoneLine/workSchedule/times/1458789/day",
            "value": "monday"
        }
    ]
}

add new line listener to the user line, first add a path with a virtual id '1' and insert the oid of the user profile as value

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

remove a listener from the user line, <OID> is the oid of the phone line listener object

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

change day night mode direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/dayNightMode/enableDayNightMode",
            "value": true
        }
    ]
}

add new switch time to day night mode, first add a new switch time with virtual id 1 and then set the switch time member(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/dayNightMode/switchTime/1",
        },
        {
            "op": "replace",
            "path": "/dayNightMode/switchTime/1/day",
            "value": "tuesday"
        }
    ]
}

remove switch time from day night mode, <OID> is the oid of the switch time

{
    "operations": [
        {
            "op": "remove",
            "path": "/dayNightMode/switchTime/1458789"
        }
    ]
}

change day night mode switch time submember

{
    "operations": [
        {
            "op": "replace",
            "path": "/dayNightMode/switchTime/1458789/day",
            "value": "tuesday"
        }
    ]
}

add new override to day night mode, first add a new override with virtual id 1 and then set the override member(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/dayNightMode/overrides/1"
        },
        {
            "op": "replace",
            "path": "/dayNightMode/overrides/1/startOverrideDateTime",
            "value": "2017-07-21 13:30:00"
        }
    ]
}

remove override from day night mode, <OID> is the oid of the override

{
    "operations": [
        {
            "op": "remove",
            "path": "/dayNightMode/overrides/1726623"
        }
    ]
}

change day night mode override submember

{
    "operations": [
        {
            "op": "replace",
            "path": "/dayNightMode/overrides/1726623/startOverrideDateTime",
            "value": "2017-07-21 13:30:00"
        }
    ]
}

add new wallboard entry to phone line, first add a new entry with virtual id 1 and then set the member(s) by adding replace operations on the virtual id '1'

{
    "operations": [
        {
            "op": "add",
            "path": "/wallboardEntries/1"
        },
        {
            "op": "replace",
            "path": "/wallboardEntries/1/parameter",
            "value": ACTIVE_CALLS"
        }
    ]
}

remove wallboard entry from line, <OID> is the oid of the entry

{
    "operations": [
        {
            "op": "remove",
            "path": "/wallboardEntries/1726623"
        }
    ]
}

change wallboard entry submember

{
    "operations": [
        {
            "op": "replace",
            "path": "/wallboardEntries/1726623/parameter",
            "value": "CANCELED_CALLS"
        }
    ]
}

change auto attendant direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/autoAttendant/voicemail1",
            "value": true
        }
    ]
}

add a call recording user to the phone line, value is the userprofile oid

{
    "operations": [
        {
            "op": "add",
            "path": "/callRecordingUsers/1",
            "value": "1651218"
        }
    ]
}

remove a call recording user from the phone line, <OID> is the userprofile oid

{
    "operations": [
        {
            "op": "remove",
            "path": "/callRecordingUsers/1651218"
        }
    ]
}

add a call log user to the phone line, value is the userprofile oid

{
    "operations": [
        {
            "op": "add",
            "path": "/callLogUsers/1"
            "value": "1651120"
        }
    ]
}

remove a call log user from the phone line, value is the userprofile oid

{
    "operations": [
        {
            "op": "remove",
            "path": "/callLogUsers/11651120"
        }
    ]
}

add new phone line manager to the phone line, first add a path with a virtual id '1' and insert the oid of the user profile as value

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

remove a phone line manager from the phone line, <OID> is the oid of the phone line manager object

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

add new traffic class to the phone line, 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 phone line, <OID> is the oid of the XCCTrafficClassPhoneLine relation object

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

add new after call type to the phone line, first add a path with a virtual id '1' and insert the oid of the after call type as value

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

remove an after call type from the phone line, <OID> is the oid of the RelAfterCallTypePhoneLine relation object

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

update annoucement attachment contents

{
    "operations": [
        {
            "op": "replace",
            "path": "/announcement/audioMessage/contentsB64String",
            "value": "UHKND77Gtt6YYHBGSTYFAERBJCBYEFGEDKH00..."
        }
    ]
}

update line wallboard security direct member

{
    "operations": [
        {
            "op": "replace",
            "path": "/wallboard/accessRights",
            "value": "Secured"
        }
    ]
}

add new domain to line wallbaord security domain list, first add a path with a virtual id '1' and insert the oid of the domain class as value

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

remove a domain from the phone line wallboard security domain list, <OID> is the oid of the SecurityAttributes relation object

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