IVR (Auto-Attendant)

Retrieve list of IVRs

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/ivrs/

The API is mapped to GroupAutoAttendantGetInstanceListRequest

Additional information:

Response JSON Object:

• ivrs (array) – a list of auto attendant objects as defined as IVR attributes in List.

Update the status of IVRs

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/

The API is mapped to GroupAutoAttendantModifyActiveInstanceListRequest

Additional requirements:

Request JSON Object:

• serviceActivations (array) – a list of auto attendant objects as defined as IVR attributes in List.

Display group’s IVR instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)

The API is mapped to GroupAutoAttendantGetInstanceRequest20

Additional information:

Response JSON Object:

• ivrInstance (object) – see IVR Instance attributes.

Assign a group’s IVR instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)

The API is mapped to GroupAutoAttendantAddInstanceRequest20

Additional requirements:

Request JSON Object:

• ivrInstance (object) – see IVR Instance attributes.

Update a group’s IVR instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)

The API is mapped to GroupAutoAttendantModifyInstanceRequest20

Additional requirements:

Request JSON Object:

• ivrInstance (object) – see IVR Instance attributes.

Disassign a group’s IVR instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)

The API is mapped to GroupAutoAttendantDeleteInstanceRequest

Display group IVR instance’s menu

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)/menus/(string: instance_name)/

Virtual API not supported by Broadsoft

Additional information:

Response JSON Object:

• afterHoursMenu (object) – see afterHoursMenu from IVR Instance Menu attributes.

• businessHoursMenu (object) – see businessHoursMenu from IVR Instance Menu attributes.

• holidayMenu (object) – see holidayMenu from IVR Instance Menu attributes.

Update a group IVR instance’s menu

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/features/services/ivrs/(string: user_id)/menus/(string: instance_name)/

Virtual API not supported by Broadsoft

Additional requirements:

Request JSON Object:

• afterHoursMenu (object) – see afterHoursMenu from IVR Instance Menu attributes.

• businessHoursMenu (object) – see businessHoursMenu from IVR Instance Menu attributes.

• holidayMenu (object) – see holidayMenu from IVR Instance Menu attributes.

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. One of “Basic” or “Standard”
phoneNumber	String	A	The phone number of the auto attendant.
extension	String	A	The extension of the auto attendant.
department	String	A	The department of the auto attendant.

IVR Instance attributes

Name	Type	Methods				Description
		GET	POST	PUT	DELETE
serviceUserId	String	A	R	R	R	Identifies the auto attendant. Must be a valid SIP URI.
type	String	A	F	F	F	The type of the auto attendant.
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. Value between 1 and 60.
businessHours	Object	A	O	O	F	An object of type Schedule attributes.
holidaySchedule	Object	A	O	O	F	An object of type Schedule attributes.
extensionDialingScope	Boolean	A	O	O	F	The scope of the extension to dial. One of “Enterprise”, “Group” or “Department”.
nameDialingScope	String	A	O	O	F	The scope of the name to dial. One of “Enterprise”, “Group” or “Department”.
nameDialingEntries	String	A	O	O	F	The structure of the name to dial. Can be “LastName + FirstName” or “LastName + FirstName or FirstName + LastName”.
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	A	O	O	F	An object of type IVR Instance Menu attributes.
networkClassOfService	String	A	O	O	F	TODO
templateName	String	F	O	O	F	Only defined at APIO level. It is not a BroadSoft key.

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	R	O	See cliFirstName from Service User Profile.
cliLastName	String	A	R	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. One of “Default” or “Personal”.
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 With Prompt”, “Transfer Without Prompt”, “Transfer To Operator”, “Name Dialing”, “Extension Dialing”, “Repeat Menu”, “Exit”, “Transfer To Mailbox”, “Transfer To Submenu”, “Return to Previous Menu”, “Play Announcement”
description	String	A	O	O	The description of the me nu entry. Max length of 20 characters.
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.