[Index]

Model: relation/SparkUser

Webex User Details

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

On the Webex User Details page (relation/SparkUser) you can view a list of Webex users in Automate, and click on a user to view or configure their settings.

Note

Webex user details settings

This topic describes the Webex user details settings you can configure when adding or updating a Webex user on the Webex User Details page (relation/SparkUser).

The Webex User Details page provides the following settings:

Account Details & Calling Type tab/panel

This tab/panel configures a Webex user's account details and calling type.

Important

On directory-synced Webex Control Hubs, certain identity fields are managed externally (for example, by LDAP) and can't be modified in Webex. To prevent failures during provisioning, VOSS automatically suppresses updates to these fields.

The following fields are read-only in the VOSS GUI - Webex Quick User and Webex User Details (relation/SparkUser) and are ignored (not sent to Webex) during provisioning when the customer is directory‑synced:

If you attempt to change one of these values, VOSS preserves the existing value from Webex Control Hub and does not attempt an update. This prevents Webex from returning update errors for directory-synced users.

Roles & Address tab/panel

The Roles & Addresses tab/panel configures the Webex user's roles and addresses. Here you can select the relevant roles:

Wholesale Package settings

The Wholesale Package tab/panel (if available) manages settings for packages in the Webex for Wholesale service, and their status, for example, provisioned.

This tab/panel displays only when the Webex for Wholesale service is available. See Webex Application Access (Webex Organization) in the User Guide.

Depending on the package selected, the user's assigned licenses, as available on the Webex for Wholesale service, are then also updated when the user is provisioned.

Note

When modifying a Webex user and UCM Calling Licensing is deleted and the work phone number is also set to empty, the number is removed from the user. Work phone number remains assigned to the user if it's not set to empty.

Calling settings tab/panel

This tab/panel configures a Webex user's calling settings:

How Caller ID works for Webex users in VOSS

Cisco Webex has deprecated (March 2026) the old Caller ID and dial-by name fields (firstName, lastName, and virtual-line callerIdFirstName/callerIdLastName).

VOSS now users the updated Webex schema fields (directLineCallerIdName.selection, directLineCallerIdName.customName, dialByFirstName, dialByLastName) and includes transition logic where the new fields take precedence when both are present. Deprecated-only inputs are converted automatically, ensuring full compatibility with the updated Webex APIs for both users and virtual lines.

Where Caller ID is configured for Webex users in VOSS, the Caller ID uses the Direct Line Caller ID Name fields:

The caller ID name is determined by the value of Selection:

Dial-by names are generated via the following fields:

Contact Center tab/panel

This tab/panel configures Contact Center settings, which display only if a user is assigned a Contact Center Premium Agent license. Settings include:

Related topics

For further details, see:

Webex Contact Center Desktop Experience in the Core Feature Guide

View, add, update, or delete a Webex user

This procedure displays, updates, or adds a Webex user via the Webex User details page (relation/SparkUser).

  1. Log in to the Admin Portal as a Provider, Reseller, Customer, or Site administrator.

  2. Go to the Webex User Details list view.

  3. Select a user to view or manage their account.

  4. Do you want to ...

    • Add a Webex user? Click the Plus icon (+) to add a new record, then choose the relevant site. Configure the user, then save. The Webex user is added. See Webex user details settings
    • Delete a Webex user? From the list view, select users to delete, one or more; then, click the Delete icon. Click Yes to confirm. The internal number inventory (INI) is updated as the number status is changed to Available, and the description, if any, is removed.
    • Update a Webex user? Click the user to open its management page. Update settings, then save. See Webex user details settings

  5. Save your changes.

    The summary list view provides further details:

    • On-Prem UCM Calling Service (True/False): Defines whether calling services are on-premise or cloud. The On-Prem UCM Calling license is removed if the Cisco Webex Calling (with UCM) is removed from the user.
    • Calling Behavior
    • Use Organization's Domain (True/False): When enabled, the Cisco Webex organization domain is used for calling in Cisco Webex (Unified CM)
    • UC Manager Profile: May be used to identify the required UCM cluster when a calling behavior using UCM is selected. If the default UCM domain is selected, this is not required.
    • User Type: "Person", "Bot" or "App User (Guest User)".
    • Status: The current Cisco Webex App user status. For example, active/inactive, in a call/meeting/presenting, and so on. If unknown, then displayed as, "The user status could not be determined".

Related topics

This relation implements the workflows to manage Spark Users.

Model Details: relation/SparkUser

Title Description Details
Id
  • Field Name: id
  • Type: String
  • MaxLength: 1024
Avatar
  • Field Name: avatar
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: lastName
  • Type: String
  • MaxLength: 1024
Email Address *
  • Field Name: email
  • Type: String
  • MaxLength: 1024
Webex Calling - Professional
  • Field Name: calling_pro
  • Type: Boolean
Webex Contact Center
  • Field Name: contact_center
  • Type: Boolean
Work Phone Work number for the person. e.g. +1 408 526 7209. This is only settable for a person with a Webex Calling license.
  • Field Name: workNumber
  • Type: String
  • MaxLength: 1024
Extension Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.
  • Field Name: extension
  • Type: String
  • MaxLength: 1024
Mobile Phone Mobile number for the person. e.g. +1 408 526 7209.
  • Field Name: mobileNumber
  • Type: String
  • MaxLength: 1024
Alternative Phone 1 First alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeOneNumber
  • Type: String
  • MaxLength: 1024
Alternative Phone 2 Second alternative number for the person. e.g. +1 408 526 7209.
  • Field Name: alternativeTwoNumber
  • Type: String
  • MaxLength: 1024
Phone Numbers Phone numbers for the person. Only settable for Webex Calling. Needs a Webex Calling license.
  • Field Name: phoneNumbers.[n]
  • Type: Array
