Vodia PBX API

Conference Rooms

GET Conference Room's settings

GET

1) Info of the entire list of conference rooms

rest/domain/domain_name/conferences

Parameters

Field Type Description
domain_name String Name of the existing domain.

Success (200 OK)

Example Request:

curl -u admin:password GET -D - http://192.168.1.194/rest/domain/localhost/conferences
[ { name: "800", display: "conf", type: "scheduled", calls: 0 }, { name: "conf", display: "", type: "", calls: 0 } ]

2) Info of a SINGLE conference room

rest/domain/domain_name/user_settings/conference_room_id

Parameters

Field Type Description
domain_name String Name of the existing domain.
attendant_number Int Unique ID number generated

Success (200 OK)

Example:

Request:

curl -u admin:password -D - https://192.168.1.194/rest/domain/localhost/user_settings/conf
{ conflangs: "", intro: "", language: "", length: "", limit: "", mod_enter: "", mod_exit: "", moh: "", name: "", numbers: "", type: "", acdani: "", ani: "", 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: "", view_settings: "", visible: "", alias: [ "conf" ] }
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.

CREATE conference room(s)

post
/rest/domain/domain_name/addacc

Example:

Request:

curl -u admin:password -D - http://192.168.1.194/rest/domain/localhost/addacc -X POST -d "{ 'type':'conferences', 'account':'Conf_Name' }"

Response:

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.

UPDATE conference room(s)

post
/rest/domain/domain_name/user_settings/conference_id

Parameters

Field Type Description
domain_name String Name of the existing domain.
conference_id Int / String Unique ID (number or string) of the conference room

Example:

Request:

curl -u admin:password -D - http://192.168.1.194/rest/domain/localhost/user_settings/conf -X POST -d "{ 'conflangs':'en fr ru', 'intro':'tone', 'language':'', 'length':'4', 'limit':'', 'mod_enter':'no_mod', 'mod_exit':'no_change', 'moh':'', 'name':'hhh', 'numbers':'', 'type':'call', 'ani':'8888888', 'dial_plan':'5', 'dialog_subscribe':'', 'alias':['ert'] }"

Response:

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.

DELETE conference room(s)

Example:

The conference room's account number in the API call below can be obtained using the GET for an entire conference room'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 admin:password -D - http://127.0.0.1:8080/rest/domain/localhost/domain_action -X POST -d "{ 'type':'accounts', 'action':'delete_selected', 'selected':'334 conf' }"

2) Delete, single account at a time.

post
/rest/domain/domain_name/addacc/conference_id

Parameters used

Field Type Description
domain_name String Name of the existing domain.
conference_id Int / String Unique ID (String or number) of the conference room to be deleted.

Request:

curl -u admin:password -D - http://127.0.0.1:8080/rest/domain/localhost/addacc/ert -X DELETE

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

If multiple conference room accounts are to be deleted, then the API has to be run multiple timeswith corresponding conference room IDs.

Response:

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.