[Index]

Model: relation/WebexAutoAttendants

Webex Auto Attendants

Model Details: relation/WebexAutoAttendants

Title Description Details
aa_key
  • Field Name: aa_id
  • Type: String
id
  • Field Name: id
  • Type: String
locationId *
  • Field Name: locationId
  • Type: String
  • Target: /api/device/spark/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24kkBsZ2B7GqkdZGTl%24ja6nlCaQIieY5NXb8JKpo/LiCtY6UJ%2BOf3zt75vJTAKllToZKvrDkdJ3zNFv1MUgZAgoMf0iPHtUSh/rbm7v79X4wWFlYa49V9XZqyIlh/D4hqMTGEbQUhYqpi9t6Jpjm7aJGZ%2BybLvHQSUl44Quf9%2BMGcDzlOjvReSJzmU7MEAierefYkcLGsXfMaGYHw%2BHWYZIcvQeweJgiIZAqPLFSthSaHW7pZsfPyacTn7MBBgQ/9q3sBaFqfY3u2AHdXYg0VkTMwg9mqIy6JbJR32611%2Bbh2AJ6sl1bS/9KFWBqqIS2hsvHvyvOKwCT1m5YmfTDv3qC8VsRph2HZwK3hyXU43caq2soC/9IVXRTjwgrXiO2XOIsDkfb531v2cBG9lLUVvWgnSc0Pt/68UBL54XINtlTGp90nyDcMg7AY0k0%2BN5YnHkBhUN1M9vOXBLWbcwveIiHaSL14uN/ZUaV0%2BwWN6num8wGP2/wt3kdq1YGdXd0DflmXbK0FqbzofmejPUMysj90ff%24%3D%3D
  • Target attr: name
  • Target Model Type: device/spark/Location
  • Format: uri
  • Choices: []
locationName
  • Field Name: locationName
  • Type: String
Name *
  • Field Name: name
  • Type: String
Enabled
  • Field Name: enabled
  • Type: Boolean
Phone Number
  • Field Name: phoneNumber
  • Type: String
Extension
  • Field Name: extension
  • Type: String
Toll Free Number Flag to indicate if auto attendant number is toll-free number
  • Field Name: tollFreeNumber
  • Type: Boolean
First Name *
  • Field Name: firstName
  • Type: String
Last Name *
  • Field Name: lastName
  • Type: String
Alternate Numbers
  • Field Name: alternateNumbers.[n]
  • Type: Array
Phone Number phoneNumber
  • Field Name: alternateNumbers.[n].phoneNumber
  • Type: String
Ring Pattern * ringPattern
  • Field Name: alternateNumbers.[n].ringPattern
  • Type: String
  • Choices: ["NORMAL", "LONG_LONG", "SHORT_SHORT_LONG", "SHORT_LONG_SHORT"]
TollFree Number tollFreeNumber
  • Field Name: alternateNumbers.[n].tollFreeNumber
  • Type: Boolean
Language *
  • Field Name: language
  • Type: String
Language Code
  • Field Name: languageCode
  • Type: String
Business Hours Schedule * Business hours defined for the auto attendant
  • Field Name: businessSchedule
  • Type: String
Holiday Schedule Holiday defined for the auto attendant
  • Field Name: holidaySchedule
  • Type: String
Extension Dialing Extension dialing setting. If the values are not set default will be set as ENTERPRISE
  • Field Name: extensionDialing
  • Type: String
  • Choices: ["ENTERPRISE", "GROUP"]
Name Dialing Name dialing setting. If the values are not set default will be set as ENTERPRISE
  • Field Name: nameDialing
  • Type: String
  • Choices: ["ENTERPRISE", "GROUP"]
Time Zone
  • Field Name: timeZone
  • Type: String
Business Hours Menu Business hours menu defined for the auto attendant
  • Field Name: businessHoursMenu
  • Type: Object
Greeting
  • Field Name: businessHoursMenu.greeting
  • Type: String
  • Choices: ["DEFAULT", "CUSTOM"]
Greeting File Announcement Audio File details
  • Field Name: audioAnnouncementFile
  • Type: Object
Level Audio announcement file type location
  • Field Name: businessHoursMenu.audioAnnouncementFile.level
  • Type: String
  • Choices: ["Enterprise", "Location"]
