{
   "requestParameters": {
         "username": "<replace with your string>",
         "password": "<replace with your string>" 
          },
         "authenticationProviders": ["<replace with your string>", 
         "<replace with your string>",...]                      
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0.

Modified in API Version 1.5 (See Notes below.)

When an API user's password changes in Unified Communications Manager, it may take several minutes for that change to be reflected in MediaSense. A successful response also returns a JSESSIONID inside a cookie.

This JSESSIONID is a session identifier and serves as a means of authentication for the subsequent requests.

The following change was introduced in Release 10.0, Version 1.5:

• Introduced a new request parameter (see API Parameters)

  • authenticationProviders

Example 1

To signIn a user with username " myUser " and password " cisco " on the server 10.194.118.1 at port 8440 :

Since no authentication provider has been specified, this request will try to authenticate against all possible configured authentication providers including AXL & Finesse.

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signIn 

Headers:

Content-Type: application/json

Body:

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                      }
}

Example 2

To signIn a Finesse supervisor with username " myUser " and password " cisco " on the server 10.194.118.1 at port 8440:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signIn 

Headers:

Content-Type: application/json

Body:

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                        },
                      "authenticationProviders": ["FINESSE"]

}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
)

See API Response Codes.

To signOut a user who was previously signed in:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signOut

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

Content-Type: application/json

The user identified by the JSESSIONID is signed out.

If this subscription is for server-based clients, set the 
client's subscriptionType parameter to "http" (where it 
should receive events).
{
   "requestParameters": {
                            "subscriptionType" : "<replace with 
                             your string>",
                            "subscriptionUri" : "<replace with 
                             your string>",
                            "subscriptionFilters": ["<replace with 
                             your string>", "<replace with your 
                             string>",...],
                            "tagNameRegEx": "<java-regular-
                             expression>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody" : {
                       "subscriptionId": "<This is a String>",
                       "subscriptionFilters": ["<This is a 
                        String>", "<This is a String>",...],
                       "tagNameRegEx": "<java-regular-expression>"
                     }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: storageThresholdEvent

Event action: event action values

Available since API Version 1.1

Modified in API Version 1.2

See the following notes.

If the same subscriptionUri is subscribed for a second time, the subscriptionFilters in the existing subscription will be replaced with the new subscriptionFilters. If the subscriptionFilters are also the same, then no error is generated. A 2005 responseCode is generated indicating that the subscription already exists.

The following changes were introduced in Release 8.5(3), Version 1.2

• New parameter introduced:
  • tagNameRegEx

Example 1:

To receive event notifications for all events:

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
subscribeToEvents

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionType": "http",
                        "subscriptionUri": "http://10.35.146.157:
                         8085/sessionEvent",
                        "subscriptionFilters": ["ALL_EVENTS"]
                      }
}

Response:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "EXIT_EMERGENCY_STORAGE_SPACE_EVENT",
            "TAG_ADDED_EVENT",
            "TAG_DELETED_EVENT",
            "TAG_UPDATED_EVENT",
            "SESSION_STARTED_EVENT",
            "SESSION_ENDED_EVENT",
            "EXIT_LOW_STORAGE_SPACE_EVENT",
            "EXIT_CRTITICAL_STORAGE_SPACE_EVENT",
            "ENTER_CRTITICAL_STORAGE_SPACE_EVENT",
            "ENTER_LOW_STORAGE_SPACE_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_DELETED_EVENT",
            "ENTER_EMERGENCY_STORAGE_SPACE_EVENT",
            "SESSION_PRUNED_EVENT"
        ],
        "subscriptionId": "3oV6jCEnJUlGYZo8"
    }
}

Example 2

To receive event notifications for onlyTAG_EVENTS :

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
subscribeToEvents

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionType": "http",
                        "subscriptionUri": "http://10.35.146.157:
                         8085/sessionEvent",
                        "subscriptionFilters": ["TAG_EVENTS"]
                      }
}

Response:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "TAG_ADDED_EVENT",
            "TAG_DELETED_EVENT",
            "TAG_UPDATED_EVENT"
        ],
        "subscriptionId": "D52C4aeXISTURzM7"
    }
}

{
   "requestParameters": {
                            "subscriptionId" : "<replace with 
                             your string>",
                            "subscriptionFilters": ["<replace with 
                             your string>", "<replace with your 
                             string>",...]
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"
 }

{
    "responseCode": 2006,
    "responseMessage": "Success: The current subscription has been 
                        updated and you have been unsubscribed 
                        from the subscriptionFilters requested.
                        The subscription is still active.",
    "responseBody": {
                       "subscriptionFilters": ["<This is a String>",
                       "<This is a String>",...]
                    },
    "tagNameRegEx": "<java-regular-expression>"
 }

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.1

Modified in API Version 1.2

See the following notes.

The following changes were introduced in Release 8.5(3), Version 1.2:

• New parameter introduced:

  • tagNameRegEx

Example 1

To stop receiving event notifications for any event (unsubscribe from all events):

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
unsubscribeFromEvents

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1",
                        "subscriptionFilters":[ALL_EVENTS]
                      }
}

OR

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1"
                      }
}

Response:

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

Example 2

The client is currently subscribed to RECORDING_EVENTS and CLEANUP_EVENTS and now wants to unsubscribe from CLEANUP_EVENTS, but continue to maintain their subscription to RECORDING_EVENTS.

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
unsubscribeFromEvents

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1",
                        "subscriptionFilters":[CLEANUP_EVENTS]
                      }
}

Response: (This will tell the client the filters they are still subscribed to.)

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "SESSION_STARTED_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_ENDED_EVENT"
        ]
    }
}

{
   "requestParameters": {
                            "subscriptionId": "<this is a string>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
                       "subscriptionStatus":"<this is a String>",
                       "subscriptionFilters": ["<this is a String>",
                       "<this is a String>",...],
                       "tagNameRegEx": "<java-regular-expression>"
                    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.1

Modified in API Version 1.2

See the following notes.

The subscriptionStatus will be ACTIVE or INACTIVE depending upon whether the subscription exists or not.

MediaSense does not store subscriptions in terms of event categories. Categories are always expanded into a corresponding list of eventTypes and stored as such. Therefore the list of Strings included in subscriptionFilters is always a list of eventTypes, and never contains any category names.

The following changes were introduced in Release 8.5(3), Version 1.2:

Example 1

Assuming that you are currently subscribed to receive all RECORDING_EVENTS, use the following API to verify that your subscription to is active:

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
verifyEventSubscription

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1"
                      }
}

