Cisco MediaSense 開発者ガイド リリース 10.5(1)
トリガーされるイベント
トリガーされるイベント

トリガーされるイベント

sessionEvent

イベントの説明: このイベントは、新しい録音セッションが開始されるか、既存の録音セッションが更新または終了されるたびに送信されます。 また、録音セッションが削除されるか、切り取られる場合にも送信されます。 削除されたり、切り取られたりしたセッションでは、セッションが 1 つのイベントでバッチ処理され、送信されます。
トリガーされたイベント: sessionEvent
方式: POST
ボディ: JSON
イベントのスキーマ:
{
    "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>",
                        "participantDuration": "<this is an 
                         integer>",
                        "isConference": "<this is a boolean>",
                        "xRefCi": "<thisisastring>",
                        "deviceId": "<thisisastring>"
                    }
                ],
                "tags": [
                    {
                        "tagName": "<thisisastring>",
                        "tagType": "<thisisastring>",
                        "tagCreateDate": "<this is an integer>",
                        "tagOffset": "<this is an integer>"
                    }
                ]
            }
        ],
        "urls": [
                  {
                     "httpUrl": "<thisisastring>"
                  },
                  {
                     "rtspUrl": "<thisisastring>"
                  },
                  {
                     "mp4Url": "<thisisastring>"
                  },
                  {
                     "wavUrl": "<thisisastring>"

                  }
                ]
   }
}
イベントの例:
{
    "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",
                        "isConference": false,
                        "participantStartDate": 1284096641174,
                        "xRefCi": "30413550",
                        "deviceId": "SEP001562106BCB"
                    }
                ],
                "trackMediaType": "AUDIO",
                "trackNumber": 1,
                "trackStartDate": 1284096641174
            },
            {
                "participants": [
                    {
                        "deviceRef": "1000",
                        "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",
                        "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",
                        "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"
}

提供開始時期:

API バージョン 1.0 以降で使用できます。

バージョン 1.1 で変更

バージョン 1.2 で変更

API バージョン 1.4 で変更

API バージョン 1.5 で変更

次の注を参照してください。

リリース: 8.5(1)
注:
  • リリース 10.0、バージョン 1.5 で次の変更が導入されました。
    • httpUrl が非推奨となり、mp4Url が導入されます。
    • URL に 2 つの新しいパラメータが追加されました(詳細については、「パラメータの説明」を参照してください)。
      • mp4url
      • wavurl
  • リリース 9.0(1)、バージョン 1.4 で次の変更が導入されました。
    • トラックの新しいパラメータが追加されました(詳細については、「パラメータの説明」を参照してください)。
      • コーデック
  • リリース 8.5(3)、バージョン 1.2 で次の変更が導入されました。
    • 導入されたパラメータ:
      • callControllerIP
      • callControllerType
      • ccid

  • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
    • TrackActive
    • TrackInactive
  • 詳細については、「パラメータの説明」を参照してください。
  • 関連 API:
    • startRecording
    • stopRecording
  • 関連する eventAction の注記:
    • eventAction が切り取られたり、削除されたりした場合、sessionIds のアレイのみが eventBody に存在します。
    • 他のすべての eventActions については、セッション ID の文字列およびその他の詳細情報が eventBody に存在します(前述のスキーマを参照してください)。
    • 更新された eventAction は他のパラメータを更新できますが、URL を変更しません。 これらは、セッション継続中は一定のままです。
    • 転送または別のコール制御処理により遠端側(非分岐デバイス)が変更された場合、eventAction の更新が発生します。 このイベントは参加者のパラメータを変更する場合があります。ただし、rtspUrl パラメータは変更できません。
    • 転送などのコール制御処理により近端(分岐デバイス)が変更された場合、UPDATE は生成されません。 代わりに、セッションが終了し、新しいセッションが開始されます。
    • デフォルトでは、マルチサーバ MediaSense の展開において、クライアントは両方の MediaSense API サービスに登録する必要があります。 セッション イベントをトリガーする操作はどちらのサーバでも実行できます。ただし、各サーバはその MediaSense サーバ内で実行される操作にのみイベントを送信します。

storageThresholdEvent

イベントの説明: このイベントは、ストレージのディスク容量(録音されたメディアを保存)が各種しきい値に達するたびに送信されます。 しきい値に関する詳細を次の表に示します。
トリガーされたイベント: storageThresholdEvent
方式: POST
ボディ: JSON
イベントのスキーマ:
{
 "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>
              }
 }
イベントの例:
{
 "eventType":"STORAGE_THRESHOLD_EVENT",
 "eventAction":"ENTER_LOW_STORAGE_SPACE",
 "forwardedEvent":"TRUE",
 "eventBody": {
                 "nodeId": 1,
                 "nodeIPAddress":"10.X.X.X",
                 "partition" : "/common",
                 "percentageUtilization": 70
               }


 }

提供開始時期:

API バージョン 1.0 以降で使用できます。
リリース: 8.5(1)
注: 関連 API:subscribeRecordingEvent
  • イベント アクション値

イベント アクション値

しきい値の割合とその意味を次の表に示します。

しきい値 ストレージの割合 説明
ENTER_LOW_

STORAGE_SPACE

録音済みメディアのストレージ使用率が 75% の限度を超えました。 ディスク ストレージがスペース不足状態になっていることを示す最初の警告です。
EXIT_LOW_

STORAGE_SPACE

録音メディアの使用率が 70% の限度以下に低下しました。 ディスク ストレージはスペース不足状態から脱出しています。
ENTER_CRITICAL_

STORAGE_SPACE

録音済みメディアのストレージ使用率が 90% の限度を超えました。 2 度目の警告です。 この状態に達した場合、このノード上で将来の録音リソースを保証するための措置を講じる必要があります。 保持優先モードで動作している場合、このしきい値に達すると新しい録音セッションは受け入れられません。 新規録音優先モードでは、新しい録音用の領域を確保するため、古い録音は自動的に切り取られます。
EXIT_CRITICAL_

STORAGE_SPACE

録音メディアの使用率が 85% の限度以下に低下しました。 ディスク ストレージは危機的なスペース状態から脱出しています。 この時点では、ローカル ノードはリソース不足状態と見なされます。
ENTER_EMERGENCY_

STORAGE_SPACE

録音済みメディアのストレージ使用率が 99% の限度を超えました。 最後の警告です。 この状態に達した場合、このノード上で将来の録音リソースを保証するための措置を講じる必要があります。 保持優先モードで稼動している場合、このしきい値に達すると既存の録音セッションが終了します。
EXIT_EMERGENCY_

STORAGE_SPACE

録音メディアの使用率が 97% の限度以下に低下しました。 ディスク ストレージは緊急ストレージ容量状態から脱出しています。 この時点では、ローカル ノードはまだリソース不足状態と見なされ、新しい録音セッションは受け入れられません。

tagEvent

イベントの説明: このイベントは、タグがセッションに追加またはセッションから削除された場合に送信されます。 マルチサーバ MediaSense 展開では、クライアントは 1 つの MediaSense API サービスだけにサブスクライブし、他の MediaSense サービスによって生成される通知を受信できます。
トリガーされたイベント: tagEvent
方式: POST
ボディ: JSON
イベントのスキーマ:
{
    "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>
               }
}
イベントの例:

