Home > telephony > nts > function-reference > func.telecoms.ivr.get
function telecoms.ivr.get

Fetch the detail of a specific IVR menu.

Arguments:

argrequired?syntaxinfo
custIDNposintcustID of account that contains the IVR menu you want to fetch (default is your own account)
ivrIDYposintivrID of IVR menu you want to fetch

Example

Fetch the details for IVR menu with an ivrID of 3.

JSON example request:

POST https://live.apicontrol.co.uk/1/json
{
    "auth" : {
        "username" : "YOURUSERNAME",
        "password" : "YOURPASSWORD",
    },
    "func" : "telecoms.ivr.get",
    "args" : {
       "ivrID" : 3
    }
}

The response

JSON example response:

{
   "results" : {
      "ivrID" : "3",
      "timeout_digit" : "3",
      "prompt_bg_soundclipID" : "1",
      "nochoice_maxreplays" : "3",
      "custID" : "16526",
      "options" : [
         {
            "keypress" : "2",
            "destnumber" : "01234567890",
            "routeto_type" : "number"
         },
         {
            "keypress" : "100",
            "destargs" : {
               "host" : "davesip.example.com",
               "ext" : "dave100",
               "port" : "59001"
            },
            "routeto_type" : "sip"
         }
      ],
      "desc" : "ACME Ltd main menu",
      "badchoice_fg_soundclipID" : "2",
      "timeout_response" : "10",
      "created" : "2010-10-29 16:16:56"
   },
   "success" : "1"
}