[Index]
This relation implements the workflows to manage Spark Users.
Model ref.: relation/SparkUser
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"status": {
"readonly": true,
"type": "string",
"title": "Status"
},
"phoneNumbers": {
"items": {
"type": "object",
"properties": {
"type": {
"default": "work",
"choices": [
{
"value": "work",
"title": "Work"
},
{
"value": "work_extension",
"title": "Work Extension"
},
{
"value": "mobile",
"title": "Mobile"
},
{
"value": "fax",
"title": "Fax"
}
],
"type": "string",
"description": "The type of phone number.",
"title": "Type"
},
"value": {
"type": "string",
"description": "The phone number e.g. +1 408 526 7209",
"title": "Number"
}
}
},
"required": false,
"type": "array",
"description": "Phone numbers for the person. Only settable for Webex Calling. Needs a Webex Calling license.",
"title": "Phone Numbers"
},
"addresses": {
"items": {
"type": "object",
"properties": {
"locality": {
"type": "string",
"description": "The user's locality, often city. Example value: Milpitas",
"title": "Locality"
},
"country": {
"type": "string",
"description": "The user's country. Example value: US",
"title": "Country"
},
"region": {
"type": "string",
"description": "The user's region, often state. Example value: California",
"title": "Region"
},
"streetAddress": {
"type": "string",
"description": "The user's street. Example value: 1099 Bird Ave.",
"title": "Street Address"
},
"postalCode": {
"type": "string",
"description": "The user's postal or zip code. Example value: 99212",
"title": "Postal Code"
},
"type": {
"type": "string",
"description": "The type of address.",
"title": "Type"
}
}
},
"readonly": true,
"type": "array",
"description": "The users addresses.",
"title": "Addresses"
},
"manager": {
"type": "string",
"title": "Manager"
},
"calling_pro": {
"readonly": true,
"type": "boolean",
"title": "Webex Calling - Professional"
},
"roles": {
"type": "object",
"properties": {
"user_device": {
"type": "boolean",
"description": " - User Management\n - Device Management\n - Licenses & Upgrades",
"title": "User and Device Administrator"
},
"none": {
"default": "true",
"type": "boolean",
"title": "No administrator privileges"
},
"full": {
"type": "boolean",
"description": " - User Management\n - Company Policy & Templates\n - Analytics & Reports\n - Support Metrics & Notifications\n - Licenses & Upgrades\n - Assign Roles",
"title": "Full administrator privileges"
},
"support": {
"type": "boolean",
"description": " - Analytics & Reports\n - Support Metrics & Notifications",
"title": "Support Administrator"
},
"readonly": {
"type": "boolean",
"description": "Read-only view of the portal. No changes will be accepted.",
"title": "Read-only administrator privileges"
},
"device": {
"type": "boolean",
"description": " - Device Management",
"title": "Device Administrator"
}
},
"title": "Roles"
},
"licenses": {
"items": {
"type": "object",
"properties": {
"license": {
"description": "Select the license to assign to this user.",
"format": "uri",
"title": "License",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "unique_name",
"target_model_type": "device/spark/License",
"type": "string",
"target": "/api/device/spark/License/choices/?field=unique_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"title": "Assigned Licenses"
},
"timezone": {
"type": "string",
"title": "Time Zone"
},
"invitePending": {
"readonly": true,
"type": "boolean",
"title": "Invite Pending"
},
"title": {
"type": "string",
"title": "Title"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
},
"department": {
"type": "string",
"title": "Department"
},
"type": {
"default": "person",
"choices": [
{
"value": "person",
"title": "Person"
},
{
"value": "bot",
"title": "Bot"
},
{
"value": "appuser",
"title": "App User (Guest User)"
}
],
"type": "string",
"title": "User Type"
},
"email": {
"required": true,
"type": "string",
"title": "Email Address"
},
"sipAddresses": {
"items": {
"type": "object",
"properties": {
"type": {
"readonly": true,
"type": "string",
"description": "The type of SIP address.",
"title": "Type"
},
"primary": {
"readonly": true,
"type": "boolean",
"title": "Primary"
},
"value": {
"readonly": true,
"type": "string",
"description": "The SIP address",
"title": "Number"
}
}
},
"readonly": true,
"type": "array",
"description": "The users sip addresses.",
"title": "SIP Addresses"
},
"SparkServices": {
"type": "object",
"properties": {
"configuredCallingBehaviour": {
"type": "string"
},
"name": {
"type": "string"
}
},
"title": "Spark Services"
},
"nickName": {
"type": "string",
"title": "Nickname"
},
"managerId": {
"target": "/api/device/spark/User/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Manager ID",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/User",
"type": "string"
},
"locationId": {
"target": "/api/device/spark/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Location",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/Location",
"type": "string"
},
"line": {
"required": false,
"type": "string",
"title": "Field to pass selected number from QAS workflow"
},
"Calling": {
"type": "object",
"properties": {
"callForward": {
"properties": {
"businessContinuity": {
"properties": {
"destination": {
"type": "string",
"description": "Forward calls to this phone number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "This option works if the number you enter is an internal phone number or extension, and the number has voicemail enabled",
"title": "Allow forwarded calls to leave a voicemail"
}
},
"type": "object",
"description": "businessContinuity",
"title": "Business Continuity"
},
"callForwarding": {
"properties": {
"always": {
"properties": {
"ringReminderEnabled": {
"type": "boolean",
"description": "Play a brief tone for forwarded calls",
"title": "Ring Reminder Enabled"
},
"destination": {
"type": "string",
"description": "Forward calls to this phone number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Allow forwarded calls to leave a voicemail",
"title": "Destination Voicemail Enabled"
}
},
"type": "object",
"description": "always",
"title": "Always"
},
"busy": {
"properties": {
"destination": {
"type": "string",
"description": "Forward calls to this phone number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Allow forwarded calls to leave a voicemail",
"title": "Destination Voicemail Enabled"
}
},
"type": "object",
"description": "busy",
"title": "Busy"
},
"noAnswer": {
"properties": {
"numberOfRings": {
"type": "integer",
"description": "Number of rings before call is forwarded to selected destination",
"title": "Number of rings before forwarding"
},
"systemMaxNumberOfRings": {
"readonly": true,
"type": "integer",
"description": "System Max number of rings setting",
"title": "System Max Number Of Rings before forwarding"
},
"destination": {
"type": "string",
"description": "Forward calls to this phone number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"description": "Allow forwarded calls to leave a voicemail",
"title": "Destination Voicemail Enabled"
}
},
"type": "object",
"description": "noAnswer",
"title": "No Answer"
}
},
"type": "object",
"description": "Call Forwarding Settings",
"title": "Call Forwarding"
}
},
"type": "object",
"description": "Call Forward settings for a user",
"title": "Call Forward"
},
"outgoingPermission": {
"properties": {
"useCustomEnabled": {
"type": "boolean",
"title": "Use Custom Settings"
},
"callingPermissions": {
"items": {
"type": "object",
"properties": {
"callType": {
"readonly": true,
"type": "string",
"title": "Call Type"
},
"action": {
"choices": [
{
"value": "ALLOW",
"title": "Allow"
},
{
"value": "BLOCK",
"title": "Block"
},
{
"value": "AUTH_CODE",
"title": "Auth Code"
},
{
"value": "TRANSFER_NUMBER_1",
"title": "Transfer Number 1"
},
{
"value": "TRANSFER_NUMBER_2",
"title": "Transfer Number 2"
},
{
"value": "TRANSFER_NUMBER_3",
"title": "Transfer Number 3"
}
],
"type": "string",
"title": "Action"
},
"transferEnabled": {
"type": "boolean",
"title": "Allow transfers and forwards"
}
}
},
"type": "array",
"description": "callingPermissions",
"title": "Calling Permissions"
}
},
"type": "object",
"description": "Outgoing Permission settings for a user",
"title": "Outgoing Permission"
},
"caller_id": {
"properties": {
"mobileNumber": {
"readonly": true,
"type": "string",
"description": "The user's mobile number",
"title": "Mobile Number"
},
"customNumber": {
"type": "string",
"description": "A custom number for the user",
"title": "Custom Number"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
},
"extensionNumber": {
"readonly": true,
"type": "string",
"description": "The user's extension number",
"title": "Extension Number"
},
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"selected": {
"choices": [
{
"value": "DIRECT_LINE",
"title": "Direct Line"
},
{
"value": "LOCATION_NUMBER",
"title": "Location Number"
},
{
"value": "MOBILE_NUMBER",
"title": "Mobile Number"
},
{
"value": "CUSTOM",
"title": "Custom"
}
],
"type": "string",
"description": "Selected the required source of the Caller ID",
"title": "Selected CLI Source"
},
"locationNumber": {
"readonly": true,
"type": "string",
"description": "The number specified for the location",
"title": "Location Number"
},
"tollFreeLocationNumber": {
"readonly": true,
"type": "boolean",
"description": "The location number is a toll free number",
"title": "Location Number is Toll free"
},
"blockInForwardCallsEnabled": {
"type": "boolean",
"description": "Block this user's identity when receiving a call.",
"title": "Block caller ID for received calls"
},
"externalCallerIdNamePolicy": {
"choices": [
{
"value": "DIRECT_LINE",
"title": "Direct Line"
},
{
"value": "LOCATION",
"title": "Location"
},
{
"value": "OTHER",
"title": "Other"
}
],
"type": "string",
"description": "Selected the required source of the Caller Name",
"title": "Selected Caller Name Source"
},
"customExternalCallerIdName": {
"type": "string",
"description": "A custom name for the user",
"title": "Custom Name"
},
"directNumber": {
"readonly": true,
"type": "string",
"description": "The user's direct number",
"title": "Direct Line"
},
"locationExternalCallerIdName": {
"readonly": true,
"type": "string",
"description": "The name specified for the location",
"title": "Location Name"
},
"types": {
"description": "types",
"title": "Types",
"items": {
"readonly": true,
"type": "string",
"choices": [
{
"value": "DIRECT_LINE",
"title": "Direct Line"
},
{
"value": "LOCATION_NUMBER",
"title": "Location Number"
},
{
"value": "MOBILE_NUMBER",
"title": "Mobile Number"
},
{
"value": "CUSTOM",
"title": "Custom"
}
]
},
"readonly": true,
"type": "array",
"name": "types"
}
},
"required": false,
"type": "object",
"description": "Caller ID settings for a user",
"title": "Caller Id"
},
"calling_pro": {
"readonly": true,
"type": "boolean",
"title": "Webex Calling - Professional"
},
"receptionist": {
"properties": {
"receptionEnabled": {
"type": "boolean",
"description": "receptionEnabled",
"title": "Reception Enabled"
},
"monitoredMembers": {
"items": {
"type": "object",
"properties": {
"displayName": {
"readonly": true,
"type": "string",
"title": "Display Name"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
},
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"id": {
"target": "/api/device/spark/UserConfig/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Id",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/UserConfig",
"type": "string"
},
"numbers": {
"items": {
"type": "object",
"properties": {
"external": {
"readonly": true,
"type": "string",
"title": "External"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"primary": {
"readonly": true,
"type": "string",
"title": "Primary"
}
}
},
"readonly": true,
"type": "array",
"title": "Numbers"
},
"type": {
"readonly": true,
"choices": [
{
"value": "PEOPLE",
"title": "People"
},
{
"value": "PLACE",
"title": "Place"
},
{
"value": "VIRTUAL_LINE",
"title": "Virtual Line"
}
],
"type": "string",
"title": "Type"
},
"email": {
"readonly": true,
"type": "string",
"title": "Email"
}
}
},
"type": "array",
"description": "monitoredMembers",
"title": "Monitored Members"
}
},
"type": "object",
"description": "Receptionist settings for a user",
"title": "Receptionist"
},
"id": {
"type": "string",
"title": "Id"
},
"dnd": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Do Not Disturb will direct all calls to a busy signal",
"title": "Enabled"
},
"ringSplashEnabled": {
"type": "boolean",
"description": "Enable ring reminder on your Cisco IP phone",
"title": "Ring Splash Enabled"
}
},
"required": false,
"type": "object",
"description": "DND settings for a user",
"title": "Do Not Disturb"
},
"callRecording": {
"properties": {
"recordVoicemailEnabled": {
"type": "boolean",
"title": "Record voice messaging"
},
"externalIdentifier": {
"type": "string",
"title": "External Identifier"
},
"startStopAnnouncement": {
"properties": {
"internalCallsEnabled": {
"type": "boolean",
"title": "Play recording start/stop announcement for internal calls"
},
"pstnCallsEnabled": {
"type": "boolean",
"title": "Play recording start/stop announcement for PSTN calls "
}
},
"type": "object",
"description": "Manage playing audible announcements when recording starts or stops. You can control audible announcements for internal and PSTN calls",
"title": "Recording start/stop announcement"
},
"notification": {
"properties": {
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
},
"type": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "Beep",
"title": "Beep"
},
{
"value": "Play Announcement",
"title": "Play Announcement"
}
],
"type": "string",
"description": "type",
"title": "Type"
}
},
"type": "object",
"description": "Recording Reminder Tone",
"title": "Notification"
},
"externalGroup": {
"type": "string",
"title": "External Group"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"record": {
"choices": [
{
"value": "Always",
"title": "Always"
},
{
"value": "Never",
"title": "Never"
},
{
"value": "Always with Pause/Resume",
"title": "Always with Pause/Resume"
},
{
"value": "On Demand with User Initiated Start",
"title": "On Demand with User Initiated Start"
}
],
"type": "string",
"description": "Criteria for recording a call",
"title": "Start Recording"
},
"repeat": {
"properties": {
"interval": {
"choices": [
{
"value": 10,
"title": "10"
},
{
"value": 20,
"title": "20"
},
{
"value": 30,
"title": "30"
},
{
"value": 40,
"title": "40"
},
{
"value": 50,
"title": "50"
},
{
"value": 60,
"title": "60"
},
{
"value": 70,
"title": "70"
},
{
"value": 80,
"title": "80"
},
{
"value": 90,
"title": "90"
}
],
"type": "integer",
"title": "Repeat interval"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
}
},
"type": "object",
"description": "repeat",
"title": "Repeat"
},
"serviceProvider": {
"type": "string",
"title": "Service Provider"
}
},
"required": false,
"type": "object",
"description": "Call Recording settings for a user",
"title": "Call Recording"
},
"privacy": {
"properties": {
"aaExtensionDialingEnabled": {
"type": "boolean",
"description": "Allow this user to be dialled by extension",
"title": "AA Extension Dialing Enabled"
},
"enablePhoneStatusDirectoryPrivacy": {
"type": "boolean",
"description": "Only the users selected below will be allowed to monitor this user's phone-line status.",
"title": "Enable Phone Status Directory Privacy"
},
"monitoringAgents": {
"items": {
"type": "object",
"properties": {
"displayName": {
"readonly": true,
"type": "string",
"title": "Display Name"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
},
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"id": {
"target": "/api/device/spark/UserConfig/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Id",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/UserConfig",
"type": "string"
},
"location": {
"properties": {
"name": {
"readonly": true,
"type": "string",
"description": "name",
"title": "Name"
},
"id": {
"readonly": true,
"type": "string",
"description": "id",
"title": "Id"
}
},
"type": "object",
"description": "location",
"title": "Location"
},
"type": {
"readonly": true,
"choices": [
{
"value": "PEOPLE",
"title": "People"
},
{
"value": "PLACE",
"title": "Place"
},
{
"value": "VIRTUAL_LINE",
"title": "Virtual Line"
}
],
"type": "string",
"title": "Type"
},
"email": {
"readonly": true,
"type": "string",
"title": "Email"
},
"numbers": {
"items": {
"type": "object",
"properties": {
"external": {
"readonly": true,
"type": "string",
"title": "External"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"primary": {
"readonly": true,
"type": "boolean",
"title": "Primary"
}
}
},
"type": "array",
"title": "Numbers"
}
}
},
"description": "monitoringAgents",
"type": "array",
"name": "monitoringAgents",
"title": "Monitoring Agents"
},
"aaNamingDialingEnabled": {
"type": "boolean",
"description": "Allow this user to be dialled by first or last name",
"title": "AA Naming Dialing Enabled"
}
},
"required": false,
"type": "object",
"description": "Privacy settings for a user",
"title": "Privacy"
},
"callWaiting": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Receive another call during a call",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Call Waiting settings for a user",
"title": "Call Waiting"
},
"pushToTalk": {
"properties": {
"allowAutoAnswer": {
"type": "boolean",
"title": "Auto answer calls"
},
"accessType": {
"choices": [
{
"value": "ALLOW_MEMBERS",
"title": "Allow Members"
},
{
"value": "BLOCK_MEMBERS",
"title": "Block Members"
}
],
"type": "string",
"title": "Type of Access for Users"
},
"members": {
"items": {
"type": "object",
"properties": {
"displayName": {
"readonly": true,
"type": "string",
"title": "Display Name"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
},
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"id": {
"target": "/api/device/spark/UserConfig/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Id",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/UserConfig",
"type": "string"
},
"numbers": {
"items": {
"properties": {
"external": {
"readonly": true,
"type": "string",
"title": "External"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"primary": {
"readonly": true,
"type": "boolean",
"title": "Primary"
}
},
"type": "object",
"description": "member",
"title": "Member"
},
"readonly": true,
"type": "array",
"description": "numbers",
"title": "Numbers"
},
"type": {
"readonly": true,
"choices": [
{
"value": "PEOPLE",
"title": "People"
},
{
"value": "PLACE",
"title": "Place"
},
{
"value": "VIRTUAL_LINE",
"title": "Virtual Line"
}
],
"type": "string",
"title": "Type"
},
"email": {
"readonly": true,
"type": "string",
"title": "Email"
}
}
},
"type": "array",
"description": "members",
"title": "Members"
},
"connectionType": {
"choices": [
{
"value": "ONE_WAY",
"title": "One Way"
},
{
"value": "TWO_WAY",
"title": "Two Way"
}
],
"type": "string",
"description": "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.",
"title": "Connection Type"
}
},
"required": false,
"type": "object",
"description": "Push To Talk settings for a user",
"title": "Push To Talk"
},
"bargeIn": {
"properties": {
"toneEnabled": {
"type": "boolean",
"description": "Play a tone when this user Barges In on a call",
"title": "Tone Enabled"
},
"enabled": {
"type": "boolean",
"description": "Allow other users to add themselves to this user\u2019s ongoing call, making it a conference call.",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Barge In settings for a user",
"title": "Barge In"
},
"email": {
"required": true,
"type": "string",
"title": "Email Address"
},
"intercept": {
"properties": {
"incoming": {
"type": "object",
"properties": {
"announcements": {
"properties": {
"newNumber": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"description": "Destination Number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Play new number announcements"
}
},
"title": "New Number"
},
"zeroTransfer": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"description": "Destination Number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"title": "Transfer on '0' to this phone number"
}
},
"title": "Zero Transfer"
},
"greeting": {
"choices": [
{
"value": "CUSTOM",
"title": "Custom"
},
{
"value": "DEFAULT",
"title": "Default"
}
],
"type": "string",
"title": "Announcements"
},
"filename": {
"readonly": true,
"type": "string",
"title": "Filename"
}
},
"type": "object",
"description": "announcements",
"title": "Announcements"
},
"type": {
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "Intercept All"
},
{
"value": "ALLOW_ALL",
"title": "Allow All"
}
],
"type": "string",
"title": "Type"
},
"voicemailEnabled": {
"type": "boolean",
"description": "Route all calls to voicemail. If the user doesn\u2019t have voicemail, then the caller will hear the announcement message.",
"title": "Send calls to voicemail"
}
},
"title": "Choose incoming calls permissions for this user."
},
"outgoing": {
"properties": {
"destination": {
"type": "string",
"description": "destination",
"title": "Destination"
},
"type": {
"choices": [
{
"value": "INTERCEPT_ALL",
"title": "Intercept All"
},
{
"value": "ALLOW_LOCAL_ONLY",
"title": "Allow Local Only"
}
],
"type": "string",
"description": "type",
"title": "Type"
},
"transferEnabled": {
"type": "boolean",
"description": "transferEnabled",
"title": "Transfer Enabled"
}
},
"type": "object",
"description": "outgoing",
"title": "Outgoing"
},
"enabled": {
"type": "boolean",
"description": "You can disconnect this user\u2019s 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.",
"title": "Enabled"
}
},
"type": "object",
"description": "Intercept settings for a user",
"title": "Intercept"
},
"executiveAssistant": {
"properties": {
"type": {
"choices": [
{
"value": "UNASSIGNED",
"title": "Unassigned"
},
{
"value": "EXECUTIVE",
"title": "Executive"
},
{
"value": "EXECUTIVE_ASSISTANT",
"title": "Executive Assistant"
}
],
"type": "string",
"description": "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.",
"title": "Type"
}
},
"type": "object",
"description": "Executive Assistant settings for a user",
"title": "Executive Assistant"
},
"monitoring": {
"properties": {
"member": {
"items": {
"type": "object",
"properties": {
"displayName": {
"readonly": true,
"type": "string",
"title": "Display Name"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
},
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"id": {
"target": "/api/device/spark/UserConfig/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Id",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"target_model_type": "device/spark/UserConfig",
"type": "string"
},
"locationId": {
"readonly": true,
"type": "string",
"title": "LocationId"
},
"numbers": {
"items": {
"properties": {
"external": {
"readonly": true,
"type": "string",
"title": "External"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"primary": {
"readonly": true,
"type": "boolean",
"title": "Primary"
}
},
"type": "object",
"description": "member",
"title": "Member"
},
"readonly": true,
"type": "array",
"description": "numbers",
"title": "Numbers"
},
"type": {
"readonly": true,
"choices": [
{
"value": "PEOPLE",
"title": "People"
},
{
"value": "PLACE",
"title": "Place"
},
{
"value": "VIRTUAL_LINE",
"title": "Virtual Line"
}
],
"type": "string",
"title": "Type"
},
"email": {
"readonly": true,
"type": "string",
"title": "Email"
},
"location": {
"readonly": true,
"type": "string",
"title": "Location"
}
}
},
"type": "array",
"description": "member",
"title": "Member"
},
"callparkextension": {
"items": {
"type": "object",
"properties": {
"location": {
"readonly": true,
"type": "string",
"title": "Location"
},
"locationId": {
"readonly": true,
"type": "string",
"title": "LocationId"
},
"name": {
"readonly": true,
"type": "string",
"title": "Name"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"id": {
"target": "/api/device/spark/CallParkExtensions/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Id",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/CallParkExtensions",
"type": "string"
}
}
},
"type": "array",
"description": "callparkextension",
"title": "Call Park Extension"
},
"callParkNotificationEnabled": {
"type": "boolean",
"description": "callParkNotificationEnabled",
"title": "Call Park Notification Enabled"
}
},
"required": false,
"type": "object",
"description": "Monitoring settings for a user",
"title": "Monitoring"
},
"hoteling": {
"properties": {
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
}
},
"required": false,
"type": "object",
"description": "Hoteling settings for a user",
"title": "Hoteling"
},
"incomingPermission": {
"properties": {
"internalCallsEnabled": {
"type": "boolean",
"title": "Allow Internal Calls"
},
"useCustomEnabled": {
"type": "boolean",
"description": "Use Custom Settings",
"title": "Use Custom Settings"
},
"externalTransfer": {
"choices": [
{
"value": "ALLOW_ALL_EXTERNAL",
"title": "Allow All External"
},
{
"value": "ALLOW_ONLY_TRANSFERRED_EXTERNAL",
"title": "Allow Only Transferred External"
},
{
"value": "BLOCK_ALL_EXTERNAL",
"title": "Block All External"
}
],
"type": "string",
"title": "Allow External Calls"
},
"collectCallsEnabled": {
"type": "boolean",
"title": "Allow Collect Calls"
}
},
"type": "object",
"description": "Incoming Permission settings for a user",
"title": "Incoming Permission"
},
"displayName": {
"type": "string",
"title": "Display Name"
},
"firstName": {
"type": "string",
"title": "First Name"
},
"lastName": {
"type": "string",
"title": "Last Name"
},
"voicemail": {
"properties": {
"sendBusyCalls": {
"type": "object",
"properties": {
"greetingUploaded": {
"type": "boolean",
"description": "greetingUploaded",
"title": "Greeting Uploaded"
},
"enabled": {
"type": "boolean",
"title": "Send calls to voicemail when the line is engaged"
},
"greeting": {
"choices": [
{
"value": "CUSTOM",
"title": "Custom"
},
{
"value": "DEFAULT",
"title": "Default"
}
],
"type": "string",
"title": "Greeting"
}
},
"title": "Send Busy Calls"
},
"emailCopyOfMessage": {
"type": "object",
"properties": {
"emailId": {
"type": "string",
"description": "Use this email address for voicemail messages",
"title": "Email Id"
},
"enabled": {
"type": "boolean",
"title": "Email a copy of the voicemail message"
}
},
"title": "Email Copy Of Message"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"sendAllCalls": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Send all incoming calls to voicemail"
}
},
"title": "Send All Calls"
},
"notifications": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"title": "Destination email"
},
"enabled": {
"type": "boolean",
"title": "Receive notification of any new voice messages"
}
},
"title": "Notifications"
},
"faxMessage": {
"properties": {
"phoneNumber": {
"type": "string",
"description": "phoneNumber",
"title": "Phone Number"
},
"enabled": {
"type": "boolean",
"description": "enabled",
"title": "Enabled"
},
"extension": {
"type": "string",
"description": "extension",
"title": "Extension"
}
},
"type": "object",
"description": "faxMessage",
"title": "Fax Message"
},
"transferToNumber": {
"type": "object",
"properties": {
"destination": {
"type": "string",
"description": "Transfer callers to this phone number",
"title": "Destination"
},
"enabled": {
"type": "boolean",
"description": "To tell the caller that pressing \u20180\u2019 will transfer to a specific phone number, a custom greeting must be recorded",
"title": "Transfer on \u20180\u2019 to another line"
}
},
"title": "Transfer To Number"
},
"sendUnansweredCalls": {
"type": "object",
"properties": {
"numberOfRings": {
"type": "integer",
"title": "Number of rings before playing the \u2018no answer\u2019 message"
},
"greetingUploaded": {
"type": "boolean",
"description": "greetingUploaded",
"title": "Greeting Uploaded"
},
"systemMaxNumberOfRings": {
"type": "integer",
"description": "System Max number of rings setting",
"title": "System Max Number Of Rings before forwarding to voicemail"
},
"enabled": {
"type": "boolean",
"title": "Send calls to voicemail when unanswered"
},
"greeting": {
"choices": [
{
"value": "CUSTOM",
"title": "Custom"
},
{
"value": "DEFAULT",
"title": "Default"
}
],
"type": "string",
"title": "Greeting"
}
},
"title": "Send Unanswered Calls"
},
"messageStorage": {
"properties": {
"storageType": {
"choices": [
{
"value": "INTERNAL",
"title": "Internal"
},
{
"value": "EXTERNAL",
"title": "External"
}
],
"type": "string",
"title": "Storage Type"
},
"mwiEnabled": {
"type": "boolean",
"description": "mwiEnabled",
"title": "Mwi Enabled"
},
"externalEmail": {
"type": "string",
"description": "externalEmail",
"title": "External Email"
}
},
"type": "object",
"description": "messageStorage",
"title": "Message Storage"
}
},
"type": "object",
"description": "Voicemail settings for a user",
"title": "Voicemail"
},
"devices": {
"properties": {
"device": {
"items": {
"type": "object",
"properties": {
"hoteling": {
"readonly": true,
"type": "object",
"properties": {
"limitGuestUse": {
"readonly": true,
"type": "boolean",
"title": "Limit Guest Use"
},
"enabled": {
"readonly": true,
"type": "boolean",
"description": "Allow this device to be used as a hotelling host by visiting guests",
"title": "Enabled"
},
"guestHoursLimit": {
"readonly": true,
"type": "integer",
"description": "Limit the time a guest can use this phone",
"title": "Guest Hours Limit"
}
},
"title": "Hoteling"
},
"description": {
"items": {
"type": "string"
},
"readonly": true,
"type": "array",
"name": "description",
"title": "Description"
},
"owner": {
"readonly": true,
"type": "object",
"properties": {
"lastName": {
"readonly": true,
"type": "string",
"title": "Last Name"
},
"type": {
"readonly": true,
"type": "string",
"description": "type",
"title": "Type"
},
"id": {
"readonly": true,
"type": "string",
"description": "id",
"title": "Id"
},
"firstName": {
"readonly": true,
"type": "string",
"title": "First Name"
}
},
"title": "Owner"
},
"mac": {
"readonly": true,
"type": "string",
"title": "Mac Address"
},
"primaryOwner": {
"readonly": true,
"type": "boolean",
"title": "Primary Owner"
},
"activationState": {
"readonly": true,
"type": "string",
"title": "Activation State"
},
"model": {
"readonly": true,
"type": "string",
"title": "Model"
},
"type": {
"readonly": true,
"type": "string",
"title": "Type"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
}
}
},
"description": "Device",
"type": "array",
"name": "device",
"title": "Device"
},
"maxDeviceCount": {
"readonly": true,
"type": "integer",
"description": "maxDeviceCount",
"title": "Max Device Count"
}
},
"required": false,
"type": "object",
"description": "Devices associated with a user",
"title": "Devices"
},
"callBridge": {
"properties": {
"warningToneEnabled": {
"type": "boolean",
"description": "Play an entry tone to all participants upon bridge-in.",
"title": "Call bridging warning tone"
}
},
"required": false,
"type": "object",
"description": "Call Bridge settings for a user",
"title": "Call Bridge"
}
},
"title": "Calling"
},
"displayName": {
"type": "string",
"title": "Display Name"
},
"firstName": {
"type": "string",
"title": "First Name"
},
"extension": {
"required": false,
"type": "string",
"description": "Webex Calling extension of the person. This is only settable for a person with a Webex Calling license.",
"title": "Extension"
},
"created": {
"readonly": true,
"format": "date-time",
"type": "string",
"title": "Date Created"
},
"lastName": {
"type": "string",
"title": "Last Name"
},
"settings": {
"cache_only": true,
"type": "object",
"properties": {
"calling": {
"type": "object",
"properties": {
"SparkCSFDevice": {
"default": "true",
"type": "boolean",
"title": "Create CSF Device"
},
"SparkiPhoneDevice": {
"default": "true",
"type": "boolean",
"title": "Create iPhone Device"
},
"SparkAndroidDevice": {
"default": "true",
"type": "boolean",
"title": "Create Android Device"
},
"SparkTabletDevice": {
"default": "true",
"type": "boolean",
"title": "Create Tablet Device"
},
"use_org_domain": {
"type": "boolean",
"description": "Enabling this will use the Webex App organization domain for Calling in Webex App (Unified CM)",
"title": "Use Organization's Domain"
},
"calling_behaviour_uc_manager_profile": {
"target": "/api/device/spark/CallingProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "UC Manager Profile",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/spark/CallingProfile",
"type": "string"
},
"calling_behaviour": {
"choices": [
{
"value": "Calling in Webex App",
"title": "Calling in Webex App"
},
{
"value": "Calling in Webex App (Unified CM)",
"title": "Calling in Webex App (Unified CM)"
},
{
"value": "Cisco Jabber app",
"title": "Cisco Jabber app"
},
{
"value": "Third-Party app",
"title": "Third-Party app"
}
],
"type": "string",
"description": "This determines how a user makes calls in Webex App.",
"title": "Calling Behaviour"
}
},
"title": "Calling"
}
},
"title": "Settings"
},
"loginEnabled": {
"readonly": true,
"type": "boolean",
"title": "Login Enabled"
}
},
"schema_version": "1.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/SparkUser/add/ |
|
The GUI Add form of relation/SparkUser as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/SparkUser | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/SparkUser/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/SparkUser/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/SparkUser |
|
{"hrefs": ["/api/relation/SparkUser/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/SparkUser |
|
{"hrefs": ["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/SparkUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/SparkUser/export/ |
|
{ "hrefs":["/api/relation/SparkUser/[pkid1]", "/api/relation/SparkUser/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/SparkUser and the JSON format can be used to import instances of relation/SparkUser.
GET http://[host-proxy]/api/relation/SparkUser/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/SparkUser | POST | /api/relation/SparkUser/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/SparkUser/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/SparkUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/SparkUser/ |
|
The relation/SparkUser schema and all instances as JSON. |
(The list will return 0 to 3 relation/SparkUser instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "firstName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/SparkUser/?skip=0&limit=3&order_by=firstName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.3",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/SparkUser/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/SparkUser/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/SparkUser/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/SparkUser",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/SparkUser/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/SparkUser/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/SparkUser/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/SparkUser/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/SparkUser/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/SparkUser/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/SparkUser",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"move",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "firstName",
"title": "First Name"
},
{
"name": "lastName",
"title": "Last Name"
},
{
"name": "email",
"title": "Email Address"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "settings.calling.calling_behaviour",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "settings.calling.use_org_domain",
"title": "Use Organization's Domain"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "settings.calling.calling_behaviour_uc_manager_profile",
"title": "UC Manager Profile"
},
{
"name": "calling_pro",
"title": "Webex Calling - Professional"
},
{
"name": "invitePending",
"title": "Invite Pending"
},
{
"name": "loginEnabled",
"title": "Login Enabled"
},
{
"name": "type",
"title": "User Type"
},
{
"name": "status",
"title": "Status"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/SparkUser. | GET | /api/relation/SparkUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/SparkUser as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/SparkUser/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/SparkUser/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/SparkUser | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/SparkUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/SparkUser/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/SparkUser and the JSON format can be used to import instances of relation/SparkUser.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/SparkUser/[pkid] | hierarchy=[hierarchy] | The relation/SparkUser instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/SparkUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/SparkUser. |