Type The type of phone number.
  • Field Name: phoneNumbers.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Work", "Mobile", "Fax"]
Number The phone number e.g. +1 408 526 7209
  • Field Name: phoneNumbers.[n].value
  • Type: String
  • MaxLength: 1024
Primary Whether this is the primary phone number
  • Field Name: phoneNumbers.[n].primary
  • Type: Boolean
Phone Number Type Internal field: PRIMARY or SECONDARY (used for processing, converted to primary boolean)
  • Field Name: phoneNumbers.[n].phoneNumberType
  • Type: String
  • MaxLength: 1024
SIP Addresses The users sip addresses.
  • Field Name: sipAddresses.[n]
  • Type: Array
Type The type of SIP address.
  • Field Name: sipAddresses.[n].type
  • Type: String
  • MaxLength: 1024
Number The SIP address
  • Field Name: sipAddresses.[n].value
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: sipAddresses.[n].primary
  • Type: Boolean
Addresses The users addresses.
  • Field Name: addresses.[n]
  • Type: Array
Type The type of address.
  • Field Name: addresses.[n].type
  • Type: String
  • MaxLength: 1024
Country The user's country. Example value: US
  • Field Name: addresses.[n].country
  • Type: String
  • MaxLength: 1024
Locality The user's locality, often city. Example value: Milpitas
  • Field Name: addresses.[n].locality
  • Type: String
  • MaxLength: 1024
Region The user's region, often state. Example value: California
  • Field Name: addresses.[n].region
  • Type: String
  • MaxLength: 1024
Street Address The user's street. Example value: 1099 Bird Ave.
  • Field Name: addresses.[n].streetAddress
  • Type: String
  • MaxLength: 1024
Postal Code The user's postal or zip code. Example value: 99212
  • Field Name: addresses.[n].postalCode
  • Type: String
  • MaxLength: 1024
Display Name *
  • Field Name: displayName
  • Type: String
  • MaxLength: 1024
Nickname
  • Field Name: nickName
  • Type: String
  • MaxLength: 1024
Department
  • Field Name: department
  • Type: String
  • MaxLength: 1024
Manager
  • Field Name: manager
  • Type: String
  • MaxLength: 1024
Manager ID
  • Field Name: managerId
  • Type: String
  • MaxLength: 1024
Title
  • Field Name: title
  • Type: String
  • MaxLength: 1024
Time Zone
  • Field Name: timezone
  • Type: String
  • MaxLength: 1024
Location
  • Field Name: locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Date Created
  • Field Name: created
  • Type: String
  • MaxLength: 1024
  • Format: date-time
Last Modified
  • Field Name: lastModified
  • Type: String
  • MaxLength: 1024
  • Format: date-time
Status
  • Field Name: status
  • Type: String
  • MaxLength: 1024
User Type Default: person
  • Field Name: type
  • Type: String
  • Default: person
  • MaxLength: 1024
  • Choices: ["Person", "Bot", "App User (Guest User)"]
Invite Pending
  • Field Name: invitePending
  • Type: Boolean
Login Enabled
  • Field Name: loginEnabled
  • Type: Boolean
Field to pass selected number from QAS workflow
  • Field Name: line
  • Type: String
  • MaxLength: 1024
Roles
  • Field Name: roles
  • Type: Object
No administrator privileges Default: true
  • Field Name: roles.none
  • Type: Boolean
  • Default: true
Full administrator privileges - User Management - Company Policy & Templates - Analytics & Reports - Support Metrics & Notifications - Licenses & Upgrades - Assign Roles
  • Field Name: roles.full
  • Type: Boolean
Read-only administrator privileges Read-only view of the portal. No changes will be accepted.
  • Field Name: roles.readonly
  • Type: Boolean
Support Administrator - Analytics & Reports - Support Metrics & Notifications
  • Field Name: roles.support
  • Type: Boolean
User and Device Administrator - User Management - Device Management - Licenses & Upgrades
  • Field Name: roles.user_device
  • Type: Boolean
Device Administrator - Device Management
  • Field Name: roles.device
  • Type: Boolean
Advanced Help Desk Administrator - Advanced Help Desk Management
  • Field Name: roles.advanced_help_desk
  • Type: Boolean
Help Desk Administrator - Help Desk Management
  • Field Name: roles.help_desk
  • Type: Boolean
Partner Administrator - Partner Administration
  • Field Name: roles.partner
  • Type: Boolean
Partner Full Administrator - Full Partner Administration
  • Field Name: roles.partner_full
  • Type: Boolean
Partner Read-only Administrator - Read-only Partner Administration
  • Field Name: roles.partner_readonly
  • Type: Boolean
Wholesale Administrator - Wholesale Administration
  • Field Name: roles.wholesale
  • Type: Boolean
Assigned Licenses
  • Field Name: licenses.[n]
  • Type: Array
License Select the license to assign to this user.
  • Field Name: licenses.[n].license
  • Type: String
  • Target: device/spark/License
  • Target attr: unique_name
  • MaxLength: 1024
  • Format: uri
Settings
  • Field Name: settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how a user makes calls in Webex App.
  • Field Name: settings.calling.calling_behaviour
  • Type: String
  • MaxLength: 1024
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Use Organization's Domain Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)
  • Field Name: settings.calling.use_org_domain
  • Type: Boolean
UC Manager Profile
  • Field Name: settings.calling.calling_behaviour_uc_manager_profile
  • Type: String
  • Target: device/spark/CallingProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Create iPhone Device Default: true
  • Field Name: settings.calling.SparkiPhoneDevice
  • Type: Boolean
  • Default: true
Create Android Device Default: true
  • Field Name: settings.calling.SparkAndroidDevice
  • Type: Boolean
  • Default: true
Create Tablet Device Default: true
  • Field Name: settings.calling.SparkTabletDevice
  • Type: Boolean
  • Default: true
