[Index]

Model: relation/WebexWorkspaceCallSettings

Webex Workspace Call Settings

Model Details: relation/WebexWorkspaceCallSettings

Title Description Details
Id
  • Field Name: id
  • Type: String
Location ID
  • Field Name: locationId
  • Type: String
Location Name
  • Field Name: locationName
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Name * A friendly name for the workspace.
  • Field Name: displayName
  • Type: String
Calling
  • Field Name: calling
  • Type: Object
Calling Behaviour This determines how calls are made from this place. Default: freeCalling
  • Field Name: calling.type
  • Type: String
  • Default: freeCalling
  • Choices: ["No Calling", "Free Calling (default)", "Webex Calling", "Third-party SIP URI", "Webex Edge For Devices"]
CallerID Retrieve Caller ID Settings for a Workspace. Caller ID settings control how a workspace's information is displayed when making outgoing calls.
  • Field Name: callerId
  • Type: Object
Caller ID Type Which type of outgoing Caller ID will be used.
  • Field Name: callerId.selected
  • Type: String
  • Choices: ["DIRECT_LINE", "LOCATION_NUMBER", "CUSTOM"]
Direct Number Direct number which will be shown if DIRECT_LINE is selected.
  • Field Name: callerId.directNumber
  • Type: String
Location Number Location number which will be shown if LOCATION_NUMBER is selected.
  • Field Name: callerId.locationNumber
  • Type: String
Toll Free Location Number Flag for specifying a toll-free number.
  • Field Name: callerId.tollFreeLocationNumber
  • Type: Boolean
Custom Number This value must be an assigned number from the person's location.
  • Field Name: callerId.customNumber
  • Type: String
Display Name Workspace's caller ID display name.
  • Field Name: callerId.displayName
  • Type: String
Display Detail Workspace's caller ID display details. Default is ..
  • Field Name: callerId.displayDetail
  • Type: String
Block Call Forwarding Flag to block call forwarding.
  • Field Name: callerId.blockInForwardCallsEnabled
  • Type: Boolean
External Caller Id Name Policy Designates which type of External Caller ID Name policy is used.
  • Field Name: callerId.externalCallerIdNamePolicy
  • Type: String
  • Choices: ["DIRECT_LINE", "LOCATION", "OTHER"]
Custom External Caller Id Name Custom External Caller Name, which will be shown if External Caller ID Name is OTHER.
  • Field Name: callerId.customExternalCallerIdName
  • Type: String
Location External Caller Id Name The display name for location caller id
  • Field Name: callerId.locationExternalCallerIdName
  • Type: String
Call Forwarding call forwarding
  • Field Name: callForwarding
  • Type: Object
Business Continuity Forward calls if the network is disconnected.
  • Field Name: businessContinuity
  • Type: Object
Enabled Business Continuity call forwarding is enabled or disabled.
  • Field Name: callForwarding.businessContinuity.enabled
  • Type: Boolean
Destination Destination for Business Continuity call forwarding.
  • Field Name: callForwarding.businessContinuity.destination
  • Type: String
Destination Voicemail Enabled Destination for Business Continuity call forwarding.
  • Field Name: callForwarding.businessContinuity.destinationVoicemailEnabled
  • Type: Boolean
Call Forwarding Call forwarding settings for a Workspace.
  • Field Name: callForwarding
  • Type: Object
Busy Busy call forwarding setting.
  • Field Name: busy
  • Type: Object
Enabled Busy call forwarding is enabled or disabled.
  • Field Name: callForwarding.callForwarding.busy.enabled
  • Type: Boolean
Destination Destination for Busy call forwarding.
  • Field Name: callForwarding.callForwarding.busy.destination
  • Type: String
Destination Voicemail Enabled Destination for Busy call forwarding.
  • Field Name: callForwarding.callForwarding.busy.destinationVoicemailEnabled
  • Type: Boolean
No Answer No Answer Call Forward Settings.
  • Field Name: noAnswer
  • Type: Object
Enabled No Answer call forwarding is enabled or disabled.
  • Field Name: callForwarding.callForwarding.noAnswer.enabled
  • Type: Boolean
Destination Destination for No Answer call forwarding.
  • Field Name: callForwarding.callForwarding.noAnswer.destination
  • Type: String
Number Of Rings Destination for No Answer call forwarding.
  • Field Name: callForwarding.callForwarding.noAnswer.numberOfRings
  • Type: Integer
System Max Number Of Rings Destination for No Answer call forwarding.
  • Field Name: callForwarding.callForwarding.noAnswer.systemMaxNumberOfRings
  • Type: Integer
Destination Voicemail Enabled Destination for No Answer call forwarding.
  • Field Name: callForwarding.callForwarding.noAnswer.destinationVoicemailEnabled
  • Type: Boolean
Always Call Forward All Settings
  • Field Name: always
  • Type: Object
Enabled Call Forward All call forwarding is enabled or disabled.
  • Field Name: callForwarding.callForwarding.always.enabled
  • Type: Boolean
Destination Destination for No Answer call forwarding.
  • Field Name: callForwarding.callForwarding.always.destination
  • Type: String