Response:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "SESSION_STARTED_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_ENDED_EVENT"
        ],
        "subscriptionStatus": "ACTIVE"
    }
}

Example 2

Verify an INACTIVE subscription.

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
verifyEventSubscription

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI2"
                      }
}

Response:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionStatus": "INACTIVE"
    }
}

If this subscription is for server-based clients, set the 
client's subscriptionType parameter to "http" (where it 
should receive events).
{
   "requestParameters": {
                            "subscriptionType" : "<this is a 
                             string>",
                            "subscriptionUri" : "<this is a 
                             string>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "subscriptionId": "abcd1234",
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "subscriptionId": "<this is a string>"
}

See API Response Codes.

Event type: storageThresholdEvent

Event action: event action values

Deprecated in API Version 1.1, instead use subscribeToEvents.

{
   "requestParameters": {
                            "subscriptionId" : "<this is a string>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"

}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Deprecated in API Version 1.1 , instead use subscribeToEvents.

{
   "requestParameters": {
                            "subscriptionId": "<this is a string>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "subscriptionStatus":"ACTIVE"

}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Deprecated in API Version 1.1, instead use verifyEventSubscription.

{
    "requestParameters": {
        "jobId": "<replace with your string>"
    }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}

See API Response Codes.

This API cancels a job which is in progress. If the job is not in a RUNNING state, then it returns a failure error code along with the current job state.

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/cancelJob

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
 "requestParameters": {
 "jobId": "123456789"
 }
}

Response:

{
 "responseMessage": "Success: Your request was successfully completed.",
 "responseCode": 2000,
 "jobId": "123456789"
}

{
   "requestParameters": {
       "jobType": "<replace with your string>",
       "jobParameters": "<replace with your string>"
    }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}

See API Response Codes.

See Job States.

{
    "requestParameters": {
        "jobId": "<replace with your string>"
    }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}

See API Response Codes.

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/deleteJob

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
 "requestParameters": { "jobId": "JobId_1" }
 }

Response:

{ "responseMessage": "Success: Your request was successfully 
   completed.", "responseCode": 2000, "jobId": "JobId_1" }

{        "jobId": "<replace with your string>"    }

See API Parameters.

{
"responseCode": 2000
"responseMessage": "Successful"”
"responseBody":  {
   "jobs":[{
      "jobType":"<this is a string>",
      "jobDuration":<this is an integer>,
      "jobStartTime":<this is an integer>,
      "jobId":"<this is a string>",
      "jobState":"<this is a string>",
      "operationsCompleted":<this is an integer>,
      "operationsRemaining":<this is an integer>
           }]
  }
}

    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"}

See API Response Codes.

See Job States.

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/ 
getJobById?jobId=AMS_10.194.118.1_1282948026491_5

Headers:

JSESSIONID: <the jsessionId received from a previous signIn request>

Response:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 203567,
                "jobStartTime": 1343333766345,
                "jobId": "AMS_10.194.118.1_
                 1282948026491_5",
                "jobState": "COMPLETED"
            }
        ],
        "operationsCompleted": 2,
        "operationsRemaining": 0
    }
}

{
    "jobId": "<replace with your string>",
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with 
                     your string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with 
                     your string>"                }
            ],
            "paramConnector": "<replace with your 
             string>"        }
    ],
    "pageParameters": {
        "offset": <replace with your integer>,
        "limit": <replace with your integer>    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>", 
            "order": "<replace with your string>"        }
    ]
}

See API Parameters.

{
    "responseCode": <this is an integer>,
    "responseMessage": "<this is a string>",
    "responseBody": {
        "job": [
            {
                "jobType":"<this is a string>",
                "jobDuration":<this is an integer>,
                "jobStartTime": "<this is a string>",
                "jobId": "<this is a string>",
                "jobState": "<this is a string>"
            }
        ] ,
        "jobOperationsResultset": [
            {
                "responseCode": <this is an integer>,
                "operationData": "<this is a string>",
                "operationId": "<this is a string>",
                "operationResponse": "<this is a 
                 string>"            },
           {
              ..              ..
            },
            ..
        ]
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}

See API Response Codes.

See Job States.

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobResult

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{
    "jobId": "AMS_10.27.185.20_1287093966514_162",
    "requestParameters": [
        {
            "fieldName" : "operationResult",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "2000"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "operationResult",
            "order": "ASC"
        }
    ]
}

Response:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "job": {
            "jobType": "BULK_DELETE_SESSIONS",
            "jobDuration": 36005,
            "jobId": "AMS_10.27.185.20_1287093966514_
             162",
            "jobStartTime": 1287171904409,
            "jobState": "COMPLETED"
        },
        "jobOperationsResultset": [
             {
                "responseCode": 2000,
                "operationData": "Session-1-10.194.118.
                 92-1287017042781",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_163",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            },

            {
                "responseCode": 2000,
                "operationData": "Session-11-10.194.118.
                 92-1287178816956",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_164",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            }
        ]
    }
}

equals

contains

startsWith

endsWith

operationId

operationData

operationResponse

{
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with 
                     your string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with 
                     your string>"
                }
            ],
            "paramConnector": "<replace with your 
             string>"
        }
    ],
    "pageParameters": {
        "offset": <replace with your integer>,
        "limit": <replace with your integer>"    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>",
            "order": "<replace with your string>"
        }
    ]
}
}

See API Parameters.

{
"responseCode": 2000
"responseMessage": "Successful"”
"responseBody":  {
   "jobs":[{
      "jobType":"<this is a string>",
      "jobDuration":<this is an integer>,
      "jobStartTime":<this is an integer>,
      "jobId":"<this is a string>",
      "jobState":"<this is a string>"
     }]
  }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}

See API Response Codes.

See Job States.

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobs

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a 
signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "jobState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "completed"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "jobId",
            "order": "ASC"
        }
    ]
}

Response:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 34200,
                "jobStartTime": 1343334076111,
                "jobId": "Job_123",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 44200,
                "jobStartTime":1343334075432,
                "jobId": "Job_234",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 43678,
                "jobStartTime": 1343334073567,
                "jobId": "Job_345",
                "jobState": "COMPLETED"
            }
        ]
    }
}

between

lessThan

greaterThan

between

lessThan

greaterThan

jobId

jobState

jobType

jobStartTime

jobDuration

