IVR Common Objects

IVR attributes in List

Name	Type	Method	Description
		GET
serviceUserId	String	A	Identifies the auto attendant. Must be a valid SIP URI.
name	String	A	The name of the auto attendant.
active	Boolean	A	The status of the auto attendant.
type	String	A	The type of the auto attendant.
phoneNumber	String	A	The phone number of the auto attendant.
extension	String	A	The extension of the auto attendant.
department	Object	C	An object as defined in Group department key attributes.

IVR Instance attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
serviceUserId	String	A	C	R	R	Identifies the IVR. Must be a valid SIP URI. See Service User Id for the ways it could be auto-generated.
type	String	A	F	F	F	The type of the IVR .
serviceInstanceProfile	Object	A	O	O	F	An object of type IVR Instance Profile attributes.
firstDigitTimeoutSeconds	String	A	O	O	F	Number of seconds before transfer to operator.
businessHours	Object	O	O	O	F	An object of type Schedule attributes. Or null or “” to remove it.
holidaySchedule	Object	O	O	O	F	An object of type Schedule attributes. Or null or “” to remove it.
extensionDialingScope	Boolean	A	O	O	F	The scope of the extension to dial.
nameDialingScope	String	A	O	O	F	The scope of the name to dial.
nameDialingEntries	String	A	O	O	F	The structure of the name to dial.
afterHoursMenu	Object	A	O	O	F	An object of type IVR Instance Menu attributes.
businessHoursMenu	Object	A	O	O	F	An object of type IVR Instance Menu attributes.
holidayMenu	Object	C	C	C	F	An object of type IVR Instance Menu attributes. Allowed only for some types of IVRs.
networkClassOfService	String	A	O	O	F	TODO
templateName	String	N	O	O	F	As defined as Template Name.

IVR Instance Profile attributes

Name	Type	Methods			Description
		GET	POST	PUT
name	String	A	R	O	See name from Service User Profile.
cliFirstName	String	A	O	O	See cliFirstName from Service User Profile.
cliLastName	String	A	O	O	See cliLastName from Service User Profile.
phoneNumber	String	A	O	O	See phoneNumber from Service User Profile.
extension	String	A	O	O	See extension from Service User Profile.
department	String	A	O	O	See department from Service User Profile.
language	String	A	O	O	See language from Service User Profile.
timeZone	String	A	O	O	See timeZone from Service User Profile.
aliases	String	A	O	O	See aliases from Service User Profile.
publicUserIdentity	String	A	O	O	See publicUserIdentity from Service User Profile.
cliPhoneNumber	String	A	O	O	See cliPhoneNumber from Service User Profile.
password	String	N	O	F	The password.

IVR Instance Menu attributes

Name	Type	Methods			Description
		GET	POST	PUT
announcementSelection	String	A	O	O	Selection between Default and Personal Greeting message.
audioFile	Object	A	O	O	An objects as defined as Audio File attributes.
enableFirstMenuLevelExtensionDialing	Boolean	A	O	O	Allow callers to enter the extension of the party they want to reach without selecting a menu option first.
keys	Object	A	O	O	An objects as defined as IVR Key Configurations attributes.
empty_menu	Boolean	N	O	O	Specify if the menu has to be cleared.

IVR Key Configurations attributes

Name	Type	Methods			Description
		GET	POST	PUT
key	String	A	R	R	The key identifier of the menu entry. One of 0-9, ‘*’ or ‘#’.
action	String	A	R	R	The action to be performed. One of “Transfer To Number With Prompt”, “Transfer To Number”, “Transfer To Operator”, “Name Dialing”, “Extension Dialing”, “Repeat Menu”, “Exit”, “Transfer To User Mailbox”, “Go To Submenu”, “Back To Parent Menu”, “Play Announcement”. Set it to null (None) to remove the key entry.
description	String	A	O	O	The description of the me nu entry.
parameter	String Object	O	C	C	The parameter for the menu entry. It is dependant from the action. Can be a phone number, a submenuId, or an object representing an audio file as defined as Announcement File Name.

IVR attributes in Submenu List

Name	Type	Method	Description
		GET
submenuId	String	A	Identifies the submenu in an auto attendant.
used	Boolean	A	Determines if the submenu is used by an auto attendant or not.