In the Contact Center or in speech analytics environments, a supervisor,
an agent or a speech analytics system may need to add a tag to a session that
is being recorded or has already been recorded. Or, they may need to better
manage their session recording repository by deleting some sessions or saving
other sessions to prevent those sessions from being deleted.
MediaSense provides these management capabilities through session
management APIs. Using these APIs, third-party clients can add or delete tags
to sessions and delete sessions one-at-a-time or in bulk. Clients can also
convert a session to supported formats like mp4 or wav and move them to a
pre-specified location (on the MediaSense system).
While you can add or delete tags on both active and completed session
recordings, you can only delete completed session recordings. Similarly, you
cannot convert a session if it is in the ACTIVE or ERROR state.
Use this API to add
tags to closed (already recorded) or active (currently being recorded)
sessions. A tag is the name assigned by the user to label a recording.
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.
Use this API to
convert a MediaSense session to the format specified in the request. If your
request is successful, you receive a list of links of the converted files in
If the MediaSense
session 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.
deletes the converted mp4 and wav files after a maximum of 2 hours of their
creation or last modification.
It is an output string. These strings are generated as part of the
convertSession API. A comma-separated list of URLs. Each URL points to the
audio recording of a session. All values together make up the string.
convertedFormat— It is an intput string. The format to convert a
MediaSense session. Enumeration value is MP4.
is a required input string. The system-generated identifier for a session.
For details of the parameter, see the
Shared Parameters section.
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
tag, you cannot undo this operation. However, you can add the tag again to the
session by specifying the tag name and offset fields.