{
   "requestParameters": {
                        "sessionId": "<replace with 
                         your string>"
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: tagEvent

Event action: added

To pause a recording that is currently in progress:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
pauseRecording

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{
   requestParameters: {
                        "sessionId": "Session-1234.abc.
                         5678"
                      }
}

Response:

 {
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
   "requestParameters": {
                        "sessionId": "<replace with 
                          your string>"
                      }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: tagEvent

Event action: added

HTTPS POST:

 https://10.194.118.1:8440/ora/controlService/control/
resumeRecording

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{
   requestParameters: {
                        "sessionId": "Session-1234.abc.
                         5678"
                      }
}

Response:

{
    "responseCode": 2000,
    "responseMessage": "Successful"
}

{
   "requestParameters": {
                        "deviceRef": "<replace with 
                         your string>",
                        "mediaStreams": 
                            [{
                            "mediaType":
                            "<replace with your string>"
                                        }]
                         }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessionId": "<this is a string>",
        "callControllerIP": "<this is a string>",
        "callControllerType": "<this is a string>",
        "CCID": "<this is a string>",
        "sessionStartDate": "<this is an integer>",
        "sessionDuration": "<this is an integer>",
        "sessionState": "<this is a string>",
        "tags": [
            {
                "tagName": "<this is a string>",
                "tagType": "<this is a string>",
                "tagCreateDate": "<this is an integer>",
                "tagOffset": "<this is an integer>"
            }
        ],
        "tracks": [
            {
                "trackNumber": "<this is an integer>",
                "trackStartDate": "<this is an integer>",
                "trackDuration": "<this is an integer>",
                "trackMediaType": "<this is a string>",
                "downloadUrl": "<this is a string>",
                "codec": "<this is a string>",
                "participants": [
                    {
                        "deviceRef": "<this is a string>",
                        "participantStartDate": "<this 
                         is an integer>",
                        "participantDuration": "<this 
                         is an integer>",
                        "isConference": "<this is a 
                         boolean>",
                        "deviceId": "<this is a string>"
                    }
                ]
            }
        ],
        "urls": {
            "httpUrl": "<this is a string>",
            "rtspUrl": "<this is a string>",
            "mp4Url": "<this is a string>",
            "wavUrl": "<this is a string>"

        }
    }
}

{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

Event type: sessionEvent

Event action: started

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

This API requires that you configure a Call Control Service Provider in Cisco MediaSense Administration, and that the target phone be accessible by that Unified Communications Manager.

Example 1

To start a blog recording that contains both audio and video tracks on a device with deviceRef 1000:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
startRecording 

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{
    "requestParameters": {
        "deviceRef": "1000",
        "mediaStreams": [
            {
                "mediaType": "VIDEO"
            },
            {
                "mediaType": "AUDIO"
            }
        ]
    }
}

Example 2

To start a blog recording that contains only an audio track on a device with deviceRef 1111:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
startRecording 

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{
    "requestParameters": {
        "deviceRef": "1111",
        "mediaStreams": [
            {
                "mediaType": "AUDIO"
            }
        ]
    }
}

{	"requestParameters":
			{
        "deviceRef": "<replace with your string>"
			 }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessionId": "<this is a string>",
        "callControllerIP": "<this is a string>",
        "callControllerType": "<this is a string>",
        "CCID": "<this is a string>",
        "sessionStartDate": "<this is an integer>",
        "sessionDuration": "<this is an integer>",
        "sessionState": "<this is a string>",
        "tags": [
            {
                "tagName": "<this is a string>",
                "tagType": "<this is a string>",
                "tagCreateDate": "<this is an integer>",
                "tagOffset": "<this is an integer>"
            }
        ],
        "tracks": [
            {
                "trackNumber": "<this is an integer>",
                "trackStartDate": "<this is an integer>",
                "trackDuration": "<this is an integer>",
                "trackMediaType": "<this is a string>",
                "downloadUrl": "<this is a string>",
                "codec": "<this is a string>",
                "participants": [
                    {
                        "deviceRef": "<this is a string>",
                        "participantStartDate": "<this 
                         is an integer>",
                        "participantDuration": "<this 
                         is an integer>",
                        "isConference": "<this is a 
                         boolean>",
                        "deviceId": "<this is a string>"

                    }
                ]
            }
        ],
        "urls": {
            "httpUrl": "<this is a string>",
            "rtspUrl": "<this is a string>">",
            "mp4Url": "<this is a string>">",
            "wavUrl": "<this is a string>"

        }
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: sessionEvent

Event action: ended

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

• The following changes were introduced in Release 10.0, Version 1.5:
  • Deprecated httpUrl in favor of mp4Url.
  • Introduced two new parameters in the Urls (for more information, see the Parameter Description table):
    • mp4url
    • wavurl
• The following changes were introduced in Release 9.0(1), Version 1.4:
  • Introduced a new parameter in the Track (for more information, see the Parameter Description table):
    • codec
• The following parameters were introduced in Release 8.5(3), Version 1.2:
  • callControllerIP
  • callControllerType
  • ccid

To stop a blog recording in progress on a device with deviceRef 1000:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
stopRecording

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn 
request>

Body:

{	"requestParameters":
			{
                            "deviceRef": "1000"
			 }
}

Description:

Use this API to launch the MediaSense Media Player and play the specified recording. The API is designed to work with a server-based application that is acting as a proxy for a browser, but it can also be called directly by a browser. When an application issues this request on behalf of a browser client, it passes the JNLP file to that browser for execution. The browser then interacts with MediaSense directly to download the player application and to fetch the media stream to be played.

API URI:

https://<host>:<port>/ora/controlService/control/launchMediaPlayer

Supported response formats:

For a successful response: application/x-java-jnlp-file

In case of an error : application/json

HTTP method:

GET

Request parameters:

This parameter must be specified in the query section of the URL:

rtspUrl=<user provided string>

Where rtspUrl is the rtsp URL of the session that is to be played in the Media Player when it launches. This URL is obtained with the Query APIs (such as getSessions). The client fetches this rtspUrl from MediaSense shortly before using it in the launchMediaPlayer request. As with all URLs provided by MediaSense, the rtspUrl for a given recorded session is subject to change from time to time without notice.

Header parameters:

See API Parameters.

Successful JSON response schema:

A JNLP file that launches the Media Player applet.

Failure JSON response schema:

{
  "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

None

Available since API Version 1.5.

You must have the required version of Java installed on the client machine. See the Search & Play section of the MediaSense User Guide for more details on Java requirements.

Example 1

To play the session with the rtspUrl "13092154564622" in the Media Player:

HTTPS GET:https://<server>:<port>/ora/controlService/control/

launchMediaPlayer?rtspUrl=rtsp://<server>/archive/2413e6746c8441

Headers: JSESSIONID (the jsessionID received from a previous signIn request)

Response:

...
Content-type: application/x-java-jnlp-file
...

<?xml version="1.0" encoding="UTF-8"?>
<jnlp codebase="https://<server>:<port>/mediasense/
 " spec="1.0+">
   <information>
      <title>MediaSensePlayer</title>
      <vendor>Cisco Systems</vendor>
      <homepage href="http://www.cisco.com" />
      <description>MediaSensePlayer</description>
      <description kind="short">MediaSensePlayer</description>
   </information>
   <update check="always" />
   <security>
      <all-permissions />
   </security>
   <resources>
      <j2se version="1.7.0_11" />
      <jar href="java/MediaSensePlayer.jar" main="true" />
      <jar href="java/jna-3.4.0.jar" />
   </resources>
   <application-desc main-class="com.cisco.cbabu.videoplayer.
    Main">
      <argument>rtsp://<server>/archive/2413e6746c8441?
       token=HQFmZ0yl2ynton0CvOKMifXwe6gBONLAOeMqaPzw2jTrrbhh
       SjbnjOr2siZJmIIqcg2gJDNsFpMrDheQyUGYveUhDQAwdT6ze6mQeek
       JPhipAhtI15Rrfaackd6r6jlj</argument>
   </application-desc>
</jnlp>

Example 2

An example of a failure response. (The GET request was sent without the required rtspUrl parameter).

HTTPS GET :https://<server>:<port>/ora/controlService/control/launchMediaPlayer

Headers: JSESSIONID (the jsessionID received from a previous signIn request)

Response:

...
Content-type: application/json
...

{
    "responseMessage": "Failure: Missing parameter in message.",
    "responseCode": 4061,
    "detail": "rtspUrl"
}

{
   "requestParameters":
                {
                "sessionId": "<replace with your string>",
                                "tagName": "<replace with 
                                 your string>",
                                "tagOffset": <replace with 
                                 your integer>
               }

See API Parameters.

{
         "responseCode": 2000,
         "responseMessage": "Successful"
 }

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: tagEvent

Event action: added

Within Cisco, the accepted protocol when adding tags is to include a prefix and a colon (:) at the beginning of each tag to identify the application that is inserting the tag. For example, the prefix for tags inserted by CCX applications is "CCX:". Following this protocol ensures that multiple, independent client applications can insert tags into MediaSense without inadvertently inserting tag names that are meaningful or confusing to each other.

HTTPS POST:

https://10.10.10.10:8440/ora/managementService/manage/
addSessionTag

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   "requestParameters":
                {
                    "sessionId": "AMS_10.194.118.56_
                     1283550575777_2",
                    "tagName": "Sample tag",
                    "tagOffset": 10
               }
}

Response:

{
     "responseMessage":"Success: Your request was 
      successfully completed.",
     "responseCode":2000
}

{
   "requestParameters": {
                        "sessionId": "<replace with your 
                         string>",
                        "conversionFormat": "<replace with 
                          your string>"
                      }
}

See API Parameters.

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "convertedLink": "<This is a String>"
    }
}

{
    “responseCode”: <this is an integer>,
    “responseMessage”: “Failure: <this is a string>”,
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: sessionEvent

Event action: updated

Available since API Version 1.0

Deprecated in API Version 1.5 in favor of mp4Url.

See API Parameters.

If the MediaSense session already exists in the request format, the existing links are returned. New links are not created in the system. If the MediaSense session is in ACTIVE or ERROR state, the session cannot be converted.

Converted mp4 and wav files are deleted by the system a maximum of 2 hours after they have been created or last modified.

Example 1

HTTPS POST:

https://10.10.10.10:8440/ora/managementService/manage/
convertSession

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{ "requestParameters":
     {
         "sessionId": "AMS_10.10.10.10_1283550575777_2",
         "conversionFormat": "mp4"
     }
}

Response:

{
    "responseMessage":"Success: Your request was 
     successfully completed.",
    "responseCode":2000,
    "responseBody":
        {
            "convertedLink":"http://10.10.10.10:8080/
             oramedia/mp4/Session-1-10.10.10.10-
             1283811989534.mp4"
        }
}

Example 2—System Capacity Exceeded

HTTPS POST:

 https://10.10.10.10:8440/ora/managementService/manage/
convertSession

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{ "requestParameters":
     {
         "sessionId": "AMS_10.10.10.10_1283550575777_2",
         "conversionFormat": "mp4"
     }
}

Response:

{
    “responseCode”: 5006,
    “responseMessage”: “Failure: Unable to convert the 
     session. Try again later.”,
    "detail": "Capacity Exceeded"
}

You cannot delete an active session.

{
   "requestParameters": {
                         "sessionIds": ["<replace with your 
                          string>", "<replace with your 
                          string>", ...]
                        }
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "abcd1234"
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: sessionEvent

Event action: deleted

The jobId parameter in a successful response is used in the job query API to retrieve the job status and results.

To delete multiple recordings:

HTTPS POST:

https://10.194.118.64:8440/ora/managementService/manage/
deleteSessions

Headers:

Content-Type: application/json

Body:

{
    "requestParameters": {
        "sessionIds": [
            "4ed31387d58902d1",
            "4ed31387d58923a3"
        ]
    }
}

Response:

 {
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "abcd1234"
}

Use this API to delete tags from a session. A tag is the name assigned by the user to label a recording. After you no longer need a label or tag, delete it from this session using this API.

The tagName and tagOffset parameters are unique for a tag. When deleting a recording, make sure that you use the same name and offset fields with which it was created (using the addSessionTag API).

After you delete a recording, you cannot undo this operation; but you can add the tag again to the session by specifying the tag name and offset fields.

{
   "requestParameters":
                {
                "sessionId": "<replace with your string>",
                                "tagName": "<replace with 
                                 your string>",
                                "tagOffset": <replace with 
                                 your integer>
               }
}

See API Parameters.

{
         "responseCode": 2000,
         "responseMessage": "Successful"
 }

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Event type: tagEvent

Event action: deleted

HTTPS POST:

https://10.78.95.207:8440/ora/managementService/manage/
deleteSessionTag

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
   "requestParameters":
                {
                		"sessionId": "3212d734fd0a71",
                  "tagName": "demo",
				              "tagOffset": 10
               }
}

Response:

{
     "responseMessage":"Success: Your request was 
      successfully completed.",
     "responseCode":2000
}

• offset=<replace with your integer>
• limit=<replace with your integer>
• minSessionStartDate=<replace with your integer>
• maxSessionStartDate=<replace with your integer>

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an 
                 integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "<this is an 
                         integer>",
                        "tagOffset": "<this is an 
                         integer>"
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": "<this is an 
                         integer>",
                        "trackStartDate": "<this is an 
                         integer>",
                        "trackDuration": "<this is an 
                         integer>",
                        "trackMediaType": "<this is a 
                         string>",
                        "downloadUrl": "<this is a 
                         string>",
                        "codec": "<this is a string>",
                        "participants": [

 
                           {
                                "deviceRef": "<this is 
                                 a string>",
                                "participantStartDate": 
                                "<this is an integer>",
                                "participantDuration": 
                                "<this is an integer>",
                                "isConference": "<this 
                                 is a boolean>",
                                "xRefCi": "<this is a 
                                 string>",
                                "deviceId": "<this is a 
                                 string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a 
                                 string>",
                                "tagType": "<this is a 
                                 string>",
                                "tagCreateDate": "<this 
                                 is an integer>",
                                "tagOffset": "<this is 
                                 an integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

• The following changes were introduced in Release 10.0, Version 1.5:
  • Deprecated httpUrl in favor of mp4Url.
  • Introduced two new parameters in the Urls (for more information, see the Parameter Description table):
    • mp4url
    • wavurl

• The following changes were introduced in Release 9.0(1), Version 1.4:
  • Introduced a new parameter in the Track (for more information, see the Parameter Description table):
    • codec

• The following changes were introduced in Release 8.5(3), Version 1.2:
  • Parameters introduced:
    • callControllerIP
    • callControllerType
    • ccid
    • minSessionStartDate
    • maxSessionStartDate
  • A track can now have tags. The following SYSTEM_DEFINED tagName enumeration values are available at the track level:
    • TrackActive
    • TrackInactive

• The response for this API depends on the query—all parameters may not be available in each response. For example, active sessions do not have a sessionDuration, downloadUrl, and other parameters. Similarly, the httpUrl is only available if the session is converted.

Example 1

To get all active sessions in the last 2 hours ending at 26 Jul 2012 20:45:40 GMT (for example, from 18:45:40 to 20:45:40):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/
query/getAllActiveSessions?maxSessionStartDate=
1343335540154
 

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

Example 2

To get the first ten active sessions between 26 Jul 2012 18:45:40 GMT and 26 Jul 2012 20:45:40 GMT (2 hour time window):

HTTPS GET:

https://10.194.118.1:8443/ora/queryService/query/
getAllActiveSessions?offset=0&limit=10&
minSessionStartDate=1343328340000&maxSessionStartDate
=1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

These parameters must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an 
                 integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "<this is an 
                         integer>",
                        "tagOffset": "<this is an 
                         integer>"
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": "<this is an 
                         integer>",
                        "trackStartDate": "<this is an 
                         integer>",
                        "trackDuration": "<this is an 
                         integer>",
                        "trackMediaType": "<this is a 
                         string>",
                        "downloadUrl": "<this is a 
                         string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is 
                                 a string>",
                                "participantStartDate": 
                                "<this is an integer>",
                                "participantDuration": 
                                "<this is an integer>",
                                "isConference": "<this 
                                 is a boolean>",
                                "xRefCi": "<this is a 
                                 string>",
                                "deviceId": "<this is a 
                                 string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a 
                                 string>",
                                "tagType": "<this is a 
                                 string>",
                                "tagCreateDate": "<this 
                                 is an integer>",
                                "tagOffset": "<this is 
                                 an integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

• The following changes were introduced in Release 10.0, Version 1.5:
  • Deprecated httpUrl in favor of mp4Url.
  • Introduced two new parameters in the Urls (for more information, see the Parameter Description table):
    • mp4url
    • wavurl
• The following changes were introduced in Release 9.0(1), Version 1.4:
  • Introduced a new parameter in the Track (for more information, see the Parameter Description table):
    • codec
• The following changes were introduced in Release 8.5(3), Version 1.2:
  • Parameters introduced:
    • callControllerIP
    • callControllerType
    • ccid
    • minSessionStartDate
    • maxSessionStartDate
  • A track can now have tags. The following SYSTEM_DEFINED tagName enumeration values are available at the track level:
    • TrackActive
    • TrackInactive

Example 1

To get all the pruned sessions in the last 2 hours ending at 26 Jul 2012 20:45:40 GMT (for example, from 18:45:40 to 20:45:40):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getAllPrunedSessions?maxSessionStartDate=1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

Example 2

To get the first ten pruned sessions between 26 Jul 2012 18:45:40 GMT and 26 Jul 2012 20:45:40 GMT (2 hour time window):

HTTPS GET:

 https://10.194.118.1:8440/ora/queryService/query/
getAllPrunedSessions?offset=0&limit=10&
minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

{
   "requestParameters":{
        "sessionIdList" : [
            "<replace with your string>"
        ]
    }
}

See API Parameters.

{
   "responseMessage":"Success: Your request was successfully completed.",
   "responseCode":2000,
   "responseBody":{
      "sessions":[
         {
            "sessionState":"<this is a string>",
            "callControllerType":"<this is a string>",
            "sessionId":"<this is a string>",
            "urls":{
               "httpUrl":"<this is a string>",
               "rtspUrl":"<this is a string>",
               "mp4Url":"<this is a string>",
               "wavUrl":"<this is a string>"
            },
            "sessionStartDate":"<this is an integer>",
            "tracks":[
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is a an integer>",
                        "isConference":"<this is a boolean>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               },
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a boolean>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               }
            ],
            "sessionDuration":"<this is an integer>",
            "callControllerIP":"<this is a string>"
         },
         {
            "sessionState":"<this is a string>",
            "callControllerType":"<this is a string>",
            "sessionId":"<this is a string>",
            "urls":{
               "httpUrl":"<this is a string>",
               "rtspUrl":"<this is a string>",
               "mp4Url":"<this is a string>",
               "wavUrl":"<this is a string>"
            },
            "sessionStartDate":"<this is an integer>",
            "tracks":[
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a string>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               },
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a string>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               }
            ],
            "sessionDuration":"<this is an integer>",
            "callControllerIP":"<this is a string>"
         }
      ]
   }
}

{
    "responseCode": “<this is an integer>”,
   "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

The Call Association feature works by iterating through the stored recordings and searching for common xRefCi values.

For example, if a conversation involves a call transfer from one agent (with BiB activated) to another agent (with BiB activated), the recording sessions generated will be linked to each other through a chain of common xRefCi values. The Call Association feature takes advantage of this and prepares a set of recording sessions which are thus related to each other.

HTTPS POST:

https://10.78.170.114:8440/ora/queryService/query/g
etAssociatedSessions

Headers:

Content-Type: application/json

Body:

{
   "requestParameters":{
        "sessionIdList" : [
            "514406fbae4a1"
        ]
    }
}

Response:

{
   "responseMessage":"Success: Your request was successfully completed.",
   "responseCode":2000,
   "responseBody":{
      "sessions":[
         {
            "sessionState":"CLOSED_NORMAL",
            "callControllerType":"Cisco-CUCM",
            "sessionId":"614406fbae5e1",
            "urls":{
               "httpUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/614406fbae5e1.mp4",
               "rtspUrl":"rtsp://10.78.170.114/archive/614406fbae5e1",
               "mp4Url":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/614406fbae5e1.mp4",
               "wavUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/wav/614406fbae5e1.wav"
            },
            "sessionStartDate":1391686561,
            "tracks":[
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78119,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=614406fbae5e1-TRACK1",
                  "trackNumber":1,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341051",
                        "isConference":false,
                        "xRefCi":"20248680",
                        "participantDuration":78119,
                        "deviceId":"SEP70F39517B88A"
                     }
                  ]
               },
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78119,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=614406fbae5e1-TRACK0",
                  "trackNumber":0,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341052",
                        "isConference":false,
                        "xRefCi":"20248679",
                        "participantDuration":78119,
                        "deviceId":"SEP402CF4ECA126"
                     }
                  ]
               }
            ],
            "sessionDuration":78119,
            "callControllerIP":"10.65.157.134"
         },
         {
            "sessionState":"CLOSED_NORMAL",
            "callControllerType":"Cisco-CUCM",
            "sessionId":"514406fbae4a1",
            "urls":{
               "httpUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/514406fbae4a1.mp4",
               "rtspUrl":"rtsp://10.78.170.114/archive/514406fbae4a1",
               "mp4Url":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/514406fbae4a1.mp4",
               "wavUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/wav/514406fbae4a1.wav"
            },
            "sessionStartDate":1391686561,
            "tracks":[
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78093,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=514406fbae4a1-TRACK1",
                  "trackNumber":1,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341052",
                        "isConference":false,
                        "xRefCi":"20248679",
                        "participantDuration":78093,
                        "deviceId":"SEP402CF4ECA126"
                     }
                  ]
               },
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78093,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=514406fbae4a1-TRACK0",
                  "trackNumber":0,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341051",
                        "isConference":false,
                        "xRefCi":"20248680",
                        "participantDuration":78093,
                        "deviceId":"SEP70F39517B88A"
                     }
                  ]
               }
            ],
            "sessionDuration":78093,
            "callControllerIP":"10.65.157.134"
         }
      ]
   }
}