Create CSF Device Default: true
  • Field Name: settings.calling.SparkCSFDevice
  • Type: Boolean
  • Default: true
Spark Services
  • Field Name: SparkServices
  • Type: Object
name
  • Field Name: SparkServices.name
  • Type: String
  • MaxLength: 1024
configuredCallingBehaviour
  • Field Name: SparkServices.configuredCallingBehaviour
  • Type: String
  • MaxLength: 1024
Contact Center
  • Field Name: ContactCenter
  • Type: Object
Organization ID
  • Field Name: ContactCenter.organizationId
  • Type: String
  • MaxLength: 1024
ID
  • Field Name: ContactCenter.id
  • Type: String
  • MaxLength: 1024
Version
  • Field Name: ContactCenter.version
  • Type: Integer
First Name
  • Field Name: ContactCenter.firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: ContactCenter.lastName
  • Type: String
  • MaxLength: 1024
Email
  • Field Name: ContactCenter.email
  • Type: String
  • MaxLength: 1024
Work Phone
  • Field Name: ContactCenter.workPhone
  • Type: String
  • MaxLength: 1024
Mobile
  • Field Name: ContactCenter.mobile
  • Type: String
  • MaxLength: 1024
Common Identity User ID
  • Field Name: ContactCenter.ciUserId
  • Type: String
  • MaxLength: 1024
Broad Cloud User ID
  • Field Name: ContactCenter.broadCloudUserId
  • Type: String
  • MaxLength: 1024
Timezone
  • Field Name: ContactCenter.timezone
  • Type: String
  • MaxLength: 1024
XSP Version
  • Field Name: ContactCenter.xspVersion
  • Type: String
  • MaxLength: 1024
Subscription ID
  • Field Name: ContactCenter.subscriptionId
  • Type: String
  • MaxLength: 1024
User Profile ID
  • Field Name: ContactCenter.userProfileId
  • Type: String
  • Target: device/spark/CXUserProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Contact Center Enabled
  • Field Name: ContactCenter.contactCenterEnabled
  • Type: Boolean
Site ID
  • Field Name: ContactCenter.siteId
  • Type: String
  • Target: device/spark/CXSite
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Team IDs
  • Field Name: teamIds.[n]
  • Type: Array
Skill Profile ID
  • Field Name: ContactCenter.skillProfileId
  • Type: String
  • Target: device/spark/CXSkillProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Agent Profile ID
  • Field Name: ContactCenter.agentProfileId
  • Type: String
  • MaxLength: 1024
Multimedia Profile ID
  • Field Name: ContactCenter.multimediaProfileId
  • Type: String
  • Target: device/spark/CXMultimediaProfile
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Default Dialled Number
  • Field Name: ContactCenter.deafultDialledNumber
  • Type: String
  • MaxLength: 1024
External Identifier
  • Field Name: ContactCenter.externalIdentifier
  • Type: String
  • MaxLength: 1024
Active
  • Field Name: ContactCenter.active
  • Type: Boolean
db ID
  • Field Name: ContactCenter.dbId
  • Type: String
  • MaxLength: 1024
User Profile Data
  • Field Name: userProfileData
  • Type: Object
Organization ID
  • Field Name: ContactCenter.userProfileData.organizationId
  • Type: String
  • MaxLength: 1024
ID
  • Field Name: ContactCenter.userProfileData.id
  • Type: String
  • MaxLength: 1024
Version
  • Field Name: ContactCenter.userProfileData.version
  • Type: Integer
Name
  • Field Name: ContactCenter.userProfileData.name
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: ContactCenter.userProfileData.description
  • Type: String
  • MaxLength: 1024
Profile Type
  • Field Name: ContactCenter.userProfileData.profileType
  • Type: String
  • MaxLength: 1024
  • Choices: ["STANDARD_AGENT", "PREMIUM_AGENT", "SUPERVISOR", "ADMINISTRATOR", "ADMINISTRATOR_ONLY"]
Access All Modules
  • Field Name: ContactCenter.userProfileData.accessAllModules
  • Type: String
  • MaxLength: 1024
  • Choices: ["ALL", "SPECIFIC"]
User Profile App Modules
  • Field Name: userProfileAppModules.[n]
  • Type: Array
Organization ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].organizationId
  • Type: String
  • MaxLength: 1024
ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].id
  • Type: String
  • MaxLength: 1024
Version
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].version
  • Type: Integer
App Module ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].appModuleId
  • Type: String
  • MaxLength: 1024
Module Access Type
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].moduleAccessType
  • Type: String
  • MaxLength: 1024
  • Choices: ["VIEW", "EDI", "NONE"]
userProfileAppFeature
  • Field Name: userProfileAppFeature
  • Type: Object
Organization ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.organizationId
  • Type: String
  • MaxLength: 1024
ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.id
  • Type: String
  • MaxLength: 1024
Version
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.version
  • Type: Integer
App Feature ID
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.appFeatureId
  • Type: String
  • MaxLength: 1024
App Feature Name
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.appFeatureName
  • Type: String
  • MaxLength: 1024
Feature Access Type
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.featureAccessType
  • Type: String
  • MaxLength: 1024
  • Choices: ["OFF", "ON"]
Created Time
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.createdTime
  • Type: Integer
Last Updated Time
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].userProfileAppFeature.lastUpdatedTime
  • Type: Integer
Created Time
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].createdTime
  • Type: Integer
Last Updated Time
  • Field Name: ContactCenter.userProfileData.userProfileAppModules.[n].lastUpdatedTime
  • Type: Integer
Access All Entry Points
  • Field Name: ContactCenter.userProfileData.accessAllEntryPoints
  • Type: String
  • MaxLength: 1024
  • Choices: ["ALL", "SPECIFIC"]
Access All Sites
  • Field Name: ContactCenter.userProfileData.accessAllSites
  • Type: String
  • MaxLength: 1024
  • Choices: ["ALL", "SPECIFIC"]
