Contents
| Event description: | This event is sent each time a new recording session is started or an existing recording session is updated or ended. It is also sent when a recording session is deleted or pruned. For deleted and pruned sessions, the sessions are batched and sent in a single event. |
| Events triggered: | sessionEvent |
| Method: | POST |
| Body: | JSON |
| Event schema: |
{US157917: Basic Arch - Serviceability - RTMT and PRIME Counters
"eventType": "<this is a string>",
"eventAction": "<this is a string>",
"forwardedEvent": "<this is a string>",
"eventBody": {
"sessionId": "<this is a string--present only if the
eventAction is not PRUNED or DELETED>",
"sessionIds": [
"<this is a string--array is present only if the
eventAction is PRUNED or DELETED>"
],
"callControllerIP": "<this is a string>",
"callControllerType": "<this is a string>",
"ccid": "<this is a string>",
"sessionStartDate": "<this is an integer--present only
if the eventAction is not PRUNED or DELETED>",
"sessionDuration": "<this is an integer--present only
if the eventAction is not PRUNED or DELETED>",
"sessionState": "<this is a string--present only if
the eventAction is not PRUNED or DELETED>",
"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>",
"participantInformation": {
"loginId": "<this is a string>",
"lastName": "<this is a string>",
"firstName": "<this is a string>",
"loginIdDomain":
"<this is an integer>",
"loginName": "<this is a string>"
},
"lineDisplayName": "<this is a string>",
"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": "<thisisastring>"
},
{
"rtspUrl": "<thisisastring>"
},
{
"mp4Url": "<thisisastring>"
},
{
"wavUrl": "<thisisastring>"
}
]
}
}
|
| Event example: |
{
"eventType": "SESSION_EVENT",
"eventAction": "DELETED",
"forwardedEvent": "TRUE",
"eventBody": {
"sessionIds": ["Session-6-10.194.118.57-1284096640651",
"Session-6-10.194.118.57-1284096640652"]
}
}
|
{
"eventAction": "STARTED",
"eventBody": {
"sessionId": "Session-6-10.194.118.57-1284096640651",
"callControllerType": "Cisco-CUCM",
"callControllerIP": "10.194.118.57"
"ccid": "2728850048-0000065536-0000018373",
"sessionStartDate": 1284096641174,
"sessionState": "ACTIVE",
"tracks": [
{
"participants": [
{
"deviceRef": "1004",
"participantInformation": {
"loginId": "123",
"lastName": "LastName",
"firstName": "AgentFirstName",
"loginIdDomain": 1,
"loginName": "AgentLoginName"
},
"lineDisplayName": "DisplayName",
"isConference": false,
"participantStartDate": 1284096641174,
"xRefCi": "30413550",
"deviceId": "SEP001562106BCB"
}
],
"trackMediaType": "AUDIO",
"trackNumber": 1,
"trackStartDate": 1284096641174
},
{
"participants": [
{
"deviceRef": "1000",
"participantInformation": {
"loginId": "1234",
"lastName": "LastName1",
"firstName": "AgentFirstName1",
"loginIdDomain": 2,
"loginName": "AgentLoginName1"
},
"lineDisplayName": "DisplayName1",
"isConference": false,
"participantStartDate": 1284096641174,
"xRefCi": "30413551",
"deviceId": "SEP000BBEAD4C86"
}
],
"trackMediaType": "AUDIO",
"trackNumber": 0,
"trackStartDate": 1284096641174
}
],
"urls": [
{
"rtspUrl": "rtsp://10.194.118.57/live/
Session-6-10.194.118.57-1284096640651"
}
]
},
"eventType": "SESSION_EVENT",
"forwardedEvent": "TRUE"
}
|
|
{
"eventAction": "ENDED",
"eventBody": {
"sessionId": "Session-6-10.194.118.57-1284096640651",
"callControllerType": "Cisco-CUCM",
"callControllerIP": "10.194.118.57"
"ccid": "2728850048-0000065536-0000018373",
"sessionState": "CLOSED_NORMAL",
"sessionStartDate": 1284096641174,
"sessionDuration": 8394,
"tracks": [
{
"participants": [
{
"deviceRef": "1004",
"participantInformation": {
"loginId": "123",
"lastName": "LastName",
"firstName": "AgentFirstName",
"loginIdDomain": 1,
"loginName": "AgentLoginName"
},
"lineDisplayName": "DisplayName",
"isConference": false,
"participantDuration": 8394,
"participantStartDate": 1284096641174,
"xRefCi": "30413550"
}
],
"trackDuration": 8394,
"trackMediaType": "AUDIO",
"downloadUrl": "http://10.194.118.57:8081/
ExportRaw?recording=Session-6-10.194.118.57-
1284096640651-TRACK1",
"trackNumber": 1,
"trackStartDate": 1284096641174
},
{
"participants": [
{
"deviceRef": "1000",
"participantInformation": {
"loginId": "1234",
"lastName": "LastName1",
"firstName": "AgentFirstName1",
"loginIdDomain": 2,
"loginName": "AgentLoginName1"
},
"lineDisplayName": "DisplayName1",
"isConference": false,
"participantDuration": 8394,
"participantStartDate": 1284096641174,
"xRefCi": "30413551"
}
],
"trackDuration": 8394,
"trackMediaType": "AUDIO",
"downloadUrl": "http://10.194.118.57:8081/
ExportRaw?recording=Session-6-10.194.118.57-
1284096640651-TRACK0",
"trackNumber": 0,
"trackStartDate": 1284096641174
}
],
"urls": [
{
"rtspUrl": "rtsp://10.194.118.57/archive/
Session-6-10.194.118.57-1284096640651"
}
]
},
"eventType": "SESSION_EVENT",
"forwardedEvent": "TRUE"
}
|
|
|
Availability: |
Available since API Version 1.0.
Modified in Version 1.1 Modified in Version 1.2 Modified in API Version 1.4 Modified in API Version 1.5 See the following notes. |
| Release: | 8.5(1) |
| Notes: |
The following changes have been introduced in MediaSense Release 10.5 SU1 (when it is deployed along with Finesse, and AgentInfo gadget is deployed on the Finesse Agent desktop).
The following changes were introduced in Release 10.0, Version 1.5:
The following change was introduced in Release 9.0(1), Version 1.4:
The following changes were introduced in Release 8.5(3), Version 1.2:
|
| Event description: | This event is sent each time the storage disk space (that stores the recorded media) reaches various thresholds. More information about threshold values is provided in a table that follows. |
| Events triggered: | storageThresholdEvent |
| Method: | POST |
| Body: | JSON |
| Event schema: |
{
"eventType" : "<this is a string>",
"eventAction": "<this is a string>",
"forwardedEvent" : "<this is a string>",
"eventBody": {
"nodeId":<this is an integer>,
"nodeIPAddress": "<this is a
string>,
"partition": "<this is a string>",
"percentageUtilization": <this is
an integer>
}
}
|
| Event example: |
{
"eventType":"STORAGE_THRESHOLD_EVENT",
"eventAction":"ENTER_LOW_STORAGE_SPACE",
"forwardedEvent":"TRUE",
"eventBody": {
"nodeId": 1,
"nodeIPAddress":"10.X.X.X",
"partition" : "/common",
"percentageUtilization": 70
}
}
|
Availability: |
Available since API Version 1.0. |
| Release: | 8.5(1) |
| Notes: | Related API: subscribeRecordingEvent
|
The threshold values percentage and implications are provided in the following table:
| Threshold | Storage Percentage | Description |
|---|---|---|
| ENTER_LOW_ STORAGE_SPACE |
Recorded media crossed the 75% storage utilization mark. | First warning to indicate that the disk storage is running into low space condition. |
| EXIT_LOW_ STORAGE_SPACE |
Recorded media usage dropped below 70% utilization mark. | The disk storage is exiting the low storage space condition. |
| ENTER_CRITICAL_ STORAGE_SPACE |
Recorded media crossed the 90% local storage utilization mark. | Second warning. When entering this condition, you must take action to guarantee future recording resources on this node. If operating in the Retention priority mode, new recording sessions are not accepted when you reach this threshold. In the New Recording Priority Mode, older recordings are automatically pruned to make room for new recordings. |
| EXIT_CRITICAL_ STORAGE_SPACE |
Recorded media usage dropped below the 85% utilization mark. | The disk storage is exiting the critical storage space condition. At this point the local node is still considered to be low on resources. |
| ENTER_EMERGENCY_ STORAGE_SPACE |
Recorded media crossed the 99% storage utilization mark. | Last warning. When entering this condition, you must take action to guarantee future recording resources on this node. If operating in the Retention priority mode, existing recording sessions are terminated when you reach this threshold. |
| EXIT_EMERGENCY_ STORAGE_SPACE |
Recorded media usage dropped below the 97% utilization mark. | The disk storage is exiting the emergency storage space condition. At this point, the local node is still considered to be low on resources and new recording sessions are still not accepted. |
| Event description: | This event is sent when a tag is added or deleted from a session. In a multi-server MediaSense deployment, the client can subscribe to only one MediaSense API service and receive notifications generated by other MediaSense services. | ||
| Events triggered: | tagEvent | ||
| Method: | POST | ||
| Body: | JSON | ||
| Event schema: |
{
"eventType": "<this is a string>",
"eventAction": "<this is a string>",
"forwardedEvent" :" <this is a string>",
"eventBody":
{
"sessionId": "<this is a string>",
"tagName": "<this is a string>",
"tagType" : "<this is a string>",
"tagCreateDate":<this is an integer>,
"tagOffset":<this is an integer>,
"trackNumber":<this is an integer>
}
}
|
||
| Event examples: | The following example shows a user-defined tag that is time-bound (the tagOffset field is present). The date the tag was created is Sept 9, 2010 23:14:13 GMT. You can use an Epoch converter to see the date and time in a sensible format. The offset represents the number of milliseconds from the start of the session that the tag represents. In this case it represents five minutes.
{
"eventType": "TAG_EVENT",
"eventAction": "UPDATED",
"eventBody": {
"sessionId": "1234abcd5678efgh90xyz",
"tagName": "Customer response",
"tagType": "USER_DEFINED",
"tagCreateDate": 1284074053,
"tagOffset": 300000
}
}
|
||
| The following example shows a system-defined tag that was added to a track within a session. The track is identified by the trackNumber.
{
"eventType": "TAG_EVENT",
"eventAction": "ADDED",
"eventBody": {
"sessionId": "57130d87d73f41",
"tagCreateDate": 1309302169848,
"tagName": "TrackInactive",
"tagOffset": 11203,
"tagType": "SYSTEM_DEFINED",
"trackNumber": 1
}
}
|
|||
Availability: |
Available since API Version 1.0. | ||
| Release: | 8.5(1) | ||
| Notes: |
|