This parameter must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "this is an 
                 integer>",
                "sessionDuration": "this is an integer>",
                "sessionState": "this is an integer>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "this is an 
                         integer>",
                        "tagOffset": "this is an integer>"
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": "this is an integer>",
                        "trackStartDate": "this is an 
                         integer>",
                        "trackDuration": "this is an integer>",
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is a 
                                 string>",
                                "participantStartDate": "this 
                                 is an integer>",
                                "participantDuration": "this 
                                 is an integer>",
                                "isConference": "<this is a 
                                 boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": "this is an 
                                 integer>",
                                "tagOffset": "this is an 
                                 integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.2.

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

To get the session with the sessionId "13092154564622":

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionBySessionId?value=13092154564622

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

Use this API to search and retrieve recorded, live, or pruned sessions.

Requirement: To enforce scalability, this API requires a sessionStartDate field condition.

Limitation: This API stipulates that any kind of query is not possible. This limitation is due to the use of logical connectors between different parameters in the query.

If you have three fields to query: f1, f2, and f3; and if the query is "f1=<query> and f2=<query> or f3=<query>", then SQL precedence rules are applied to the fields such that the query translates to: "[ ( f1=<query> and f2=<query> ) or (f3=<query> ) ]".

Due to the use of brackets, f1 and f2 are computed first and the result of that computation is computed with f3.

