telecoms.ivr.list function

List your IVR menus. This just returns the data in the main IVR records; it will not return details specific to the options for that menu (to do that, use the telcoms.ivr.get function).

Arguments:

arg	required?	syntax	info
`custID`	N	posint	custID of account that contains the IVR menus you want to list (default is your own account)
`ivrID`	N	list:posint	optional filter; if supplied, limits results to IVR menus matching these IDs
`desc.starts`	N	string	optional filter; if supplied, limits results to IVR menus whose description starts with this string
`opt`	N	set:get_in_use	optional settings for additional return data
`countinfo`	N	set:totmaches\|more_rows	determines how this function returns information about the total number of IVR menus on account
`offset`	N	unsint	for pagination; first matching IVR to return, counting from zero
`limit`	N	unsint	for pagination; max number of records to return (subject to built in limit of 500)

arg

required?

syntax

info

custID

posint

custID of account that contains the IVR menus you want to list (default is your own account)

ivrID

list:posint

optional filter; if supplied, limits results to IVR menus matching these IDs

desc.starts

string

optional filter; if supplied, limits results to IVR menus whose description starts with this string

opt

set:get_in_use

optional settings for additional return data

countinfo

set:totmaches|more_rows

determines how this function returns information about the total number of IVR menus on account

offset

unsint

for pagination; first matching IVR to return, counting from zero

limit

unsint

for pagination; max number of records to return (subject to built in limit of 500)

Further argument information

opt

This argument contains a list (comma separated list or array) of values. Possible values are:

get_in_use - if specified, each result record contains an in_use element that has a value of 0 or 1 to indicate whether the IVR menu is in use. In this context, "in use" means that it is being referenced by another object, whether that be another IVR menu, a route plan or a number that might be pointing to it. You cannot delete an IVR if another object is referencing it. If you supply this option the system has to perform extra database lookups in order to determine whether anything else is referencing this IVR menu, so it is not provided by default (nor should you always request this data unless your application requires it).

countinfo

This argument contains a list (comma separated list or array) of values. This is to include useful pagination data in the result set. Possible values are:

more_rows - causes the result set to include a "more_rows" element that indicates whether more records would be returned if you increased the value of offset (or limit provided that you are not already using the built-in limit). The value of this element will be 0 or 1.
totmatches - causes the result set to include a "totmatches" element that indicates the total number of matching IVR menus on the sytem, regardless of the settings of offset or limit. This is far less efficient than the more_rows option and therefore is not the default setting.

Example 1

The response

{ "results" : { "more_rows" : "0", "data" : [ { "timeout_response" : "10", "timeout_digit" : "3", "desc" : "ACME Ltd main menu", "nochoice_maxreplays" : "3", "default_choice" : "9", "ivrID" : "2", "badchoice_fg_soundclipID" : "2", "custID" : "16526", "prompt_bg_soundclipID" : "1", "created" : "2010-10-29 15:59:44" }, { "ivrID" : "3", "desc" : "ACME Ltd main menu", "nochoice_maxreplays" : "3", "timeout_digit" : "3", "timeout_response" : "10", "created" : "2010-10-29 16:16:56", "prompt_bg_soundclipID" : "1", "custID" : "16526", "badchoice_fg_soundclipID" : "2" } ] }, "success" : "1" }

Example 2

Fetch a list of IVR menus, specifying the get_in_use option so that you can see which ones are being used:

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

{ "results" : { "data" : [ { "timeout_digit" : "3", "nochoice_maxreplays" : "3", "in_use" : "0", "created" : "2010-10-29 15:59:44", "default_choice" : "9", "prompt_bg_soundclipID" : "1", "desc" : "ACME Ltd main menu", "ivrID" : "2", "timeout_response" : "10", "badchoice_fg_soundclipID" : "2", "custID" : "16526" }, { "custID" : "16526", "badchoice_fg_soundclipID" : "2", "timeout_response" : "10", "ivrID" : "3", "desc" : "ACME Ltd main menu", "prompt_bg_soundclipID" : "1", "created" : "2010-10-29 16:16:56", "in_use" : "1", "nochoice_maxreplays" : "3", "timeout_digit" : "3" } ], "more_rows" : "0" }, "success" : "1" }