Name
  • Field Name: businessHoursMenu.audioAnnouncementFile.id
  • Type: String
  • Target: /api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UA6Z8eVQd0T0MKUl%24lNV28ksGxjhB5UcboXpLqopBqBBurgWAUBnb1Qjn03jXaTtv7NWVJmQAPITju/9M078XY89Hz4dRlZCl2EivVN9ijv57NHBgW3Z/v0bTKxIfFt/7KIwdMPRHhjimfMWl6vgFvYNeFaph8hfF7UPwBJZrTfRPqHboVPep5Enlv2cNhYKiBrsLfIUAjFaGI0nZPxeEubdp5ubu1E3X7zRhSw6KQOTVCnVfJS684feNXIg3SQbszYkFzIhPk/M9tXK107HUjPOz4z7m%2Bu3uIryjqdP9F0WtqxVVGd2/CzZoC16j04%2BkuEgOIa1z9VmpcYrM2QnIbi0GG96Umes2gRyMnj4niaR0SU3UU2yjvBJq0EETgNGarxGub9pNrwSk6UoQY5tQg8wjzKqx1YjcKSnTV18DDG3Ejr4p8XZSj6JfZ7nCikm3/DNvp91kew4ia4tPcl4WOJ4z/XgHgqVzNs9FqHDB7D1mMuNKvWXu0OBf6n0bN3efFnNsWIoPv1bLfDpl3LdqkCA6THeCBUk%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/spark/Announcements
  • Format: uri
  • Choices: []
File Name
  • Field Name: businessHoursMenu.audioAnnouncementFile.fileName
  • Type: String
File Type
  • Field Name: businessHoursMenu.audioAnnouncementFile.mediaFileType
  • Type: String
Extension Dialing Enable extension dialling without requiring a menu item
  • Field Name: businessHoursMenu.extensionEnabled
  • Type: Boolean
Key Configurations Key configurations defined for the auto attendant
  • Field Name: keyConfigurations.[n]
  • Type: Array
Key Key assigned to specific menu configuration
  • Field Name: businessHoursMenu.keyConfigurations.[n].key
  • Type: String
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "#", "*"]
Action Action assigned to specific menu key configuration
  • Field Name: businessHoursMenu.keyConfigurations.[n].action
  • Type: String
  • Choices: ["Play announcement", "Transfer call with prompt", "Transfer call without prompt", "Transfer call to operator", "Transfer to voicemail", "Dial by name", "Dial by extension", "Repeat menu", "Exit Menu"]
Description Provide a label for this menu option
  • Field Name: businessHoursMenu.keyConfigurations.[n].key_description
  • Type: String
Phone Number or Extension
  • Field Name: businessHoursMenu.keyConfigurations.[n].value
  • Type: String
Announcement File Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set
  • Field Name: audioAnnouncementFile
  • Type: Object
Level Audio announcement file type location
  • Field Name: businessHoursMenu.keyConfigurations.[n].audioAnnouncementFile.level
  • Type: String
  • Choices: ["Enterprise", "Location"]
Name
  • Field Name: businessHoursMenu.keyConfigurations.[n].audioAnnouncementFile.id
  • Type: String
  • Target: /api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UA6Z8eVQd0T0MKUl%24lNV28ksGxjhB5UcboXpLqopBqBBurgWAUBnb1Qjn03jXaTtv7NWVJmQAPITju/9M078XY89Hz4dRlZCl2EivVN9ijv57NHBgW3Z/v0bTKxIfFt/7KIwdMPRHhjimfMWl6vgFvYNeFaph8hfF7UPwBJZrTfRPqHboVPep5Enlv2cNhYKiBrsLfIUAjFaGI0nZPxeEubdp5ubu1E3X7zRhSw6KQOTVCnVfJS684feNXIg3SQbszYkFzIhPk/M9tXK107HUjPOz4z7m%2Bu3uIryjqdP9F0WtqxVVGd2/CzZoC16j04%2BkuEgOIa1z9VmpcYrM2QnIbi0GG96Umes2gRyMnj4niaR0SU3UU2yjvBJq0EETgNGarxGub9pNrwSk6UoQY5tQg8wjzKqx1YjcKSnTV18DDG3Ejr4p8XZSj6JfZ7nCikm3/DNvp91kew4ia4tPcl4WOJ4z/XgHgqVzNs9FqHDB7D1mMuNKvWXu0OBf6n0bN3efFnNsWIoPv1bLfDpl3LdqkCA6THeCBUk%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/spark/Announcements
  • Format: uri
  • Choices: []
File Name
  • Field Name: businessHoursMenu.keyConfigurations.[n].audioAnnouncementFile.fileName
  • Type: String
File Type
  • Field Name: businessHoursMenu.keyConfigurations.[n].audioAnnouncementFile.mediaFileType
  • Type: String
After Hours Menu After hours menu defined for the auto attendant
  • Field Name: afterHoursMenu
  • Type: Object