次は、期間が限定された(tagOffset フィールドあり)ユーザ定義タグの例です。 タグが作成された日付は 2010 年 9 月 9 日 23:14:13 GMT です。 ここにあるエポック コード変換器を使用し、暗号化された日付と時刻を表示できます。 オフセットは、タグが表すセッションの開始からの時間をミリ秒単位で表します。 この例では、5 分を表しています。

(注)     

MediaSense では、USER_DEFINED の期間限定タグに tagOffset 0 (ゼロ値)を使用できません。 期間限定タグを使用して録音を開始する場合とき、少なくとも 1 ミリ秒の tagOffset を使用します。

{
    "eventType": "TAG_EVENT",
    "eventAction": "UPDATED",
    "eventBody":  {
                           "sessionId": "1234abcd5678efgh90xyz",
                           "tagName": "Customer response",
                           "tagType": "USER_DEFINED",
                           "tagCreateDate": 1284074053,
                           "tagOffset": 300000

                  }
}

次は、セッション内のトラックに追加されたシステム定義タグの例です。 トラックは trackNumber で識別されます。

{
    "eventType": "TAG_EVENT",
    "eventAction": "ADDED",
    "eventBody": {
        "sessionId": "57130d87d73f41",
        "tagCreateDate": 1309302169848,
        "tagName": "TrackInactive",
        "tagOffset": 11203,
        "tagType": "SYSTEM_DEFINED",
        "trackNumber": 1
    }
}

提供開始時期:

API バージョン 1.0 以降で使用できます。
リリース: 8.5(1)
注:
  • 次のパラメータはリリース 8.5(3)、バージョン 1.2 で導入されました。
    • trackNumber (オプションのフィールド。 このフィールドがある場合、このタグがこの trackNumber で識別されるセッションのトラックに適用できることを示します)
  • 関連 API:
    • addSessionTag
    • pauseRecording
    • resumeRecording
    • deleteSessionTag
  • 詳細については、「パラメータの説明」を参照してください。