Ring Reminder Enabled Call Forward All Ring Reminder Enabled
  • Field Name: callForwarding.callForwarding.always.ringReminderEnabled
  • Type: Boolean
Destination Voicemail Enabled Destination for Call Forward All call forwarding.
  • Field Name: callForwarding.callForwarding.always.destinationVoicemailEnabled
  • Type: Boolean
Call Waiting Call forwarding settings for a Workspace.
  • Field Name: callWaiting
  • Type: Object
Enabled Call Waiting state.
  • Field Name: callWaiting.enabled
  • Type: Boolean
Call Monitoring Call Monitoring Settings
  • Field Name: callMonitoring
  • Type: Object
Call Park Notification Enabled Call park notification enabled or disabled.
  • Field Name: callMonitoring.callParkNotificationEnabled
  • Type: Boolean
Call Park Extension Monitored call Park element items
  • Field Name: callPark.[n]
  • Type: Array
Name Name of call park extension.
  • Field Name: callMonitoring.callPark.[n].name
  • Type: String
ID ID of call park extension.
  • Field Name: callMonitoring.callPark.[n].id
  • Type: String
Extension Extension of call park extension.
  • Field Name: callMonitoring.callPark.[n].extension
  • Type: String
Location Name Name of location for call park extension.
  • Field Name: callMonitoring.callPark.[n].location
  • Type: String
Location ID ID of location for call park extension.
  • Field Name: callMonitoring.callPark.[n].locationId
  • Type: String
Member Extension Monitored Member Line Extensions
  • Field Name: member.[n]
  • Type: Array
Email Email of the person or workspace.
  • Field Name: callMonitoring.member.[n].email
  • Type: String
ID ID of person or workspace.
  • Field Name: callMonitoring.member.[n].id
  • Type: String
First Name First name of person or workspace
  • Field Name: callMonitoring.member.[n].firstName
  • Type: String
Last Name Last name of person or workspace
  • Field Name: callMonitoring.member.[n].lastName
  • Type: String
Display Name Display name of person or workspace
  • Field Name: callMonitoring.member.[n].displayName
  • Type: String
Type Type of the person or workspace.
  • Field Name: callMonitoring.member.[n].type
  • Type: String
  • Choices: ["PEOPLE", "PLACE"]
Location Name of location for call park.
  • Field Name: callMonitoring.member.[n].location
  • Type: String
Location ID ID of the location for call park.
  • Field Name: callMonitoring.member.[n].locationId
  • Type: String
Numbers List of phone numbers of the person or workspace.
  • Field Name: numbers.[n]
  • Type: Array
External Phone number of person or workspace. Either phoneNumber or extension is mandatory.
  • Field Name: callMonitoring.member.[n].numbers.[n].external
  • Type: String
Extension Extension of person or workspace. Either phoneNumber or extension is mandatory.
  • Field Name: callMonitoring.member.[n].numbers.[n].extension
  • Type: String
Primary Flag to indicate primary phone.
  • Field Name: callMonitoring.member.[n].numbers.[n].primary
  • Type: Boolean
Toll Free Number Flag to indicate toll free number.
  • Field Name: callMonitoring.member.[n].numbers.[n].tollFreeNumber
  • Type: Boolean
Workspace Numbers List numbers for this workspace.
  • Field Name: workspaceNumbers
  • Type: Object
Phone Numbers Array of numbers primary followed by alternate numbers.
  • Field Name: phoneNumbers.[n]
  • Type: Array
External PSTN phone number in E.164 format.
  • Field Name: workspaceNumbers.phoneNumbers.[n].external
  • Type: String
Extension Extension for workspace.
  • Field Name: workspaceNumbers.phoneNumbers.[n].extension
  • Type: String
Primary Name of location for call park extension.
  • Field Name: workspaceNumbers.phoneNumbers.[n].primary
  • Type: Boolean
Incoming Permission Retrieve Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.
  • Field Name: incomingPermission
  • Type: Object
Use Custom Enabled Incoming Permission state. If disabled, the default settings are used.
  • Field Name: incomingPermission.useCustomEnabled
  • Type: Boolean
External Transfer Indicate call transfer setting.
  • Field Name: incomingPermission.externalTransfer
  • Type: String
  • Choices: ["ALLOW_ALL_EXTERNAL", "ALLOW_ONLY_TRANSFERRED_EXTERNAL", "BLOCK_ALL_EXTERNAL"]
Internal Calls Enabled Flag to indicate if workspace can receive internal calls.
  • Field Name: incomingPermission.internalCallsEnabled
  • Type: Boolean
Collect Calls Enabled Flag to indicate if workspace can receive collect calls.
  • Field Name: incomingPermission.collectCallsEnabled
  • Type: Boolean
Outgoing Permissions A location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.
  • Field Name: outgoingPermissions
  • Type: Object
Use Custom Enabled Incoming Permission state. If disabled, the default settings are used.
  • Field Name: outgoingPermissions.useCustomEnabled
  • Type: Boolean
