[Index]

Model: device/spark/UserConfig

Model Details: device/spark/UserConfig

Title Description Details
Id
  • Field Name: id
  • Type: String
First Name
  • Field Name: firstName
  • Type: String
Last Name
  • Field Name: lastName
  • Type: String
Display Name
  • Field Name: displayName
  • Type: String
Email Address *
  • Field Name: email
  • Type: String
Webex Calling - Professional
  • Field Name: calling_pro
  • Type: Boolean
Do Not Disturb DND settings for a user
  • Field Name: dnd
  • Type: Object
Enabled Do Not Disturb will direct all calls to a busy signal
  • Field Name: dnd.enabled
  • Type: Boolean
Ring Splash Enabled Enable ring reminder on your Cisco IP phone
  • Field Name: dnd.ringSplashEnabled
  • Type: Boolean
Voicemail Voicemail settings for a user
  • Field Name: voicemail
  • Type: Object
Enabled
  • Field Name: voicemail.enabled
  • Type: Boolean
Send All Calls
  • Field Name: sendAllCalls
  • Type: Object
Send all incoming calls to voicemail
  • Field Name: voicemail.sendAllCalls.enabled
  • Type: Boolean
Send Busy Calls
  • Field Name: sendBusyCalls
  • Type: Object
Send calls to voicemail when the line is engaged
  • Field Name: voicemail.sendBusyCalls.enabled
  • Type: Boolean
Greeting
  • Field Name: voicemail.sendBusyCalls.greeting
  • Type: String
  • Choices: ["Custom", "Default"]
Greeting Uploaded greetingUploaded
  • Field Name: voicemail.sendBusyCalls.greetingUploaded
  • Type: Boolean
Send Unanswered Calls
  • Field Name: sendUnansweredCalls
  • Type: Object
Send calls to voicemail when unanswered
  • Field Name: voicemail.sendUnansweredCalls.enabled
  • Type: Boolean
Greeting
  • Field Name: voicemail.sendUnansweredCalls.greeting
  • Type: String
  • Choices: ["Custom", "Default"]
Greeting Uploaded greetingUploaded
  • Field Name: voicemail.sendUnansweredCalls.greetingUploaded
  • Type: Boolean
Number of rings before playing the ‘no answer’ message
  • Field Name: voicemail.sendUnansweredCalls.numberOfRings
  • Type: Integer
System Max Number Of Rings before forwarding to voicemail System Max number of rings setting
  • Field Name: voicemail.sendUnansweredCalls.systemMaxNumberOfRings
  • Type: Integer
Notifications
  • Field Name: notifications
  • Type: Object
Receive notification of any new voice messages
  • Field Name: voicemail.notifications.enabled
  • Type: Boolean
Destination email
  • Field Name: voicemail.notifications.destination
  • Type: String
Transfer To Number
  • Field Name: transferToNumber
  • Type: Object
Transfer on ‘0’ to another line To tell the caller that pressing ‘0’ will transfer to a specific phone number, a custom greeting must be recorded
  • Field Name: voicemail.transferToNumber.enabled
  • Type: Boolean
Destination Transfer callers to this phone number
  • Field Name: voicemail.transferToNumber.destination
  • Type: String
Email Copy Of Message
  • Field Name: emailCopyOfMessage
  • Type: Object
Email a copy of the voicemail message
  • Field Name: voicemail.emailCopyOfMessage.enabled
  • Type: Boolean
Email Id Use this email address for voicemail messages
  • Field Name: voicemail.emailCopyOfMessage.emailId
  • Type: String
Message Storage messageStorage
  • Field Name: messageStorage
  • Type: Object
Mwi Enabled mwiEnabled
  • Field Name: voicemail.messageStorage.mwiEnabled
  • Type: Boolean
Storage Type
  • Field Name: voicemail.messageStorage.storageType
  • Type: String
  • Choices: ["Internal", "External"]
External Email externalEmail
  • Field Name: voicemail.messageStorage.externalEmail
  • Type: String
Fax Message faxMessage
  • Field Name: faxMessage
  • Type: Object
Enabled enabled
  • Field Name: voicemail.faxMessage.enabled
  • Type: Boolean
Phone Number phoneNumber
  • Field Name: voicemail.faxMessage.phoneNumber
  • Type: String
Extension extension
  • Field Name: voicemail.faxMessage.extension
  • Type: String
Incoming Permission Incoming Permission settings for a user
  • Field Name: incomingPermission
  • Type: Object
Use Custom Settings Use Custom Settings
  • Field Name: incomingPermission.useCustomEnabled
  • Type: Boolean
