IVR Menus¶

Display group IVR instance’s menu list¶

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

Retrieve the settings of IVR instance’s menus.

Example request:

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

Example response:

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

{
     "afterHours": {
          "enableFirstMenuLevelExtensionDialing": false,
          "announcementSelection": "Default",
          "keys": [
               {
                    "key": "0"
                    "action": "Transfer To Operator",
                    "submenuId": "",
                    "phoneNumber": "",
                    "description": "group operator",
               },
               {
                    "key": "1"
                    "action": "Extension Dialing",
                    "submenuId": "",
                    "phoneNumber": "",
                    "description": "dial by extension",
               }
          ]
     },
     "businessHours": {
          "enableFirstMenuLevelExtensionDialing": false,
          "announcementSelection": "Default",
          "keys": [
               {
                    "key": "0"
                    "action": "Repeat Menu",
                    "submenuId": "",
                    "phoneNumber": "",
                    "description": "repeat menu",
               },
               {
                    "key": "2"
                    "action": "Name Dialing",
                    "submenuId": "",
                    "phoneNumber": "",
                    "description": "dial by name",
               }
          ]
     },
     "holiday": {
          "enableFirstMenuLevelExtensionDialing": false,
          "announcementSelection": "Default",
          "keys": [
               {
                    "key": "0",
                    "description": "group operator",
                    "action": "Transfer To Operator"
               },
               {
                    "key": "1",
                    "description": "dial by extension",
                    "action": "Extension Dialing"
               },
               {
                    "key": "2",
                    "description": "dial by name",
                    "action": "Name Dialing"
               }
          ]
     }
}

Response JSON Object:

afterHours (object) – see afterHoursMenu from IVR Instance Menu attributes.
businessHours (object) – see businessHoursMenu from IVR Instance Menu attributes.
holiday (object) – see holidayMenu from IVR Instance Menu attributes.

Status Codes:

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

Display group IVR instance’s menu¶

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

Retrieve the settings of the specified IVR instance’s menu. Valid menu strings are “businessHours”, “afterHours” or “holiday”

Example request:

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

Example response:

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

{
    "enableFirstMenuLevelExtensionDialing": false,
    "announcementSelection": "Default",
    "keys": [
         {
              "key": "0"
              "action": "Repeat Menu",
              "submenuId": "",
              "phoneNumber": "",
              "description": "repeat menu",
         },
         {
              "key": "2"
              "action": "Name Dialing",
              "submenuId": "",
              "phoneNumber": "",
              "description": "dial by name",
         }
    ]
}

Response JSON Object:

afterHours (object) – see afterHoursMenu from IVR Instance Menu attributes.
businessHours (object) – see businessHoursMenu from IVR Instance Menu attributes.
holiday (object) – see holidayMenu from IVR Instance Menu attributes.

Status Codes:

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

Update a group IVR instance’s menu¶

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

Update the settings of the specified IVR instance’s menu. Valid menu strings are “businessHours”, “afterHours” or “holiday”

Example request:

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

{
    "keys": [
         {
              "key": "4",
              "action": "Exit",
              "description": "exit",
         },
         {
              "key": "3",
              "action": null,
              "description": "",
         }
    ]
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

afterHours (object) – see afterHoursMenu from IVR Instance Menu attributes.
businessHours (object) – see businessHoursMenu from IVR Instance Menu attributes.
holiday (object) – see holidayMenu from 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