Vodia PBX API (version 58.0 and above)

IVR Nodes

GET IVR Node's settings

GET

1) Info of the entire list of the IVR Nodes

rest/domain/domain_name/ivrnodes

Parameters

Field Type Description
domain_name String Name of the existing domain.

Success (200 OK)

Example Request:

curl -u username:password GET -D - https://127.0.0.1/rest/domain/vodia/ivrnodes
[ { name: "2020", display: "IVRs" }, { name: "2021", display: "IVR 2" } ]

2) Info of a SINGLE IVR Node's account

rest/domain/domain_name/user_settings/ivr_node_number

Parameters

Field Type Description
domain_name String Name of the existing domain.
ivr_node_number Int / String Unique ID (name or number) of the IVR Node account

Success (200 OK)

Example Request:

curl -u username:password -D - https://127.0.0.1/rest/domain/vodia/user_settings/2020
{ acturl_regex: "", acturl_settings: "", admin: "", display: "IVRs", language: "en", match: "!*!2021!", match_from: "", match_to: "", mute: "", soap_uri: "", timeout: "", wavfile: "recordings/ivr24.wav", acdani: "", acturl_call: "", acturl_cleardnd: "", acturl_clearwakeup: "", acturl_connect: "", acturl_dnd: "", acturl_emergency: "", acturl_mailbox: "", acturl_missedwakeup: "", acturl_newcall: "", acturl_roomcleaned: "", acturl_wakeupcall: "", ani: "", anonymous_spam_score: "", cdr_time: "", credit: "", dial_plan: "", dialog_state: "", dialog_subscribe: "", dialog_version: "", disabled: "", email_cdr: "", epid: "", location: "", max_call_duration: "", max_cdrs: "", need_license: "", param1: "", param2: "", param3: "", rb: "", rf: "", spam_threshold: "", view_settings: "", visible: "", alias: [ "2020" ] }
Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.

CREATE IVR Node(s)

post
/rest/domain/domain_name/addacc

Example Request:

curl -u username:password -D - https://127.0.0.1/rest/domain/vodia/addacc -X POST -d "{ 'type':'ivrnodes', 'account':'2022' }"

UPDATE IVR Node(s)

post
/rest/domain/domain_name/user_settings/ivr_node_number

Parameters

Field Type Description
domain_name String Name of the existing domain.
ivr_node_number Int / String Unique ID (number or string) of the IVR Node account

Example Request:

curl -u username:password -D - https://127.0.0.1/rest/domain/vodia/user_settings/2022 -X POST -d "{ 'admin': '444 446', 'display': 'IVRNode", 'language': 'ru', 'wavfile': 'recordings/ivr631.wav' }"

DELETE IVR node(s)

Example:

The IVR node's account id in the API call can be obtained using the GET for the entire Paging group account's list

There are 2 ways of deleting an entry.

1) Delete, multiple accounts (extension, auto-attendant, agent-groups etc. together) at once.

post
/rest/domain/domain_name/domain_action

Example Request:

curl -u username:password -D - http://127.0.0.1:8080/rest/domain/localhost/domain_action -X POST -d "{ 'type':'accounts', 'action':'delete_selected', 'selected':'909 910' }"

2) Delete, single account at a time.

post
/rest/domain/domain_name/addacc/ivr_node_number

Parameters used

Field Type Description
domain_name String Name of the existing domain.
ivr_node_number Int / String Unique ID (String or number) of the IVR Node's account to be deleted.

Example Request:

curl -u username:password -D - https://127.0.0.1/rest/domain/vodia/addacc/2022 -X DELETE

No extra parameters are needed to be specified, to delete a single IVR node account.

If multiple IVR node accounts are to be deleted, then the API has to be run multiple times with corresponding IVR node account IDs.

Response for all Create, Update or Delete requests:

Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated a Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.