Allow External Calls
  • Field Name: incomingPermission.externalTransfer
  • Type: String
  • Choices: ["Allow All External", "Allow Only Transferred External", "Block All External"]
Allow Internal Calls
  • Field Name: incomingPermission.internalCallsEnabled
  • Type: Boolean
Allow Collect Calls
  • Field Name: incomingPermission.collectCallsEnabled
  • Type: Boolean
Outgoing Permission Outgoing Permission settings for a user
  • Field Name: outgoingPermission
  • Type: Object
Use Custom Settings
  • Field Name: outgoingPermission.useCustomEnabled
  • Type: Boolean
Calling Permissions callingPermissions
  • Field Name: callingPermissions.[n]
  • Type: Array
Call Type
  • Field Name: outgoingPermission.callingPermissions.[n].callType
  • Type: String
Action
  • Field Name: outgoingPermission.callingPermissions.[n].action
  • Type: String
  • Choices: ["Allow", "Block", "Auth Code", "Transfer Number 1", "Transfer Number 2", "Transfer Number 3"]
Allow transfers and forwards
  • Field Name: outgoingPermission.callingPermissions.[n].transferEnabled
  • Type: Boolean
Call Forward Call Forward settings for a user
  • Field Name: callForward
  • Type: Object
Call Forwarding Call Forwarding Settings
  • Field Name: callForwarding
  • Type: Object
Always always
  • Field Name: always
  • Type: Object
Enabled
  • Field Name: callForward.callForwarding.always.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: callForward.callForwarding.always.destination
  • Type: String
Ring Reminder Enabled Play a brief tone for forwarded calls
  • Field Name: callForward.callForwarding.always.ringReminderEnabled
  • Type: Boolean
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: callForward.callForwarding.always.destinationVoicemailEnabled
  • Type: Boolean
Busy busy
  • Field Name: busy
  • Type: Object
Enabled
  • Field Name: callForward.callForwarding.busy.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: callForward.callForwarding.busy.destination
  • Type: String
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: callForward.callForwarding.busy.destinationVoicemailEnabled
  • Type: Boolean
No Answer noAnswer
  • Field Name: noAnswer
  • Type: Object
Enabled
  • Field Name: callForward.callForwarding.noAnswer.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: callForward.callForwarding.noAnswer.destination
  • Type: String
Number of rings before forwarding Number of rings before call is forwarded to selected destination
  • Field Name: callForward.callForwarding.noAnswer.numberOfRings
  • Type: Integer
System Max Number Of Rings before forwarding System Max number of rings setting
  • Field Name: callForward.callForwarding.noAnswer.systemMaxNumberOfRings
  • Type: Integer
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: callForward.callForwarding.noAnswer.destinationVoicemailEnabled
  • Type: Boolean
Business Continuity businessContinuity
  • Field Name: businessContinuity
  • Type: Object
Enabled
  • Field Name: callForward.businessContinuity.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: callForward.businessContinuity.destination
  • Type: String
Allow forwarded calls to leave a voicemail This option works if the number you enter is an internal phone number or extension, and the number has voicemail enabled
  • Field Name: callForward.businessContinuity.destinationVoicemailEnabled
  • Type: Boolean
Call Waiting Call Waiting settings for a user
  • Field Name: callWaiting
  • Type: Object
Enabled Receive another call during a call
  • Field Name: callWaiting.enabled
  • Type: Boolean
Intercept Intercept settings for a user
  • Field Name: intercept
  • Type: Object
Enabled You can disconnect this user’s phone line and give callers a detailed announcement and alternative routing options. Incoming and outgoing call intercept settings are configured separately. Any intercept settings defined here will override the default location intercept settings.
  • Field Name: intercept.enabled
  • Type: Boolean
Choose incoming calls permissions for this user.
  • Field Name: incoming
  • Type: Object
Type
  • Field Name: intercept.incoming.type
  • Type: String
  • Choices: ["Intercept All", "Allow All"]
Send calls to voicemail Route all calls to voicemail. If the user doesn’t have voicemail, then the caller will hear the announcement message.
  • Field Name: intercept.incoming.voicemailEnabled
  • Type: Boolean
Announcements announcements
  • Field Name: announcements
  • Type: Object
Announcements
  • Field Name: intercept.incoming.announcements.greeting
  • Type: String
  • Choices: ["Custom", "Default"]
Filename
  • Field Name: intercept.incoming.announcements.filename
  • Type: String
New Number
  • Field Name: newNumber
  • Type: Object
Play new number announcements
  • Field Name: intercept.incoming.announcements.newNumber.enabled
  • Type: Boolean
