Update User Phone Settings

User Guide > Resources > Update User Phone Settings

This request partially updates the user’s phone settings.

Resource

PATCH /me/phone/settings

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

anonymous

replace

doNotDisturb

replace

fallback

replace

fallbackActive

replace

location

replace

message

replace

redirection

replace

redirectionActive

replace

timeout

replace

redirectionTimeout

replace

userStatus

replace

temporaryUserStatus

replace

temporaryUserStatusUntil

replace

voicemailActive

replace

voicemailGreeting

remove, replace submember

voicemailGreeting.audioMessage.commonName

replace

voicemailGreeting.audioMessage.originalLocation

replace

voicemailGreeting.audioMessage.mimeType

replace

voicemailGreeting.audioMessage.contentsB64String

replace

voicemailGreeting.textToSpeech.message

replace

voicemailGreeting.textToSpeech.language

replace

voicemailGreeting.textToSpeech.speaker

replace

listeners

add, remove

workSchedule.enabled

replace

workSchedule.disableOverrideUnavWarn

replace

workSchedule.template

replace

workSchedule.times

add, remove, replace submember

dndExceptions.listItems

add, remove, replace submember

Response

None

Context

Authorization

User

Errors

Common Errors

HTTP code Xelion code Description

404

10100

User has no phone line.

Example

Request
PATCH https://xelion.nl/api/v1/master/me/phone/settings
Payload
{
        "operations": [
            {
            "op": "replace",
            "path": "/redirection",
            "value": "0657483920"
            },
            {
            "op": "replace",
            "path": "/redirectionActive",
            "value": true
            }
    ]
}

add new time to 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": "/workSchedule/times/1",
            },
            {
        "op": "replace",
            "path": "/workSchedule/times/1/day",
            "value": "tuesday"
            }
    ]
}

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

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

change work schedule time submember

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

add dnd exception submember

{
    "operations": [
            {
        "op": "add",
            "path": "/dndExceptions/listItems/item",
            "value": "<oid>"
            }
    ]
}

remove dnd exception submember

{
    "operations": [
            {
        "op": "remove",
            "path": "/dndExceptions/listItems/<oid>"
            }
    ]
}