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