To summarize the limitation, a query like "[(f1) and (f2 or f3)]" is not possible.

{
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with your 
                     string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with your 
                     string>"                }
            ],
            "paramConnector": "<replace with your string>"        }
    ],
    "pageParameters": {
        "offset": "<replace with your string>",
        "limit": "<replace with your string>"    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>",
            "order": "<replace with your string>"        }
    ]
}

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
		"sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
		"sessionStartDate": <this is an integer>,
                "sessionDuration": <this is an integer>,
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": <this is an integer>,
                        "tagOffset": <this is an integer>
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": <this is an integer>,
                        "trackStartDate": <this is an integer>,
                        "trackDuration": <this is an integer>,
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is a string>",
                                "participantStartDate": <this is an integer>,
                                "participantDuration": <this is an integer>,
                                "isConference": "<this is a boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                           {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": <this is an integer>,
                                "tagOffset": <this is an integer>
                           }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }

            }
        ]
    }
}

{
    “responseCode”: <this is an integer>,
    “responseMessage”: “Failure: <this is a string>”,
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

Example 1

Query: Get all sessions where ( ( tagName = "foo" and sessionStartDate is between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40 ) or ( deviceRef = "1000" and sessionState = "active" ) )

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "tagName",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "foo"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ],
            "paramConnector": "OR"
        },
        {
            "fieldName" : "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "1000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "active"
                    ]
                }
            ]
        }
    ]
}