Calling Permissions Workspace calling permissions settings.
  • Field Name: callingPermissions.[n]
  • Type: Array
Call Type Call Type Values
  • Field Name: outgoingPermissions.callingPermissions.[n].callType
  • Type: String
  • Choices: ["INTERNAL_CALL", "TOLL_FREE", "INTERNATIONAL", "OPERATOR_ASSISTED", "CHARGEABLE_DIRECTORY_ASSISTED", "SPECIAL_SERVICES_I", "SPECIAL_SERVICES_II", "PREMIUM_SERVICES_I", "PREMIUM_SERVICES_II", "NATIONAL"]
Action Allows to configure settings for each call type.
  • Field Name: outgoingPermissions.callingPermissions.[n].action
  • Type: String
  • Choices: ["ALLOW", "BLOCK", "AUTH_CODE", "TRANSFER_NUMBER_1", "TRANSFER_NUMBER_2", "TRANSFER_NUMBER_2"]
Transfer Enabled If enabled, allow the person to transfer or forward internal calls.
  • Field Name: outgoingPermissions.callingPermissions.[n].transferEnabled
  • Type: Boolean
Access Codes Retrieve Access codes for a Workspace. Access codes are used to bypass permissions.
  • Field Name: accessCodes
  • Type: Object
Access Codes Access Codes
  • Field Name: accessCodes.[n]
  • Type: Array
Code Indicates an access code.
  • Field Name: accessCodes.accessCodes.[n].code
  • Type: String
Description Indicates the description of the access code.
  • Field Name: accessCodes.accessCodes.[n].description
  • Type: String
Call Intercept Retrieves Workspace's Call Intercept Settings.
  • Field Name: callIntercept
  • Type: Object
Enabled True if call intercept is enabled.
  • Field Name: callIntercept.enabled
  • Type: Boolean
Incoming Settings related to how incoming calls are handled when the intercept feature is enabled.
  • Field Name: incoming
  • Type: Object
Type Indicated incoming calls are intercepted.
  • Field Name: callIntercept.incoming.type
  • Type: String
  • Choices: ["INTERCEPT_ALL", "ALLOW_ALL"]
Voicemail Enabled Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled.
  • Field Name: callIntercept.incoming.voicemailEnabled
  • Type: Boolean
Announcements Settings related to how incoming calls are handled when the intercept feature is enabled.
  • Field Name: announcements
  • Type: Object
Greeting Indicates that a system default message will be placed when incoming calls are intercepted.
  • Field Name: callIntercept.incoming.announcements.greeting
  • Type: String
  • Choices: ["CUSTOM", "DEFAULT"]
Filename Filename of the custom greeting; this is an empty string if no custom greeting has been uploaded.
  • Field Name: callIntercept.incoming.announcements.filename
  • Type: String
New Number Information about the new number announcement.
  • Field Name: newNumber
  • Type: Object
Enabled If true, the caller hears this new number when the call is intercepted.
  • Field Name: callIntercept.incoming.announcements.newNumber.enabled
  • Type: Boolean
Destination New number the caller hears announced.
  • Field Name: callIntercept.incoming.announcements.newNumber.destination
  • Type: String
Zero Transfer Information about how the call will be handled if zero 0 is pressed.
  • Field Name: zeroTransfer
  • Type: Object
Enabled If true, the caller hears this new number when the call is intercepted.
  • Field Name: callIntercept.incoming.announcements.zeroTransfer.enabled
  • Type: Boolean
Destination New number the caller hears announced.
  • Field Name: callIntercept.incoming.announcements.zeroTransfer.destination
  • Type: String
outgoing Settings related to how outgoing calls are handled when the intercept feature is enabled.
  • Field Name: outgoing
  • Type: Object
Type Indicated outgoing calls are intercepted.
  • Field Name: callIntercept.outgoing.type
  • Type: String
  • Choices: ["INTERCEPT_ALL", "ALLOW_ALL"]
Transfer Enabled If true, when the person attempts to make an outbound call, a system default message is played and the call is made to the destination phone number.
  • Field Name: callIntercept.outgoing.transferEnabled
  • Type: Boolean
Destination Number to which the outbound call be transferred.
  • Field Name: callIntercept.outgoing.destination
  • Type: String
Auto Transfer Numbers Retrieve Transfer Numbers Settings for a Workspace. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type.
  • Field Name: transferNumbers
  • Type: Object
Auto Transfer Number 1 When calling a specific call type, this workspace will be automatically transferred to another number.
  • Field Name: transferNumbers.autoTransferNumber1
  • Type: String
Auto Transfer Number 2 When calling a specific call type, this workspace will be automatically transferred to another number.
  • Field Name: transferNumbers.autoTransferNumber2
  • Type: String
Auto Transfer Number 3 When calling a specific call type, this workspace will be automatically transferred to another number.
  • Field Name: transferNumbers.autoTransferNumber3
  • Type: String
No Instance
  • Field Name: NoInstance.[n]
  • Type: Array
Name *
  • Field Name: NoInstance.[n].name
  • Type: String
  • MaxLength: 1024