Destination Destination Number
  • Field Name: intercept.incoming.announcements.newNumber.destination
  • Type: String
Zero Transfer
  • Field Name: zeroTransfer
  • Type: Object
Transfer on '0' to this phone number
  • Field Name: intercept.incoming.announcements.zeroTransfer.enabled
  • Type: Boolean
Destination Destination Number
  • Field Name: intercept.incoming.announcements.zeroTransfer.destination
  • Type: String
Outgoing outgoing
  • Field Name: outgoing
  • Type: Object
Type type
  • Field Name: intercept.outgoing.type
  • Type: String
  • Choices: ["Intercept All", "Allow Local Only"]
Transfer Enabled transferEnabled
  • Field Name: intercept.outgoing.transferEnabled
  • Type: Boolean
Destination destination
  • Field Name: intercept.outgoing.destination
  • Type: String
Monitoring Monitoring settings for a user
  • Field Name: monitoring
  • Type: Object
Call Park Notification Enabled callParkNotificationEnabled
  • Field Name: monitoring.callParkNotificationEnabled
  • Type: Boolean
Member member
  • Field Name: member.[n]
  • Type: Array
Display Name
  • Field Name: monitoring.member.[n].displayName
  • Type: String
Id
  • Field Name: monitoring.member.[n].id
  • Type: String
  • Target: device/spark/UserConfig
  • Target attr: email
  • Format: uri
First Name
  • Field Name: monitoring.member.[n].firstName
  • Type: String
Last Name
  • Field Name: monitoring.member.[n].lastName
  • Type: String
Type
  • Field Name: monitoring.member.[n].type
  • Type: String
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: monitoring.member.[n].email
  • Type: String
Numbers numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: monitoring.member.[n].numbers.[n].external
  • Type: String
Extension
  • Field Name: monitoring.member.[n].numbers.[n].extension
  • Type: String
Primary
  • Field Name: monitoring.member.[n].numbers.[n].primary
  • Type: Boolean
Location
  • Field Name: monitoring.member.[n].location
  • Type: String
LocationId
  • Field Name: monitoring.member.[n].locationId
  • Type: String
Call Park Extension callparkextension
  • Field Name: callparkextension.[n]
  • Type: Array
Name
  • Field Name: monitoring.callparkextension.[n].name
  • Type: String
Id
  • Field Name: monitoring.callparkextension.[n].id
  • Type: String
  • Target: device/spark/CallParkExtensions
  • Target attr: name
  • Format: uri
Extension
  • Field Name: monitoring.callparkextension.[n].extension
  • Type: String
Location
  • Field Name: monitoring.callparkextension.[n].location
  • Type: String
LocationId
  • Field Name: monitoring.callparkextension.[n].locationId
  • Type: String
Call Bridge Call Bridge settings for a user
  • Field Name: callBridge
  • Type: Object
Call bridging warning tone Play an entry tone to all participants upon bridge-in.
  • Field Name: callBridge.warningToneEnabled
  • Type: Boolean
Push To Talk Push To Talk settings for a user
  • Field Name: pushToTalk
  • Type: Object
Auto answer calls
  • Field Name: pushToTalk.allowAutoAnswer
  • Type: Boolean
Connection Type Selecting One-way will allow this user only to talk to others. For others to be able to talk back, Two-way must be selected.
  • Field Name: pushToTalk.connectionType
  • Type: String
  • Choices: ["One Way", "Two Way"]
Type of Access for Users
  • Field Name: pushToTalk.accessType
  • Type: String
  • Choices: ["Allow Members", "Block Members"]
Members members
  • Field Name: members.[n]
  • Type: Array
Display Name
  • Field Name: pushToTalk.members.[n].displayName
  • Type: String
Id
  • Field Name: pushToTalk.members.[n].id
  • Type: String
  • Target: device/spark/UserConfig
  • Target attr: email
  • Format: uri
First Name
  • Field Name: pushToTalk.members.[n].firstName
  • Type: String
Last Name
  • Field Name: pushToTalk.members.[n].lastName
  • Type: String
Type
  • Field Name: pushToTalk.members.[n].type
  • Type: String
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: pushToTalk.members.[n].email
  • Type: String
Numbers numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: pushToTalk.members.[n].numbers.[n].external
  • Type: String
Extension
  • Field Name: pushToTalk.members.[n].numbers.[n].extension
  • Type: String
Primary
  • Field Name: pushToTalk.members.[n].numbers.[n].primary
  • Type: Boolean
Call Recording Call Recording settings for a user
  • Field Name: callRecording
  • Type: Object