Example 2

Query: Get all sessions where ( ( xRefCi = 12345678 and tagName = foo ) or ( sessionState = active and sessionStartDate is between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40 ) )

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "xRefCi",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "12345678"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "tagName",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "foo"
                    ]
                }
            ],
            "paramConnector": "OR"
        },
        {
            "fieldName" : "sessionState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "active"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

Example 3

Query: Get all sessions where ( ( (deviceRef = "1000" or deviceRef="2000") or tagName="foo" ) and sessionState="active" )

A query where higher precedence is intended for an 'OR' 
operation over an 'AND' operation is not possible.

Example 4

Query: Get all sessions where ( deviceRef = "1000" and sessionStartDate is between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40 )

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "1000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

Example 5

Query: Get all sessions where a track has been recorded on nodeIPAddress "10.35.146.158" and partition "/common" between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "nodeIPAddress",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "10.35.146.158"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "partition",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "/common"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

Example 6

Query: Get all sessions that have been pruned by the system between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40

Query: Get all sessions that have been pruned by the system between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "pruned",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "true"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

Example 7

Query: Get all sessions that lie within a certain date range, e.g. between Tue, 02 Nov 2010 21:21:40 GMT & Wed, 03 Nov 2010 21:21:40 GMT

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

Example 8

Query: Get all sessions where ( (deviceRef = 1000 or deviceRef = 2000 or deviceRef = 3000) and sessionStartDate is between Nov 2, 2010 21:21:40 & Nov 3, 2010 21:21:40 ) )

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