Greeting
  • Field Name: afterHoursMenu.greeting
  • Type: String
  • Choices: ["DEFAULT", "CUSTOM"]
Greeting File Announcement Audio File details
  • Field Name: audioAnnouncementFile
  • Type: Object
Level Audio announcement file type location
  • Field Name: afterHoursMenu.audioAnnouncementFile.level
  • Type: String
  • Choices: ["Enterprise", "Location"]
Name
  • Field Name: afterHoursMenu.audioAnnouncementFile.id
  • Type: String
  • Target: /api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UA6Z8eVQd0T0MKUl%24lNV28ksGxjhB5UcboXpLqopBqBBurgWAUBnb1Qjn03jXaTtv7NWVJmQAPITju/9M078XY89Hz4dRlZCl2EivVN9ijv57NHBgW3Z/v0bTKxIfFt/7KIwdMPRHhjimfMWl6vgFvYNeFaph8hfF7UPwBJZrTfRPqHboVPep5Enlv2cNhYKiBrsLfIUAjFaGI0nZPxeEubdp5ubu1E3X7zRhSw6KQOTVCnVfJS684feNXIg3SQbszYkFzIhPk/M9tXK107HUjPOz4z7m%2Bu3uIryjqdP9F0WtqxVVGd2/CzZoC16j04%2BkuEgOIa1z9VmpcYrM2QnIbi0GG96Umes2gRyMnj4niaR0SU3UU2yjvBJq0EETgNGarxGub9pNrwSk6UoQY5tQg8wjzKqx1YjcKSnTV18DDG3Ejr4p8XZSj6JfZ7nCikm3/DNvp91kew4ia4tPcl4WOJ4z/XgHgqVzNs9FqHDB7D1mMuNKvWXu0OBf6n0bN3efFnNsWIoPv1bLfDpl3LdqkCA6THeCBUk%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/spark/Announcements
  • Format: uri
  • Choices: []
File Name
  • Field Name: afterHoursMenu.audioAnnouncementFile.fileName
  • Type: String
File Type
  • Field Name: afterHoursMenu.audioAnnouncementFile.mediaFileType
  • Type: String
Extension Dialing Enable extension dialling without requiring a menu item
  • Field Name: afterHoursMenu.extensionEnabled
  • Type: Boolean
Key Configurations Key configurations defined for the auto attendant
  • Field Name: keyConfigurations.[n]
  • Type: Array
Key Key assigned to specific menu configuration
  • Field Name: afterHoursMenu.keyConfigurations.[n].key
  • Type: String
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "#"]
Action Action assigned to specific menu key configuration
  • Field Name: afterHoursMenu.keyConfigurations.[n].action
  • Type: String
  • Choices: ["Play announcement", "Transfer call with prompt", "Transfer call without prompt", "Transfer call to operator", "Transfer to voicemail", "Dial by name", "Dial by extension", "Repeat menu", "Exit Menu"]
Description Provide a label for this menu option
  • Field Name: afterHoursMenu.keyConfigurations.[n].key_description
  • Type: String
Phone Number or Extension
  • Field Name: afterHoursMenu.keyConfigurations.[n].value
  • Type: String
Announcement File Pre-configured announcement audio files when PLAY_ANNOUNCEMENT is set
  • Field Name: audioAnnouncementFile
  • Type: Object
Level Audio announcement file type location
  • Field Name: afterHoursMenu.keyConfigurations.[n].audioAnnouncementFile.level
  • Type: String
  • Choices: ["Enterprise", "Location"]
Name
  • Field Name: afterHoursMenu.keyConfigurations.[n].audioAnnouncementFile.id
  • Type: String
  • Target: /api/device/spark/Announcements/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24UA6Z8eVQd0T0MKUl%24lNV28ksGxjhB5UcboXpLqopBqBBurgWAUBnb1Qjn03jXaTtv7NWVJmQAPITju/9M078XY89Hz4dRlZCl2EivVN9ijv57NHBgW3Z/v0bTKxIfFt/7KIwdMPRHhjimfMWl6vgFvYNeFaph8hfF7UPwBJZrTfRPqHboVPep5Enlv2cNhYKiBrsLfIUAjFaGI0nZPxeEubdp5ubu1E3X7zRhSw6KQOTVCnVfJS684feNXIg3SQbszYkFzIhPk/M9tXK107HUjPOz4z7m%2Bu3uIryjqdP9F0WtqxVVGd2/CzZoC16j04%2BkuEgOIa1z9VmpcYrM2QnIbi0GG96Umes2gRyMnj4niaR0SU3UU2yjvBJq0EETgNGarxGub9pNrwSk6UoQY5tQg8wjzKqx1YjcKSnTV18DDG3Ejr4p8XZSj6JfZ7nCikm3/DNvp91kew4ia4tPcl4WOJ4z/XgHgqVzNs9FqHDB7D1mMuNKvWXu0OBf6n0bN3efFnNsWIoPv1bLfDpl3LdqkCA6THeCBUk%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/spark/Announcements
  • Format: uri
  • Choices: []