Access All Queues
  • Field Name: ContactCenter.userProfileData.accessAllQueues
  • Type: String
  • MaxLength: 1024
  • Choices: ["ALL", "SPECIFIC"]
Access All Teams
  • Field Name: ContactCenter.userProfileData.accessAllTeams
  • Type: String
  • MaxLength: 1024
  • Choices: ["ALL", "SPECIFIC"]
active
  • Field Name: ContactCenter.userProfileData.active
  • Type: Boolean
Editable Folder IDs
  • Field Name: editableFolderIds.[n]
  • Type: Array
Viewable Folder IDs
  • Field Name: viewableFolderIds.[n]
  • Type: Array
Non Viewable Folder IDs
  • Field Name: nonViewableFolderIds.[n]
  • Type: Array
System Default
  • Field Name: ContactCenter.userProfileData.systemDefault
  • Type: Boolean
Created Time
  • Field Name: ContactCenter.userProfileData.createdTime
  • Type: Integer
Last Updated Time
  • Field Name: ContactCenter.userProfileData.lastUpdatedTime
  • Type: Integer
Entry Points
  • Field Name: entryPoints.[n]
  • Type: Array
Sites
  • Field Name: sites.[n]
  • Type: Array
Queues
  • Field Name: queues.[n]
  • Type: Array
Teams
  • Field Name: teams.[n]
  • Type: Array
IMI User Created
  • Field Name: ContactCenter.imiUserCreated
  • Type: Boolean
Preferred Supervisor Team ID
  • Field Name: ContactCenter.preferredSupervisorTeamId
  • Type: String
  • MaxLength: 1024
System Default
  • Field Name: ContactCenter.systemDefault
  • Type: Boolean
User Level Burnout Inclusion
  • Field Name: ContactCenter.userLevelBurnoutInclusion
  • Type: String
  • MaxLength: 1024
User Level Auto CSAT Inclusion
  • Field Name: ContactCenter.userLevelAutoCSATInclusion
  • Type: String
  • MaxLength: 1024
Created Time
  • Field Name: ContactCenter.createdTime
  • Type: Integer
Last Updated Time
  • Field Name: ContactCenter.lastUpdatedTime
  • Type: Integer
References references to Address Book entries
  • Field Name: references.[n]
  • Type: Array
Name Name
  • Field Name: ContactCenter.references.[n].name
  • Type: String
  • MaxLength: 1024
Reference Model Type Type
  • Field Name: ContactCenter.references.[n].type
  • Type: String
  • MaxLength: 1024
ID ID
  • Field Name: ContactCenter.references.[n].id
  • Type: String
  • MaxLength: 1024
Wholesale
  • Field Name: Wholesale
  • Type: Object
Id
  • Field Name: Wholesale.id
  • Type: String
  • MaxLength: 1024
personId
  • Field Name: Wholesale.personId
  • Type: String
  • MaxLength: 1024
email
  • Field Name: Wholesale.email
  • Type: String
  • MaxLength: 1024
customerId
  • Field Name: Wholesale.customerId
  • Type: String
  • MaxLength: 1024
externalCustomerId
  • Field Name: Wholesale.externalCustomerId
  • Type: String
  • MaxLength: 1024
Packages
  • Field Name: packages.[n]
  • Type: Array
Provisioning Parameters
  • Field Name: provisioningParameters
  • Type: Object
Primary Phone Number
  • Field Name: Wholesale.provisioningParameters.primaryPhoneNumber
  • Type: String
  • MaxLength: 1024
Extension
  • Field Name: Wholesale.provisioningParameters.extension
  • Type: String
  • MaxLength: 1024
Location
  • Field Name: Wholesale.provisioningParameters.locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
First Name
  • Field Name: Wholesale.provisioningParameters.firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Wholesale.provisioningParameters.lastName
  • Type: String
  • MaxLength: 1024
status
  • Field Name: Wholesale.status
  • Type: String
  • MaxLength: 1024
package
  • Field Name: Wholesale.package
  • Type: String
  • MaxLength: 1024
Errors
  • Field Name: errors.[n]
  • Type: Array
errorCode
  • Field Name: Wholesale.errors.[n].errorCode
  • Type: Integer
description
  • Field Name: Wholesale.errors.[n].description
  • Type: String
  • MaxLength: 1024
created
  • Field Name: Wholesale.created
  • Type: String
  • MaxLength: 1024
lastStatusChange
  • Field Name: Wholesale.lastStatusChange
  • Type: String
  • MaxLength: 1024
Calling
  • Field Name: Calling
  • Type: Object
Id
  • Field Name: Calling.id
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.lastName
  • Type: String
  • MaxLength: 1024
Display Name
  • Field Name: Calling.displayName
  • Type: String
  • MaxLength: 1024
Email Address *
  • Field Name: Calling.email
  • Type: String
  • MaxLength: 1024
Webex Calling - Professional
  • Field Name: Calling.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: Calling.dnd.enabled
  • Type: Boolean
Ring Splash Enabled Enable ring reminder on your Cisco IP phone
  • Field Name: Calling.dnd.ringSplashEnabled
  • Type: Boolean
Webex Go Override Enabled if a mobile device will still ring even if Do Not Disturb is enabled.
  • Field Name: Calling.dnd.webexGoOverrideEnabled
  • Type: Boolean
Voicemail Voicemail settings for a user
  • Field Name: voicemail
  • Type: Object
Enabled
  • Field Name: Calling.voicemail.enabled
  • Type: Boolean
Send All Calls
  • Field Name: sendAllCalls
  • Type: Object
Send all incoming calls to voicemail
  • Field Name: Calling.voicemail.sendAllCalls.enabled
  • Type: Boolean
Send Busy Calls
  • Field Name: sendBusyCalls
  • Type: Object
