IVR

A menu that plays to the caller and sends them on by the key they press.

app.onsim.uk/team/ivrs/500

Main menulabel

500extension

Fields

Field	Type	What it is	On app.onsim
id	integer	The ID of the IVR. It does not change when the extension does.	Not shown.
extension	string	What others dial to reach it. It can change.	The line under the name. It is also in the address of the page.
label	string	The label of the extension, as app.onsim and the call records show it. It is not the name of a person.	The name beside the mark.
menusoptional	list of IvrMenu	The menus of the IVR. An IVR that plays no menu has none.	Not shown.

A menu

Every IVR has a menu with the name ROOT, which a caller hears first. It can have more, each with a name of your own. A caller gets to one of those through a step with the action menu.

Field	Type	What it is
name	string	The name of the menu. Every IVR has a menu with the name ROOT, which a caller hears first. A step with the action menu goes to another.
activeoptional	string	When the menu is active, in words: Always, or a schedule.
keys	list of IvrKey	The steps of the menu.

A step of a menu

A step says what the menu does when the caller presses a key. Three steps have no key: timeout, when the caller presses none; inactive, when the menu is not active; and fax.

Field	Type	What it is
key	string	What starts the step: a key from 0 to 9, * or #. Also timeout when the caller presses no key, inactive when the menu is not active, and fax.
action	string	What the menu does: transfer, menu, queue, voicemail, directory, dial_extension, make_call, hang_up, none or other. More values can come.
extensionoptional	string	For transfer to an extension: the extension that the menu dials.
numberoptional	string	For transfer to an outside number: the digits of that number.
menuoptional	string	For menu: the name of the menu that comes next.

A transfer goes to an extension or to an outside number. An extension is that of a User, a Hunt Group or another IVR. Each of those has the same extension field.

Example

{
  "id": 1070,
  "extension": "500",
  "label": "Main menu",
  "menus": [
    {
      "name": "ROOT",
      "active": "From 09:00 Till 17:00, on Monday-Friday",
      "keys": [
        {
          "key": "1",
          "action": "transfer",
          "extension": "300"
        },
        {
          "key": "2",
          "action": "menu",
          "menu": "BILLING"
        },
        {
          "key": "timeout",
          "action": "transfer",
          "extension": "201"
        },
        {
          "key": "inactive",
          "action": "voicemail"
        }
      ]
    },
    {
      "name": "BILLING",
      "active": "Always",
      "keys": [
        {
          "key": "1",
          "action": "transfer",
          "extension": "203"
        },
        {
          "key": "timeout",
          "action": "hang_up"
        }
      ]
    }
  ]
}

Methods

The list gives each one with id, extension and label only. The get gives every field.

List IVRsGET /v1/ivrs

Get an IVRGET /v1/ivrs/{id}