Enabled
  • Field Name: callRecording.enabled
  • Type: Boolean
Start Recording Criteria for recording a call
  • Field Name: callRecording.record
  • Type: String
  • Choices: ["Always", "Never", "Always with Pause/Resume", "On Demand with User Initiated Start"]
Record voice messaging
  • Field Name: callRecording.recordVoicemailEnabled
  • Type: Boolean
Recording start/stop announcement Manage playing audible announcements when recording starts or stops. You can control audible announcements for internal and PSTN calls
  • Field Name: startStopAnnouncement
  • Type: Object
Play recording start/stop announcement for internal calls
  • Field Name: callRecording.startStopAnnouncement.internalCallsEnabled
  • Type: Boolean
Play recording start/stop announcement for PSTN calls
  • Field Name: callRecording.startStopAnnouncement.pstnCallsEnabled
  • Type: Boolean
Notification Recording Reminder Tone
  • Field Name: notification
  • Type: Object
Type type
  • Field Name: callRecording.notification.type
  • Type: String
  • Choices: ["None", "Beep", "Play Announcement"]
Enabled enabled
  • Field Name: callRecording.notification.enabled
  • Type: Boolean
Repeat repeat
  • Field Name: repeat
  • Type: Object
Repeat interval
  • Field Name: callRecording.repeat.interval
  • Type: Integer
  • Choices: ["10", "20", "30", "40", "50", "60", "70", "80", "90"]
Enabled
  • Field Name: callRecording.repeat.enabled
  • Type: Boolean
Service Provider
  • Field Name: callRecording.serviceProvider
  • Type: String
External Group
  • Field Name: callRecording.externalGroup
  • Type: String
External Identifier
  • Field Name: callRecording.externalIdentifier
  • Type: String
Executive Assistant Executive Assistant settings for a user
  • Field Name: executiveAssistant
  • Type: Object
Type This service allows an Executive to select from a pool of Assistants, who have been assigned the Executive Assistant feature and who can answer or place calls on their behalf.
  • Field Name: executiveAssistant.type
  • Type: String
  • Choices: ["Unassigned", "Executive", "Executive Assistant"]
Barge In Barge In settings for a user
  • Field Name: bargeIn
  • Type: Object
Enabled Allow other users to add themselves to this user’s ongoing call, making it a conference call.
  • Field Name: bargeIn.enabled
  • Type: Boolean
Tone Enabled Play a tone when this user Barges In on a call
  • Field Name: bargeIn.toneEnabled
  • Type: Boolean
Receptionist Receptionist settings for a user
  • Field Name: receptionist
  • Type: Object
Reception Enabled receptionEnabled
  • Field Name: receptionist.receptionEnabled
  • Type: Boolean
Monitored Members monitoredMembers
  • Field Name: monitoredMembers.[n]
  • Type: Array
Id
  • Field Name: receptionist.monitoredMembers.[n].id
  • Type: String
  • Target: device/spark/UserConfig
  • Target attr: email
  • Format: uri
Last Name
  • Field Name: receptionist.monitoredMembers.[n].lastName
  • Type: String
First Name
  • Field Name: receptionist.monitoredMembers.[n].firstName
  • Type: String
Display Name
  • Field Name: receptionist.monitoredMembers.[n].displayName
  • Type: String
Type
  • Field Name: receptionist.monitoredMembers.[n].type
  • Type: String
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: receptionist.monitoredMembers.[n].email
  • Type: String
Numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: receptionist.monitoredMembers.[n].numbers.[n].external
  • Type: String
Extension
  • Field Name: receptionist.monitoredMembers.[n].numbers.[n].extension
  • Type: String
Primary
  • Field Name: receptionist.monitoredMembers.[n].numbers.[n].primary
  • Type: String
Hoteling Hoteling settings for a user
  • Field Name: hoteling
  • Type: Object
Enabled enabled
  • Field Name: hoteling.enabled
  • Type: Boolean
Privacy Privacy settings for a user
  • Field Name: privacy
  • Type: Object
AA Extension Dialing Enabled Allow this user to be dialled by extension
  • Field Name: privacy.aaExtensionDialingEnabled
  • Type: Boolean
AA Naming Dialing Enabled Allow this user to be dialled by first or last name
  • Field Name: privacy.aaNamingDialingEnabled
  • Type: Boolean
Enable Phone Status Directory Privacy Only the users selected below will be allowed to monitor this user's phone-line status.
  • Field Name: privacy.enablePhoneStatusDirectoryPrivacy
  • Type: Boolean
Monitoring Agents monitoringAgents
  • Field Name: monitoringAgents.[n]
  • Type: Array