Send calls to voicemail when the line is engaged
  • Field Name: Calling.voicemail.sendBusyCalls.enabled
  • Type: Boolean
Greeting
  • Field Name: Calling.voicemail.sendBusyCalls.greeting
  • Type: String
  • MaxLength: 1024
  • Choices: ["Custom", "Default"]
Greeting Uploaded greetingUploaded
  • Field Name: Calling.voicemail.sendBusyCalls.greetingUploaded
  • Type: Boolean
Send Unanswered Calls
  • Field Name: sendUnansweredCalls
  • Type: Object
Send calls to voicemail when unanswered
  • Field Name: Calling.voicemail.sendUnansweredCalls.enabled
  • Type: Boolean
Greeting
  • Field Name: Calling.voicemail.sendUnansweredCalls.greeting
  • Type: String
  • MaxLength: 1024
  • Choices: ["Custom", "Default"]
Greeting Uploaded greetingUploaded
  • Field Name: Calling.voicemail.sendUnansweredCalls.greetingUploaded
  • Type: Boolean
Number of rings before playing the ‘no answer’ message
  • Field Name: Calling.voicemail.sendUnansweredCalls.numberOfRings
  • Type: Integer
System Max Number Of Rings before forwarding to voicemail System Max number of rings setting
  • Field Name: Calling.voicemail.sendUnansweredCalls.systemMaxNumberOfRings
  • Type: Integer
Notifications
  • Field Name: notifications
  • Type: Object
Receive notification of any new voice messages
  • Field Name: Calling.voicemail.notifications.enabled
  • Type: Boolean
Destination email
  • Field Name: Calling.voicemail.notifications.destination
  • Type: String
  • MaxLength: 1024
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: Calling.voicemail.transferToNumber.enabled
  • Type: Boolean
Destination Transfer callers to this phone number
  • Field Name: Calling.voicemail.transferToNumber.destination
  • Type: String
  • MaxLength: 1024
Email Copy Of Message
  • Field Name: emailCopyOfMessage
  • Type: Object
Email a copy of the voicemail message
  • Field Name: Calling.voicemail.emailCopyOfMessage.enabled
  • Type: Boolean
Email Id Use this email address for voicemail messages
  • Field Name: Calling.voicemail.emailCopyOfMessage.emailId
  • Type: String
  • MaxLength: 1024
Message Storage messageStorage
  • Field Name: messageStorage
  • Type: Object
Mwi Enabled mwiEnabled
  • Field Name: Calling.voicemail.messageStorage.mwiEnabled
  • Type: Boolean
Storage Type
  • Field Name: Calling.voicemail.messageStorage.storageType
  • Type: String
  • MaxLength: 1024
  • Choices: ["Internal", "External"]
External Email externalEmail
  • Field Name: Calling.voicemail.messageStorage.externalEmail
  • Type: String
  • MaxLength: 1024
Fax Message faxMessage
  • Field Name: faxMessage
  • Type: Object
Enabled enabled
  • Field Name: Calling.voicemail.faxMessage.enabled
  • Type: Boolean
Phone Number phoneNumber
  • Field Name: Calling.voicemail.faxMessage.phoneNumber
  • Type: String
  • MaxLength: 1024
Extension extension
  • Field Name: Calling.voicemail.faxMessage.extension
  • Type: String
  • MaxLength: 1024
Voice Message Forwarding Enabled Voice Message Forwarding option boolean
  • Field Name: Calling.voicemail.voiceMessageForwardingEnabled
  • Type: Boolean
Incoming Permission Incoming Permission settings for a user
  • Field Name: incomingPermission
  • Type: Object
Use Custom Settings Use Custom Settings
  • Field Name: Calling.incomingPermission.useCustomEnabled
  • Type: Boolean
Allow External Calls
  • Field Name: Calling.incomingPermission.externalTransfer
  • Type: String
  • MaxLength: 1024
  • Choices: ["Allow All External", "Allow Only Transferred External", "Block All External"]
Allow Internal Calls
  • Field Name: Calling.incomingPermission.internalCallsEnabled
  • Type: Boolean
Allow Collect Calls
  • Field Name: Calling.incomingPermission.collectCallsEnabled
  • Type: Boolean
Outgoing Permission Outgoing Permission settings for a user
  • Field Name: outgoingPermission
  • Type: Object
Use Custom Settings
  • Field Name: Calling.outgoingPermission.useCustomEnabled
  • Type: Boolean
Calling Permissions callingPermissions
  • Field Name: callingPermissions.[n]
  • Type: Array
Call Type
  • Field Name: Calling.outgoingPermission.callingPermissions.[n].callType
  • Type: String
  • MaxLength: 1024
Action
  • Field Name: Calling.outgoingPermission.callingPermissions.[n].action
  • Type: String
  • MaxLength: 1024
  • Choices: ["Allow", "Block", "Auth Code", "Transfer Number 1", "Transfer Number 2", "Transfer Number 3"]
Allow transfers and forwards
  • Field Name: Calling.outgoingPermission.callingPermissions.[n].transferEnabled
  • Type: Boolean
Is Call Type Restriction Enabled
  • Field Name: Calling.outgoingPermission.callingPermissions.[n].isCallTypeRestrictionEnabled
  • 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: Calling.callForward.callForwarding.always.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: Calling.callForward.callForwarding.always.destination
  • Type: String
  • MaxLength: 1024
Ring Reminder Enabled Play a brief tone for forwarded calls
  • Field Name: Calling.callForward.callForwarding.always.ringReminderEnabled
  • Type: Boolean
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: Calling.callForward.callForwarding.always.destinationVoicemailEnabled
  • Type: Boolean
Busy busy
  • Field Name: busy
  • Type: Object