Headers:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

Body:

{
    "requestParameters": [
        {
            "fieldName": "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "1000"
                    ],
                    "fieldConnector": "OR"
                },
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "2000"
                    ],
                    "fieldConnector": "OR"
                },
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "3000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName": "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator": "between",
                    "fieldValues": [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000 // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

equals

contains

startsWith

endsWith

equals

equals

contains

startsWith

endsWith

between

equals

lessThan

greaterThan

equals

equals

between

equals

equals

equals

equals

equals

sessionId

sessionState

sessionDuration

sessionStartDate

ccid

These parameters must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "this is an integer>",
                "sessionDuration": "this is an integer>",
                "sessionState": "this is an integer>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "this is an integer>",
                        "tagOffset": "this is an integer>"
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": "this is an integer>",
                        "trackStartDate": "this is an integer>",
                        "trackDuration": "this is an integer>",
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is a 
                                 string>",
                                "participantStartDate": "this 
                                 is an integer>",
                                "participantDuration": "this 
                                 is an integer>",
                                "isConference": "<this is a 
                                 boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": "this is an 
                                 integer>",
                                "tagOffset": "this is an 
                                 integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

The following changes were introduced in Release 10.0, Version 1.5:

Example 1

To get all sessions that have the ccid "0584071424-0000065536-0000000016-0671746570":

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=0584071424-0000065536-0000000016-
0671746570&offset=0&limit=0

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

Example 2

To get the first ten sessions that have the ccid "0584071424-0000065536-0000000016-0671746570":

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=13092154564622%4010.194.118.71
&offset=0&limit=10

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

Example 3

To get the first 100 (default number of records returned) sessions that have the ccid "0584071424-0000065536-0000000016-0671746570":

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=0584071424-0000065536-0000000016-
0671746570

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

These parameters must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "<this is an integer>",
                        "tagOffset": "<this is an integer>"
                    }
                ],
                "tracks": [

                    {
                        "trackNumber": "<this is an integer>",
                        "trackStartDate": "<this is an integer>",
                        "trackDuration": "<this is an integer>",
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [
                            {
                                "deviceRef": "<this is a 
                                 string>",
                                "participantStartDate": "<this 
                                 is an integer>",
                                "participantDuration": "<this 
                                 is an integer>",
                                "isConference": "<this is a 
                                 boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": "<this is an 
                                 integer>",
                                "tagOffset": "<this is an 
                                 integer>"
                            }
                        ]
                    }

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

See the following notes.

Example 1

To get all sessions that have the deviceRef "1000" in the last 2 hours ending at 26 Jul 2012 20:45:40 GMT (for example, from 18:45:40 to 20:45:40):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByDeviceRef?value=1000&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

Example 2

To get the first ten sessions that have the deviceRef "1000" between 26 Jul 2012 18:45:40 GMT and 26 Jul 2012 20:45:40 GMT (2 hour time window):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByDeviceRef?value=1000&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

The following parameters must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "<this is an integer>",
                        "tagOffset": "<this is an integer>"
                    }
                ],
                "tracks": [
                       {
                        "trackNumber": "<this is an integer>",
                        "trackStartDate": "<this is an integer>",
                        "trackDuration": "<this is an integer>",
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is a string>",
                                "participantStartDate": "<this is an 
                                 integer>",
                                "participantDuration": "<this is an 
                                 integer>",
                                "isConference": "<this is a boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": "<this is an 
                                 integer>",
                                "tagOffset": "<this is an integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0.

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

Example 1

To get all sessions that have the mediaType "AUDIO" in the last 2 hours ending at 26 Jul 2012 20:45:40 GMT (for example, from 18:45:40 to 20:45:40):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByMediaType?value=AUDIO&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous signIn request>

Example 2

To get the first ten sessions that have the mediaType "AUDIO" between 26 Jul 2012 18:45:40 GMT and 26 Jul 2012 20:45:40 GMT (2 hour time window):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByMediaType?value=AUDIO&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous signIn request>

The following parameters must be specified in the query section of the URL:

See API Parameters.

{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<this is a string>",
                "tags": [
                    {
                        "tagName": "<this is a string>",
                        "tagType": "<this is a string>",
                        "tagCreateDate": "<this is an integer>",
                        "tagOffset": "<this is an integer>"
                    }
                ],
                "tracks": [
                    {
                        "trackNumber": "<this is an integer>",
                        "trackStartDate": "<this is an integer>",
                        "trackDuration": "<this is an integer>",
                        "trackMediaType": "<this is a string>",
                        "downloadUrl": "<this is a string>",
                        "codec": "<this is a string>",
                        "participants": [

                            {
                                "deviceRef": "<this is a string>",
                                "participantStartDate": "<this is an 
                                 integer>",
                                "participantDuration": "<this is an 
                                 integer>",
                                "isConference": "<this is a boolean>",
                                "xRefCi": "<this is a string>",
                                "deviceId": "<this is a string>"
                            }
                        ],
                        "tags": [
                            {
                                "tagName": "<this is a string>",
                                "tagType": "<this is a string>",
                                "tagCreateDate": "<this is an 
                                 integer>",
                                "tagOffset": "<this is an integer>"
                            }
                        ]
                    }
                ],
                "urls": {
                    "httpUrl": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}

{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}

See API Response Codes.

Available since API Version 1.0

Modified in API Version 1.2

Modified in API Version 1.4

Modified in API Version 1.5

See the following notes.

Example 1

To get all sessions that have the tag "mysampletag1" in the last 2 hours ending at 26 Jul 2012 20:45:40 GMT (for example, from 18:45:40 to 20:45:40):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByTag?value=mysampletag1&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous signIn request>

Example 2

To get the first ten sessions that have the tag "mysampletag1" between 26 Jul 2012 18:45:40 GMT and 26 Jul 2012 20:45:40 GMT (2 hour time window):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByTag?value=mysampletag1&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

Headers:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

See API Parameters.

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "apiVersion": "<this is string>"
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getAPIVersion

Response:

{
    "responseMessage": "Success: Your request was successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "apiVersion": "1.4"
    }
}

Use this API to retrieve the current time of the system. The time is returned in milliseconds, since Jan 1, 1970 GMT.

As all MediaSense servers are configured as NTP clients, any differences between them are expected to be small. Therefore only a single system time is returned, and this time applies to all servers in the MediaSense cluster.

See API Parameters.

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "currentSystemTime": <this is an integer>
    }
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}

