IVR Sub-Menus¶

Display group IVR instance’s submenu list¶

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

Retrieve the settings of the specified IVR instance’s submenu. Note that submenus are only allowed for Standard IVRs.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/ivrs/basic_group_test@sip.netaxis.be/submenus/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "submenus": [
      {
         "submenuId": "sub01",
         "used": "true"
      }
   ]
}

Response JSON Object:

submenus (array) – a list of submenu objects as defined as IVR attributes in Submenu List.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Display group IVR instance’s submenu¶

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

Retrieve the settings of the specified IVR instance’s submenu. Note that submenus are only allowed for Standard IVRs.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/ivrs/basic_group_test@sip.netaxis.be/submenus/sub01/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "announcementSelection": "Default",
   "enableLevelExtensionDialing": false,
   "keys": [
      {
         "key": "1",
         "description": "repeat",
         "action": "Repeat Menu"
      }
   ]
}

Response JSON Object:

announcementSelection (string) – see announcementSelection as defined as IVR Instance Menu attributes.
enableLevelExtensionDialing (boolean) – see enableLevelExtensionDialing as defined as IVR Instance Menu attributes.
keys (array) – see keys as defined as IVR Instance Menu attributes.

Request JSON Object:

audioFile (object) – see audioFile as defined as IVR Instance Menu attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Assign a group IVR instance’s submenu¶

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

Create new submenu for the IVR instance. Note that submenus are only allowed for Standard IVRs.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/services/ivrs/basic_group_test@sip.netaxis.be/submenus/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "submenuId": "test",
   "announcementSelection": "Default",
   "keys": [
      {"key": "1", "action": "Transfer To User Mailbox", "description": "voicemail"},
      {"key": "2", "action": "Go To Submenu", "description": "to submenu", "destination": "sub02"}
   ]
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

submenuId (string) – see submenuId of IVR attributes in Submenu List.
announcementSelection (string) – see announcementSelection as defined as IVR Instance Menu attributes.
audioFile (object) – see audioFile as defined as IVR Instance Menu attributes.
enableLevelExtensionDialing (boolean) – see enableLevelExtensionDialing as defined as IVR Instance Menu attributes.
keys (array) – see keys as defined as IVR Instance Menu attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Update a group IVR instance’s submenu¶

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

Update the settings of a submenu of the specified IVR instance. Note that submenus are only allowed for Standard IVRs.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/ivrs/basic_group_test@sip.netaxis.be/submenus/sub01/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "announcementSelection": "Personal",
   "audioFile": "APIO Group Test Music On Hold",
   "keys": [
      {"key": "4", "action": "Transfer To User Mailbox", "description": "voicemail"},
      {"key": "6", "action": "Go To Submenu", "description": "to submenu"}
   ]
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

submenuId (string) – see submenuId of IVR attributes in Submenu List.
announcementSelection (string) – see announcementSelection as defined as IVR Instance Menu attributes.
audioFile (object) – see audioFile as defined as IVR Instance Menu attributes.
enableLevelExtensionDialing (boolean) – see enableLevelExtensionDialing as defined as IVR Instance Menu attributes.
keys (array) – see keys as defined as IVR Instance Menu attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Disassign a group IVR instance’s submenu¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/ivrs/(string: user_id)/submenus/(string: instance_name)/¶

Disassign a submenu of the specified IVR instance. Note that submenus are only allowed for Standard IVRs.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/ivrs/basic_group_test@sip.netaxis.be/submenus/sub01/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the deletion