Enabled
  • Field Name: Calling.callForward.callForwarding.busy.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: Calling.callForward.callForwarding.busy.destination
  • Type: String
  • MaxLength: 1024
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: Calling.callForward.callForwarding.busy.destinationVoicemailEnabled
  • Type: Boolean
No Answer noAnswer
  • Field Name: noAnswer
  • Type: Object
Enabled
  • Field Name: Calling.callForward.callForwarding.noAnswer.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: Calling.callForward.callForwarding.noAnswer.destination
  • Type: String
  • MaxLength: 1024
Number of rings before forwarding Number of rings before call is forwarded to selected destination
  • Field Name: Calling.callForward.callForwarding.noAnswer.numberOfRings
  • Type: Integer
System Max Number Of Rings before forwarding System Max number of rings setting
  • Field Name: Calling.callForward.callForwarding.noAnswer.systemMaxNumberOfRings
  • Type: Integer
Destination Voicemail Enabled Allow forwarded calls to leave a voicemail
  • Field Name: Calling.callForward.callForwarding.noAnswer.destinationVoicemailEnabled
  • Type: Boolean
Business Continuity businessContinuity
  • Field Name: businessContinuity
  • Type: Object
Enabled
  • Field Name: Calling.callForward.businessContinuity.enabled
  • Type: Boolean
Destination Forward calls to this phone number
  • Field Name: Calling.callForward.businessContinuity.destination
  • Type: String
  • MaxLength: 1024
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: Calling.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: Calling.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: Calling.intercept.enabled
  • Type: Boolean
Choose incoming calls permissions for this user.
  • Field Name: incoming
  • Type: Object
Type
  • Field Name: Calling.intercept.incoming.type
  • Type: String
  • MaxLength: 1024
  • 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: Calling.intercept.incoming.voicemailEnabled
  • Type: Boolean
Announcements announcements
  • Field Name: announcements
  • Type: Object
Announcements
  • Field Name: Calling.intercept.incoming.announcements.greeting
  • Type: String
  • MaxLength: 1024
  • Choices: ["Custom", "Default"]
Filename
  • Field Name: Calling.intercept.incoming.announcements.filename
  • Type: String
  • MaxLength: 1024
New Number
  • Field Name: newNumber
  • Type: Object
Play new number announcements
  • Field Name: Calling.intercept.incoming.announcements.newNumber.enabled
  • Type: Boolean
Destination Destination Number
  • Field Name: Calling.intercept.incoming.announcements.newNumber.destination
  • Type: String
  • MaxLength: 1024
Zero Transfer
  • Field Name: zeroTransfer
  • Type: Object
Transfer on '0' to this phone number
  • Field Name: Calling.intercept.incoming.announcements.zeroTransfer.enabled
  • Type: Boolean
Destination Destination Number
  • Field Name: Calling.intercept.incoming.announcements.zeroTransfer.destination
  • Type: String
  • MaxLength: 1024
Outgoing outgoing
  • Field Name: outgoing
  • Type: Object
Type type
  • Field Name: Calling.intercept.outgoing.type
  • Type: String
  • MaxLength: 1024
  • Choices: ["Intercept All", "Allow Local Only"]
Transfer Enabled transferEnabled
  • Field Name: Calling.intercept.outgoing.transferEnabled
  • Type: Boolean
Destination destination
  • Field Name: Calling.intercept.outgoing.destination
  • Type: String
  • MaxLength: 1024
Monitoring Monitoring settings for a user
  • Field Name: monitoring
  • Type: Object
Call Park Notification Enabled callParkNotificationEnabled
  • Field Name: Calling.monitoring.callParkNotificationEnabled
  • Type: Boolean
Member member
  • Field Name: member.[n]
  • Type: Array
Display Name
  • Field Name: Calling.monitoring.member.[n].displayName
  • Type: String
  • MaxLength: 1024
Id
  • Field Name: Calling.monitoring.member.[n].id
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.monitoring.member.[n].firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.monitoring.member.[n].lastName
  • Type: String
  • MaxLength: 1024
Type
  • Field Name: Calling.monitoring.member.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: Calling.monitoring.member.[n].email
  • Type: String
  • MaxLength: 1024
Numbers numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: Calling.monitoring.member.[n].numbers.[n].external
  • Type: String
  • MaxLength: 1024
Extension
  • Field Name: Calling.monitoring.member.[n].numbers.[n].extension
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: Calling.monitoring.member.[n].numbers.[n].primary
  • Type: Boolean
Location
  • Field Name: Calling.monitoring.member.[n].location
  • Type: String
  • MaxLength: 1024
LocationId
  • Field Name: Calling.monitoring.member.[n].locationId
  • Type: String
  • MaxLength: 1024
Call Park Extension callparkextension
  • Field Name: callparkextension.[n]
  • Type: Array
Name
  • Field Name: Calling.monitoring.callparkextension.[n].name
  • Type: String
  • MaxLength: 1024
Id
  • Field Name: Calling.monitoring.callparkextension.[n].id
  • Type: String
  • Target: device/spark/CallParkExtensions
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Extension
  • Field Name: Calling.monitoring.callparkextension.[n].extension
  • Type: String
  • MaxLength: 1024
Location
  • Field Name: Calling.monitoring.callparkextension.[n].location
  • Type: String
  • MaxLength: 1024
LocationId
  • Field Name: Calling.monitoring.callparkextension.[n].locationId
  • Type: String
  • MaxLength: 1024
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: Calling.callBridge.warningToneEnabled
  • Type: Boolean
Push To Talk Push To Talk settings for a user
  • Field Name: pushToTalk
  • Type: Object
Auto answer calls
  • Field Name: Calling.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: Calling.pushToTalk.connectionType
  • Type: String
  • MaxLength: 1024
  • Choices: ["One Way", "Two Way"]
Type of Access for Users
  • Field Name: Calling.pushToTalk.accessType
  • Type: String
  • MaxLength: 1024
  • Choices: ["Allow Members", "Block Members"]
