Overview:

Cisco MediaSense APIs are accessed over HTTPS using a REST-like interface. REST-like implies that MediaSense method calls are made over the internet by sending HTTP GET or POST requests to the Unified MCP servers.

When users send a HTTPS request, a corresponding JSON (see http://www.json.org/) formatted response is returned.

Each API in the List of APIs identifies the supported formats and the sample schema for each API

Instructions:

In order to create a Cisco MediaSense application, adhere to the following requirements.

Hardware and Software Requirements:

A configured and deployed Cisco MediaSense platform (see the Installation and Administration Guide for Cisco Unified Media Capture Platform and the_Solution Reference Network Design Guide for_ Cisco Unified Media Capture Platform)

Licensing

If you have a firewall between your client and the Cisco MediaSense platform, you will need to open the HTTP/HTTPS ports. See the Cisco Unified Media Capture Platform Solution Reference Network Design Guide for more information.

Developer Requirements:

You should have a basic understanding of HTTP, REST, JSON, COMET, SSH and Unix.

Regardless of the format used in your third-party applications which use MediaSense APIs, follow the conventions specified in this section:

  • Specify the desired format in the HTTP accept header of each API request.
  • If the Header is missing, the data is returned in the default JSON format.

MediaSense API methods are categorized as follows:

  • Authentication: Sign in and sign out
  • Recording Control: Start, Stop, Pause, and Resume
  • Conversation Query: Search for a recording based a combination of various parameters
  • Conversation Management: Delete, lock, or tag a recording
  • Subscribe Notify: Monitor an audio call or an agent's screen