Introduction
The Query API alway returns information as a JSON payload, of one of two forms. When the data returned can only be a single object, then exactly that JSON object is returned.
When the data contains multiple objects, then the return is a header
{
"totalCount": <number>,
"totalPages": <number>,
"pageNumber": <number>,
"pageSize": <number>,
"limitReached": <boolean>,
"content": [
{ ... },
...
]
}
The common header section was discussed in The Tech Insights Monitoring Query API - Information Queries - this document contains details of the content array or JSON object for each REST query type
| Get Calls |
Array of:
{
"day": "YYYY-MM-DD",
"source": "<source caller>",
"target": "<call target>",
"time": "YYYY-MM-DDTHH:mm:ssZ",
"bitrate": <number>,
"presentation": "<id">,
"protocol": "<protocol name>",
"quality": "<GOOD|FAIR|BAD|UNKNOWN>",
"duration": <number of seconds,
"org_id": <organisation id>,
"call_id": "<string>",
"start_time": "YYYY-MM-DDTHH:mm:ssZ"
"end_time": "YYYY-MM-DDTHH:mm:ssZ",
"data_source": "<data source>",
"system_id": <number>,
"system_name": "<string>",
"media_routed": <boolean>,
"quality_details_updated": <null | YYYY-MM-DDTHH:mm:ss>,
"call_records_updated": "YYYY-MM-DDTHH:mm:ssZ",
"endpoint_id": <number | null>,
"endpoint_name": <string | null>
"meeting_start_time":<null | YYYY-MM-DDTHH:mm:ss>,
"meeting_id": <null | string>,
"meeting_name": <null | string>,
"trunk_id": < null | trunk_id>,
"trunk_name": <null | string>
},
...
|
| Get Call Details |
Instance of: |
| Get Call Quality Details | An Array of arrays containing timestamp/value pairs representing data specified in the categories and metrics |
| Get Call Records |
Return the call data record information for this call,, or a 404 if not found. A typical set of call records for a CUCM handled call will have a CDR (Call Data Record) and two CMR (Call Management Records). [ |
| Get Endpoints |
Any array of endpoints [
{
"time": "2020-03-19T16:28:51.227Z",
"name": "Fred's Room",
"manufacturer": null,
"model": "Cisco Webex Room Kit",
"status": "None",
"camera": "UNKNOWN",
"display": "UNKNOWN",
"microphone": "UNKNOWN",
"tags": "LastSupport20191231,null,test",
"firmware": "ce9.12.0.299bdb9cfab",
"deleted": false,
"org_id": 1,
"endpoint_id": 234567,
"direct_number": null,
"host_address": "10.200.30.102",
"sip_address": "fred@myco.com.ciscospark.com",
"touch_panel": "UNKNOWN",
"epm_status": "NoMessages",
"epm_reason": null,
"peripherals": [
"camera-1",
"display-1",
"mic-1",
"mic-2",
"mic-3"
]
},
{
"time": "2020-03-19T16:33:52.766Z",
"name": "Eric's Room",
"manufacturer": null,
"model": "Cisco Webex Board 55",
"status": "Available",
"camera": "Connected=1 | Not Connected=none",
"display": "Connected=1 | Not Connected=none",
"microphone": "Muted=false | Connected=none | Not Connected=none",
"tags": null,
"firmware": "ce9.12.1.c97d0c44939",
"deleted": false,
"org_id": 1,
"endpoint_id": 123456,
"direct_number": null,
"host_address": "10.100.40.189",
"sip_address": "eric@myco.com.ciscospark.com",
"touch_panel": "Connected=none | Not Connected=none",
"epm_status": "OK",
"epm_reason": null,
"peripherals": [
"camera-1",
"display-1"
]
},
|
|
Get Endpoint Details |
Exactly one endpoint object, as above |
| Delete a Peripheral from an Endpoint | Remove a specified peripheral from an endpoint where peripheral is taken from the endpoint details. A 200 is returned on success |
| Get Systems |
Returns an array of infrastructure objects [
|
| Get Trunks |
Returns an array of trunk objects [ |
| Get Meetings |
An array list of meeting objects for meetings between windowStart and windowEnd [ |
| Get Meeting Participants |
An array of participant objects [ |
Comments
Please sign in to leave a comment.