Display Name
  • Field Name: privacy.monitoringAgents.[n].displayName
  • Type: String
Id
  • Field Name: privacy.monitoringAgents.[n].id
  • Type: String
  • Target: device/spark/UserConfig
  • Target attr: email
  • Format: uri
Last Name
  • Field Name: privacy.monitoringAgents.[n].lastName
  • Type: String
First Name
  • Field Name: privacy.monitoringAgents.[n].firstName
  • Type: String
Type
  • Field Name: privacy.monitoringAgents.[n].type
  • Type: String
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: privacy.monitoringAgents.[n].email
  • Type: String
Location location
  • Field Name: location
  • Type: Object
Name name
  • Field Name: privacy.monitoringAgents.[n].location.name
  • Type: String
Id id
  • Field Name: privacy.monitoringAgents.[n].location.id
  • Type: String
Numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: privacy.monitoringAgents.[n].numbers.[n].external
  • Type: String
Extension
  • Field Name: privacy.monitoringAgents.[n].numbers.[n].extension
  • Type: String
Primary
  • Field Name: privacy.monitoringAgents.[n].numbers.[n].primary
  • Type: Boolean
Caller Id Caller ID settings for a user
  • Field Name: caller_id
  • Type: Object
Types types
  • Field Name: types.[n]
  • Type: Array
Selected CLI Source Selected the required source of the Caller ID
  • Field Name: caller_id.selected
  • Type: String
  • Choices: ["Direct Line", "Location Number", "Mobile Number", "Custom"]
Direct Line The user's direct number
  • Field Name: caller_id.directNumber
  • Type: String
Extension Number The user's extension number
  • Field Name: caller_id.extensionNumber
  • Type: String
Location Number The number specified for the location
  • Field Name: caller_id.locationNumber
  • Type: String
Mobile Number The user's mobile number
  • Field Name: caller_id.mobileNumber
  • Type: String
Location Number is Toll free The location number is a toll free number
  • Field Name: caller_id.tollFreeLocationNumber
  • Type: Boolean
Custom Number A custom number for the user
  • Field Name: caller_id.customNumber
  • Type: String
First Name
  • Field Name: caller_id.firstName
  • Type: String
Last Name
  • Field Name: caller_id.lastName
  • Type: String
Block caller ID for received calls Block this user's identity when receiving a call.
  • Field Name: caller_id.blockInForwardCallsEnabled
  • Type: Boolean
Selected Caller Name Source Selected the required source of the Caller Name
  • Field Name: caller_id.externalCallerIdNamePolicy
  • Type: String
  • Choices: ["Direct Line", "Location", "Other"]
Custom Name A custom name for the user
  • Field Name: caller_id.customExternalCallerIdName
  • Type: String
Location Name The name specified for the location
  • Field Name: caller_id.locationExternalCallerIdName
  • Type: String
Devices Devices associated with a user
  • Field Name: devices
  • Type: Object
Max Device Count maxDeviceCount
  • Field Name: devices.maxDeviceCount
  • Type: Integer
Device Device
  • Field Name: device.[n]
  • Type: Array
Link Link to jump to the device details.
  • Field Name: devices.device.[n].link
  • Type: String
  • Format: link
Mac Address
  • Field Name: devices.device.[n].mac
  • Type: String
Model
  • Field Name: devices.device.[n].model
  • Type: String
Type
  • Field Name: devices.device.[n].type
  • Type: String
Id
  • Field Name: devices.device.[n].id
  • Type: String
Activation State
  • Field Name: devices.device.[n].activationState
  • Type: String
Description
  • Field Name: description.[n]
  • Type: Array
Primary Owner
  • Field Name: devices.device.[n].primaryOwner
  • Type: Boolean
Owner
  • Field Name: owner
  • Type: Object
Id id
  • Field Name: devices.device.[n].owner.id
  • Type: String
Type type
  • Field Name: devices.device.[n].owner.type
  • Type: String
First Name
  • Field Name: devices.device.[n].owner.firstName
  • Type: String
Last Name
  • Field Name: devices.device.[n].owner.lastName
  • Type: String
Hoteling
  • Field Name: hoteling
  • Type: Object
Limit Guest Use
  • Field Name: devices.device.[n].hoteling.limitGuestUse
  • Type: Boolean
Enabled Allow this device to be used as a hotelling host by visiting guests
  • Field Name: devices.device.[n].hoteling.enabled
  • Type: Boolean
Guest Hours Limit Limit the time a guest can use this phone
  • Field Name: devices.device.[n].hoteling.guestHoursLimit
  • Type: Integer