Members members
  • Field Name: members.[n]
  • Type: Array
Display Name
  • Field Name: Calling.pushToTalk.members.[n].displayName
  • Type: String
  • MaxLength: 1024
Id
  • Field Name: Calling.pushToTalk.members.[n].id
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.pushToTalk.members.[n].firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.pushToTalk.members.[n].lastName
  • Type: String
  • MaxLength: 1024
Type
  • Field Name: Calling.pushToTalk.members.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: Calling.pushToTalk.members.[n].email
  • Type: String
  • MaxLength: 1024
Numbers numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: Calling.pushToTalk.members.[n].numbers.[n].external
  • Type: String
  • MaxLength: 1024
Extension
  • Field Name: Calling.pushToTalk.members.[n].numbers.[n].extension
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: Calling.pushToTalk.members.[n].numbers.[n].primary
  • Type: Boolean
Call Recording Call Recording settings for a user
  • Field Name: callRecording
  • Type: Object
Enabled
  • Field Name: Calling.callRecording.enabled
  • Type: Boolean
Start Recording Criteria for recording a call
  • Field Name: Calling.callRecording.record
  • Type: String
  • MaxLength: 1024
  • Choices: ["Always", "Never", "Always with Pause/Resume", "On Demand with User Initiated Start"]
Record voice messaging
  • Field Name: Calling.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: Calling.callRecording.startStopAnnouncement.internalCallsEnabled
  • Type: Boolean
Play recording start/stop announcement for PSTN calls
  • Field Name: Calling.callRecording.startStopAnnouncement.pstnCallsEnabled
  • Type: Boolean
Notification Recording Reminder Tone
  • Field Name: notification
  • Type: Object
Type type
  • Field Name: Calling.callRecording.notification.type
  • Type: String
  • MaxLength: 1024
  • Choices: ["None", "Beep", "Play Announcement"]
Enabled enabled
  • Field Name: Calling.callRecording.notification.enabled
  • Type: Boolean
Repeat repeat
  • Field Name: repeat
  • Type: Object
Repeat interval
  • Field Name: Calling.callRecording.repeat.interval
  • Type: Integer
  • Choices: ["10", "20", "30", "40", "50", "60", "70", "80", "90"]
Enabled
  • Field Name: Calling.callRecording.repeat.enabled
  • Type: Boolean
Service Provider
  • Field Name: Calling.callRecording.serviceProvider
  • Type: String
  • MaxLength: 1024
External Group
  • Field Name: Calling.callRecording.externalGroup
  • Type: String
  • MaxLength: 1024
External Identifier
  • Field Name: Calling.callRecording.externalIdentifier
  • Type: String
  • MaxLength: 1024
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: Calling.executiveAssistant.type
  • Type: String
  • MaxLength: 1024
  • 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: Calling.bargeIn.enabled
  • Type: Boolean
Tone Enabled Play a tone when this user Barges In on a call
  • Field Name: Calling.bargeIn.toneEnabled
  • Type: Boolean
Receptionist Receptionist settings for a user
  • Field Name: receptionist
  • Type: Object
Reception Enabled receptionEnabled
  • Field Name: Calling.receptionist.receptionEnabled
  • Type: Boolean
Monitored Members monitoredMembers
  • Field Name: monitoredMembers.[n]
  • Type: Array
Id
  • Field Name: Calling.receptionist.monitoredMembers.[n].id
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.receptionist.monitoredMembers.[n].lastName
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.receptionist.monitoredMembers.[n].firstName
  • Type: String
  • MaxLength: 1024
Display Name
  • Field Name: Calling.receptionist.monitoredMembers.[n].displayName
  • Type: String
  • MaxLength: 1024
Type
  • Field Name: Calling.receptionist.monitoredMembers.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: Calling.receptionist.monitoredMembers.[n].email
  • Type: String
  • MaxLength: 1024
Numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: Calling.receptionist.monitoredMembers.[n].numbers.[n].external
  • Type: String
  • MaxLength: 1024
Extension
  • Field Name: Calling.receptionist.monitoredMembers.[n].numbers.[n].extension
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: Calling.receptionist.monitoredMembers.[n].numbers.[n].primary
  • Type: String
  • MaxLength: 1024
Hoteling Hoteling settings for a user
  • Field Name: hoteling
  • Type: Object
Enabled enabled
  • Field Name: Calling.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: Calling.privacy.aaExtensionDialingEnabled
  • Type: Boolean
AA Naming Dialing Enabled Allow this user to be dialled by first or last name
  • Field Name: Calling.privacy.aaNamingDialingEnabled
  • Type: Boolean
Enable Phone Status Pickup Barge In Privacy Enable phone status pickup barge in privacy for this user.
  • Field Name: Calling.privacy.enablePhoneStatusPickupBargeInPrivacy
  • 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: Calling.privacy.enablePhoneStatusDirectoryPrivacy
  • Type: Boolean
Monitoring Agents monitoringAgents
  • Field Name: monitoringAgents.[n]
  • Type: Array
Display Name
  • Field Name: Calling.privacy.monitoringAgents.[n].displayName
  • Type: String
  • MaxLength: 1024
Id
  • Field Name: Calling.privacy.monitoringAgents.[n].id
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.privacy.monitoringAgents.[n].lastName
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.privacy.monitoringAgents.[n].firstName
  • Type: String
  • MaxLength: 1024
Type
  • Field Name: Calling.privacy.monitoringAgents.[n].type
  • Type: String
  • MaxLength: 1024
  • Choices: ["People", "Place", "Virtual Line"]
Email
  • Field Name: Calling.privacy.monitoringAgents.[n].email
  • Type: String
  • MaxLength: 1024
Location location
  • Field Name: location
  • Type: Object
