Vodia PBX API (version 58.0 and above)

Calling Card

GET CDR count

GET

Entire list of the CDR Counts

rest/domain/domain_name/cdr/count

Parameters

Field Type Description
domain_name String Name of the existing domain.

Success (200 OK)

Example:

Request:

curl -u username:password -D - http://<PBX_IP/NAME:PORT>/rest/domain/<domain_IP OR Name>/cdr/count -X GET

List of the CDR Records

rest/domain/domain_name/cdr/range of the length

Parameters

Field Type Description
domain_name String Name of the existing domain.
range_of_the_length Int / String Range of the length of the CDR records you want populated

Success (200 OK)

Example:

Request:

curl -u username:password -D - http://<PBX_IP/NAME:PORT>/rest/domain/<domain_IP OR Name>/cdr/50-52 -X GET
[ {'id':3768, 'call_id':'313530353135393930313236313734-gebz6bpahoh2', 'domain':1, 'from':'\'Tom Crosby\' <sip:444@192.168.1.194>', 'to':'\'Paging\' <sip:801@192.168.1.194>', 'start':'1505159903.299', 'connect':'1505159903.316', 'end':'1505159913.119', 'extensions':[47], 'trunks':[]}, {'id':3767, 'call_id':'a526be02@pbx', 'domain':1, 'from':'\'TELEGO\' <sip:+12124771000@192.168.1.194>', 'to':'<sip:+16173998147@192.168.1.194>', 'start':'1505159605.69', 'connect':'', 'end':'1505159607.842', 'extensions':[], 'trunks':[2] }]
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.

GET Recording Count

GET

Entire list of the Recording Count

rest/domain/domain_name/recs/recs

Parameters

Field Type Description
domain_name String Name of the existing domain.

Success (200 OK)

Example:

Request:

curl -u username:password -D - http://<PBX_IP/NAME:PORT>/rest/domain/<domain_IP/NAME>/recs/recs -X GET

GET Recording Count

GET

Entire list of the Recording Count

rest/domain/domain_name/recs/recs

Parameters

Field Type Description
domain_name String Name of the existing domain.

Success (200 OK)

Example:

Request:

curl -u username:password -D - http://<PBX_IP/NAME:PORT>/rest/domain/<domain_IP/NAME>/recs/recs -X GET

GET Recording List

GET

Entire list of the Recording List

rest/domain/domain_name/recs?size=Listing_size_selected_on_page>&page=page_number

Parameters

Field Type Description
domain_name String Name of the existing domain.
Listing_size_selected_on_page Int / String 25, 50 etc..
page_number Int / String Number of the page seeking details of.

Success (200 OK)

Example:

Request:

curl -u admin: -D - http://192.168.1.194:8080/rest/domain/192.168.1.194/recs?size=50&page=5 -X GET
[{'file':243, 'from':'\'James Brolin\' <sip:440@192.168.1.194>', 'to':'\'Tom Crosby\' <sip:444@192.168.1.194>', 'agent':'440','group':'440', 'status':'', 'time':'1505331406.503'}, {'file':242, 'from':'\'James Brolin\' <sip:440@192.168.1.194>', 'to':'\'Tom Crosby\' <sip:444@192.168.1.194>', 'agent':'444', 'group':'444', 'status':'', 'time':'1505331406.534'}, {'file':241, 'from':'\'James Brolin\' <sip:440@192.168.1.194>', 'to':'\'Tom Crosby\' <sip:444@192.168.1.194>', 'agent':'444', 'group':'444', 'status':'', 'time':'1505312378.794'}, {'file':240,'from':'\'James Brolin\' <sip:440@192.168.1.194>', 'to':'\'Tom Crosby\' <sip:444@192.168.1.194>', 'agent':'440', 'group':'440', 'status':'', 'time':'1505312378.779'}, {'file':239,'from':'\'Jon Favreau\' <sip:442@192.168.1.194>', 'to':'\'James Brolin\' <sip:440@192.168.1.194>', 'agent':'440', 'group':'440', 'status':'', 'time':'1505309466.684'}]