GET Paging Group's settings
GET
1) (Info of the entire list of the Paging Groups)
rest/domain/domain_name/paging
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
Success (200 OK)
Example:
Request:
curl -u username:password GET -D - http://192.168.1.194:8080/rest/domain/localhost/paging
[ { name: "wer", display: "wertt", mode: "" }, { name: "801", display: "Paging", mode: "" } ]
2) (Info of a SINGLE paging group account)
rest/domain/domain_name/user_settings/paging_group_id
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
paging_group_id | Int / String | Unique ID (name or number) of the Paging Group account |
Success (200 OK)
Example:
Request:
curl -u username:password -D - https://192.168.1.194:8080/rest/domain/localhost/user_settings/801
{ announce: "", codec: "", display: "Paging", ext: "", ip: "", mode: "", perm: "", playback: "", record: "", wavfile: "", 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: [ "801" ] }
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 Paging Groups(s)
post
/rest/domain/domain_name/addacc
Example:
Request:
curl -u username:password -D - http://192.168.1.194:8080/rest/domain/localhost/addacc -X POST -d "{ 'type':'hoots', 'account':'909' }"
UPDATE calling card(s)
post
/rest/domain/domain_name/user_settings/paging_group_id
Parameters
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
paging_group_id | Int / String | Unique ID (number or string) of the Paging group account |
Example:
Request:
curl -u username:password -D - http://192.168.1.194:8080/rest/domain/localhost/user_settings/909 -X POST -d "{ 'codec':'0', 'display':'Paging New', 'ext':'444 445', 'mode':'unicast', 'record':'true', 'max_call_duration':'10', 'playback':'true', 'alias':['909'] }"
DELETE Paging Group(s)
Example:
The Paging Groups'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/paging_group_id
Parameters used
Field | Type | Description |
---|---|---|
domain_name | String | Name of the existing domain. |
paging_group_id | Int / String | Unique ID (String or number) of the Paging Group account to be deleted. |
Request:
curl -u username:password -D - http://127.0.0.1:8080/rest/domain/localhost/addacc/912 -X DELETE
No extra parameters are needed to be specified, to delete a single paging group account.
If multiple paging group accounts are to be deleted, then the API has to be run multiple times with corresponding paging group 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. |