File Name
  • Field Name: afterHoursMenu.keyConfigurations.[n].audioAnnouncementFile.fileName
  • Type: String
File Type
  • Field Name: afterHoursMenu.keyConfigurations.[n].audioAnnouncementFile.mediaFileType
  • Type: String
Call Forwarding Settings Call Forwarding Settings
  • Field Name: callForwarding
  • Type: Object
Always
  • Field Name: always
  • Type: Object
Enabled enabled
  • Field Name: callForwarding.always.enabled
  • Type: Boolean
Ring Reminder Enabled ringReminderEnabled
  • Field Name: callForwarding.always.ringReminderEnabled
  • Type: Boolean
Send To Voicemail Enabled destinationVoiceMailEnabled
  • Field Name: callForwarding.always.destinationVoiceMailEnabled
  • Type: Boolean
Destination destination
  • Field Name: callForwarding.always.destination
  • Type: String
Selective
  • Field Name: selective
  • Type: Object
Enabled enabled
  • Field Name: callForwarding.selective.enabled
  • Type: Boolean
Ring Reminder Enabled ringReminderEnabled
  • Field Name: callForwarding.selective.ringReminderEnabled
  • Type: Boolean
Send To Voicemail Enabled destinationVoiceMailEnabled
  • Field Name: callForwarding.selective.destinationVoiceMailEnabled
  • Type: Boolean
Destination destination
  • Field Name: callForwarding.selective.destination
  • Type: String
Rules rules
  • Field Name: rules.[n]
  • Type: Array
Name name
  • Field Name: callForwarding.rules.[n].name
  • Type: String
Enabled enabled
  • Field Name: callForwarding.rules.[n].enabled
  • Type: Boolean
id id
  • Field Name: callForwarding.rules.[n].id
  • Type: String
Holiday Schedule holidaySchedule
  • Field Name: callForwarding.rules.[n].holidaySchedule
  • Type: String
Business Schedule businessSchedule
  • Field Name: callForwarding.rules.[n].businessSchedule
  • Type: String
Forward To forwardTo
  • Field Name: forwardTo
  • Type: Object
Selection selection
  • Field Name: callForwarding.rules.[n].forwardTo.selection
  • Type: String
  • Choices: ["FORWARD_TO_DEFAULT_NUMBER", "FORWARD_TO_SPECIFIED_NUMBER", "DO_NOT_FORWARD"]
Phone Number phoneNumber
  • Field Name: callForwarding.rules.[n].forwardTo.phoneNumber
  • Type: String
Calls From callsFrom
  • Field Name: callsFrom
  • Type: Object
Selection selection
  • Field Name: callForwarding.rules.[n].callsFrom.selection
  • Type: String
  • Choices: ["ANY", "CUSTOM"]
Custom Numbers customNumbers
  • Field Name: customNumbers
  • Type: Object
Any Private Numbers privateNumberEnabled
  • Field Name: callForwarding.rules.[n].callsFrom.customNumbers.privateNumberEnabled
  • Type: Boolean
Any Unavailable Numbers unavailableNumberEnabled
  • Field Name: callForwarding.rules.[n].callsFrom.customNumbers.unavailableNumberEnabled
  • Type: Boolean
Numbers
  • Field Name: numbers.[n]
  • Type: Array
Calls To callsTo
  • Field Name: callsTo
  • Type: Object
Calls To Numbers Array of numbers to be matched against the calling destination number
  • Field Name: numbers.[n]
  • Type: Array
Type Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary or alternate number
  • Field Name: callForwarding.rules.[n].callsTo.numbers.[n].type
  • Type: String
  • Choices: ["PRIMARY", "ALTERNATE"]
Phone Number Only return call queues with matching primary phone number or extension
  • Field Name: callForwarding.rules.[n].callsTo.numbers.[n].phoneNumber
  • Type: String
Extension Primary phone extension of the call queue.
  • Field Name: callForwarding.rules.[n].callsTo.numbers.[n].extension
  • Type: String
Noinstance
  • Field Name: noinstance.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: noinstance.[n].name
  • Type: String
  • MaxLength: 1024