Name name
  • Field Name: Calling.privacy.monitoringAgents.[n].location.name
  • Type: String
  • MaxLength: 1024
Id id
  • Field Name: Calling.privacy.monitoringAgents.[n].location.id
  • Type: String
  • MaxLength: 1024
Numbers
  • Field Name: numbers.[n]
  • Type: Array
External
  • Field Name: Calling.privacy.monitoringAgents.[n].numbers.[n].external
  • Type: String
  • MaxLength: 1024
Extension
  • Field Name: Calling.privacy.monitoringAgents.[n].numbers.[n].extension
  • Type: String
  • MaxLength: 1024
Primary
  • Field Name: Calling.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: Calling.caller_id.selected
  • Type: String
  • MaxLength: 1024
  • Choices: ["Direct Line", "Location Number", "Mobile Number", "Custom"]
Direct Line The user's direct number
  • Field Name: Calling.caller_id.directNumber
  • Type: String
  • MaxLength: 1024
Extension Number The user's extension number
  • Field Name: Calling.caller_id.extensionNumber
  • Type: String
  • MaxLength: 1024
Location Number The number specified for the location
  • Field Name: Calling.caller_id.locationNumber
  • Type: String
  • MaxLength: 1024
Mobile Number The user's mobile number
  • Field Name: Calling.caller_id.mobileNumber
  • Type: String
  • MaxLength: 1024
Location Number is Toll free The location number is a toll free number
  • Field Name: Calling.caller_id.tollFreeLocationNumber
  • Type: Boolean
Custom Number A custom number for the user
  • Field Name: Calling.caller_id.customNumber
  • Type: String
  • MaxLength: 1024
Dial By First Name
  • Field Name: Calling.caller_id.dialByFirstName
  • Type: String
  • MaxLength: 1024
Dial By Last Name
  • Field Name: Calling.caller_id.dialByLastName
  • Type: String
  • MaxLength: 1024
Direct Line Caller ID Name Settings for the direct line caller ID name to be shown for this auto attendant.
  • Field Name: directLineCallerIdName
  • Type: Object
Custom Name The custom direct line caller ID name. Required if selection is set to CUSTOM_NAME.
  • Field Name: Calling.caller_id.directLineCallerIdName.customName
  • Type: String
  • MaxLength: 1024
Selection Selector for which name to show for this auto attendant.
  • Field Name: Calling.caller_id.directLineCallerIdName.selection
  • Type: String
  • MaxLength: 1024
  • Choices: ["CUSTOM NAME", "DISPLAY NAME"]
Block caller ID for received calls Block this user's identity when receiving a call.
  • Field Name: Calling.caller_id.blockInForwardCallsEnabled
  • Type: Boolean
Selected Caller Name Source Selected the required source of the Caller Name
  • Field Name: Calling.caller_id.externalCallerIdNamePolicy
  • Type: String
  • MaxLength: 1024
  • Choices: ["Direct Line", "Location", "Other"]
Custom Name A custom name for the user
  • Field Name: Calling.caller_id.customExternalCallerIdName
  • Type: String
  • MaxLength: 1024
Location Name The name specified for the location
  • Field Name: Calling.caller_id.locationExternalCallerIdName
  • Type: String
  • MaxLength: 1024
Additional External Caller ID Direct Line Enabled
  • Field Name: Calling.caller_id.additionalExternalCallerIdDirectLineEnabled
  • Type: Boolean
Additional External Caller ID Location Number Enabled
  • Field Name: Calling.caller_id.additionalExternalCallerIdLocationNumberEnabled
  • Type: Boolean
Additional External Caller ID Custom Number Additional External Caller ID Custom Number
  • Field Name: Calling.caller_id.additionalExternalCallerIdCustomNumber
  • Type: String
  • MaxLength: 1024
Devices Devices associated with a user
  • Field Name: devices
  • Type: Object
Max Device Count maxDeviceCount
  • Field Name: Calling.devices.maxDeviceCount
  • Type: Integer
Device Device
  • Field Name: device.[n]
  • Type: Array
Link Link to jump to the device details.
  • Field Name: Calling.devices.device.[n].link
  • Type: String
  • MaxLength: 1024
  • Format: link
Mac Address
  • Field Name: Calling.devices.device.[n].mac
  • Type: String
  • MaxLength: 1024
Model
  • Field Name: Calling.devices.device.[n].model
  • Type: String
  • MaxLength: 1024
Type
  • Field Name: Calling.devices.device.[n].type
  • Type: String
  • MaxLength: 1024
Id
  • Field Name: Calling.devices.device.[n].id
  • Type: String
  • MaxLength: 1024
Activation State
  • Field Name: Calling.devices.device.[n].activationState
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: description.[n]
  • Type: Array
Primary Owner
  • Field Name: Calling.devices.device.[n].primaryOwner
  • Type: Boolean
Owner
  • Field Name: owner
  • Type: Object
Id id
  • Field Name: Calling.devices.device.[n].owner.id
  • Type: String
  • MaxLength: 1024
Type type
  • Field Name: Calling.devices.device.[n].owner.type
  • Type: String
  • MaxLength: 1024
First Name
  • Field Name: Calling.devices.device.[n].owner.firstName
  • Type: String
  • MaxLength: 1024
Last Name
  • Field Name: Calling.devices.device.[n].owner.lastName
  • Type: String
  • MaxLength: 1024
Hoteling
  • Field Name: hoteling
  • Type: Object
Limit Guest Use
  • Field Name: Calling.devices.device.[n].hoteling.limitGuestUse
  • Type: Boolean
Enabled Allow this device to be used as a hotelling host by visiting guests
  • Field Name: Calling.devices.device.[n].hoteling.enabled
  • Type: Boolean
Guest Hours Limit Limit the time a guest can use this phone
  • Field Name: Calling.devices.device.[n].hoteling.guestHoursLimit
  • Type: Integer