See API Response Codes.

• There may be a delay from the time the currentSystemTime was generated to the time it was actually received by the client issuing this request.
• While the system time is returned in UNIX epoch time, you can use an Epoch Converter to convert the time to a readable format.

HTTPS GET:

https://10.194.118.72:8440/ora/infoService/info/
getSystemTime

Headers:

JSESSIONID: <the jsessionId received from a signIn 
request>

Response:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "currentSystemTime": "1301145648258"
    }
}

Use this API to retrieve the current version of the getSessions response schema running on the system.

None

None

None

{
	"type":"object",
	"$schema": "http://json-schema.org/draft-03/schema",
	"apiVersion": "string representation of api version",
	"properties": 
   {"responseCode": 
     {"type":"number",
      "required":true },
		  "responseMessage": 
     {"type":"string",
      "required":true }
    "responseBody": 
     {"type":"object",
      "required":false
      "properties":
       {"sessions": 
         {"type":"array",
					     "required":true,
					     "items":
           {"type":"object",
            "required":true,
							     "properties":
             {"callControllerIP": 
               {"type":"string",
									       "required":true },
								      "callControllerType": 
               {"type":"string",
                "required":true },
								      "ccid": 
               {"type":"string",
									       "required":false,
                "searchable": 
                 {"operations": ["equals"] }
             },
								    "sessionDuration": 
             {"type":"number",
              "required":false,
              "minimum":0,
              "searchable": 
               {"operations": ["equals", "lessThan", 
                  "greaterThan"] }
             },

								    "sessionId": 
             {"type":"string",
									     "required":true },
								    "sessionStartDate": 
             {"type":"number",
									     "required":true,
              "minimum":0,
              "searchable": 
               {"operations": ["between"] }
             },
            "sessionState": 
             {"description":"string values are ACTIVE, 
               CLOSED_NORMAL, DELETED, and CLOSED_ERROR",
             "type":"string",
    									"required":true,
             "searchable": 
              {"operations": ["equals"] }
             },
	   							"tags": 
            {"type":"array",
             "required":false,
             "items": 
              {"type":"object",
               "required":true,
											    "properties":
                {"tagCreateDate": 
                  {"type":"number",
												       "required":true },
     												"tagName": 
                  {"type":"string",
													      "required":true,
                   "searchable": 
                    {"operations": ["equals", "contains", 
                       "startsWith", "endsWith"] }
                  },
   												  "tagOffset": 
                  {"type":"number",
											        "required":false },
     												"tagType": 
                  {"description":"string values are 
                    SYSTEM_DEFINED and USER_DEFINED",
                   "type":"string",
                   "required"true,
                   "searchable": 
                    {"operations": ["equals"] }
											        }
										       }
         						},             

             "tracks": 
              {"type":"array",
									      "required":true,
									      "items":
                {"type":"object",
											      "required":true,
											      "properties":
                  {"codec": 
                    {"type":"string",
													        "required":true },
												       "downloadUrl": 
                    {"type":"string",
												         "required":false },
    												   "participants": 
                    {"type":"array",
     													   "required":true,
                     "items": 
                      {"type":"object",
     															   "required":true,
     															   "properties":
                         {"deviceId": 
                           {"type":"string",
							       										    "required":true },
      																    "deviceRef": 
                           {"type":"string",
																	           "required":true,
                            "searchable": 
                             {"operations": ["equals", 
                              "contains", "startsWith", 
                              "endsWith", "between"] }
                           },
                          "isConference": 
                            {"type":"boolean",
									         								   "required":true },
        																  "participantDuration": 
                            {"type":"number",
																             "required":false },
																          "participantStartDate": 
                            {"type":"number",
																	            "required":true },
																          "xRefCi": 
                            {"type":"string",
																	            "required":false,
                             "searchable": 
                               {"operations": ["equals"] }
                            }
															           }
														          }
												          },

												   "tags": 
                 {"type":"array",
                  "required":false,
													     "items": 
                   {"type":"object",
															     "required":true,
															     "properties":
                     {"tagCreateDate": 
                       {"type":"number",
																	       "required":true },
																      "tagName": 
                       {"type":"string",
																	       "required":true },
																      "tagOffset": 
                       {"type":"number",
																        "required":false },
																      "tagType": 
                       {"description":"string values are 
                        SYSTEM_DEFINED and USER_DEFINED", 
                        "type":"string",
                        "required":true, }
															    }
														   }
   												},

												"trackDuration": 
             {"type":"number",
												  "required":false },
												"trackMediaType": 
             {"description":"string values are AUDIO and 
               VIDEO",
              "required":true,
              "type":"string" },
												"trackNumber": 
             {"type":"number",
              "required"true },
												"trackStartDate": 
             {"type":"number",
													 "required":true }
											}
									}
							},
					"urls": 
       {"type":"object",
        "required":false,
								"properties":
         {"mp4Url": 
           {"type":"string",
            "required":false },
										"rtspUrl": 
           {"type":"string",
            "required":false },
										"wavUrl": 
           {"type":"string",
            "required":false	}
									}
							}
					 }
				 }
			 }
		 }
		}
	}
}

{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>"
}

Any HTTP failure scenarios (such as 404 or 500). See API Response Codes.

The "required" tag in the schema means that the parent property has to exist in the actual response. If "required" is not specified or it is set to false, then that property may not be returned by the response.

The array defines properties (such as equals, greaterThan, lessThan, and between) by which the object is searchable. The between property has lowerBound and upperBound values.

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getSessionsResponseSchema

Response:

See Successful JSON response schema above.