Cisco MediaSense 開発者ガイド リリース 11.0(1)
共有パラメータ
共有パラメータ

共有パラメータ

はじめに

MediaSense API では、ターム パラメータを使用して、項目を JSON オブジェクトの名前と値で説明します。 これらの項目は、各種プログラミング インターフェイスのさまざまなタームによって参照されます。

パラメータは次のように分類されます。

  • 必須の入力パラメータは必要なユーザ定義の値であり、API またはイベントが発行されるとユーザがシステムに提供します。
  • 任意の入力パラメータはユーザ定義の値であり、API またはイベントが発行されるとユーザがシステムに提供する場合があります。 これらのパラメータ値は、ユーザが必要と判断したときにだけ提供されます。
  • 出力パラメータは、システムによって生成される、API またはイベントを発行した結果の値です。 これらの値は、入力パラメータ値とそれを使用する API またはイベントに従って計算されます。

API すべてに共通のパラメータ

以下は、すべての API で共通のパラメータです。

detail

  • 出力文字列。

  • 応答コードに関する情報を提供します。

JSESSIONID

  • 出力文字列と必須の入力文字列の両方。

  • ヘッダー パラメータ。

  • セッション識別子であり、後続の要求の認証手段として機能します。

  • ユーザが明示的にログアウトした時点、または非アクティブになってから 30 分後(どちらか早い方)に期限切れになります。

responseCode

  • 出力整数。

  • 対応するエラー コード。

responseMessage

  • 出力文字列。

  • トラブルシューティングを目的とした responseCode の説明。

共有パラメータ

byFieldName

  • オプション入力文字列。

  • sortParameters に必須の入力文字列。

  • 列挙値はこのパラメータを使用している API によって異なります。

callControllerIP

  • 出力文字列。

  • callControllerType = Cisco-SIPGateway の場合、録音を開始したゲートウェイの IP アドレスです。

  • callControllerType = Cisco-Unified Communications Manager の場合、録音を開始した Unified Communications Manager デバイスの IP アドレスです。

  • callControllerType = direct の場合、IOS の IP アドレスまたは MediaSense と通信する Unified Ccommunications Manager デバイスです。

callControllerType

  • 出力文字列。

  • 列挙値(大文字と小文字が区別され、太字で識別)

    • Cisco SIP Gateway(Unified Border Element からのコール)。

    • Cisco Unified Communications Manager(Unified Communications Manager から分岐されたコール)。

    • direct(MediaSense により開始されたダイレクト発信/受信コール)。

    • Cisco-Unified Communications Manager-Gateway(Unified Communications Manager の制御下でゲートウェイから分岐されたコール)

ccid

  • 出力文字列。

  • getSessions を使用する場合のオプション入力文字列。

  • getSessionsByCCID を使用する場合に必須の入力文字列。

  • コール相関 ID。

  • Unified Border Element Gateway から分岐されたコールに常に存在します。ただし、Unified Communications Manager の電話機から分岐されたコールには存在しない場合があります。

  • 同じコールの一部となっている録音セッションを識別するために使用されます。

  • Unified Border Element Gateway により提供される「シスコ guid」フィールドに対応するため、ソリューションの他のコンポーネントからのコール情報に録音セッションを関連付けるために使用することもできます。

コーデック

  • 出力文字列。

  • トラックのコーデック。

  • コーデックの SDP 定義からの標準の名前が含まれます。


    (注)  


    g.711 µ-law および a-law コーデックは、それぞれ「PCMU」および「PCMA」として SDP で認識されます。 AAC-LD コーデックは、MP4A-LATM として認識されます。


deviceId

  • 出力文字列。

  • getSessions を使用する場合のオプション入力文字列。

  • デバイスの一意の識別子。

deviceRef

  • 出力文字列。

  • 各デバイスの電話番号。

  • コールの一方の当事者が会議ブリッジの場合、deviceRef は Unified Border Element において「匿名」、BIB フォーキングにおいて数字の文字列が続く「b」を示します。

downloadUrl

  • 出力文字列。

  • RAW 形式で録音をダウンロードするために使用される URL。

  • 次の 3 つの条件すべてを満たす場合にのみ存在します。

    • API sessionState = CLOSED_NORMAL または eventAction = ENDED であること
    • track mediaType = AUDIO であること
    • trackSize > 0 であること。downloadUrl パラメータは、ACTIVE、DELETED、または CLOSED_ERROR 状態の他のセッションでは使用できません。 downloadUrl パラメータは、クライアントにより不透明な文字列として処理される必要があります。 クライアント コードは完全に形成された HTTPS URL を含むことを前提としますが、それ以外では形式や構造に依存しません。 クライアントは URL パラメータ「?timeout=n」を追加できます。これにより、ダウンロードを中断する前に MediaSense が少なくとも n 秒間ソケットへの書き込みを試行する必要があることを示します。 デフォルト値は n = 5 秒間です。

errorCode

  • 出力整数。

  • 特定のセッションのレポートにエラーがある場合に表示されます。

errorDetail

  • 出力文字列。

  • セッション状態が CLOSED_ERROR のとき、[errorDetail] フィールドに次の値のいずれかが表示されます。

    • MEDIA_SERVER_ERROR:コール制御サーバは、開始セッションまたは終了セッション要求のためのメディア(録音)サーバからのエラー応答を受信します。
    • MEDIA_SERVER_TIMEOUT:コール制御サーバは、開始セッションまたは終了セッション要求のためのメディア(録音)サーバからの応答の待機をタイムアウトします。
    • SIP_SIGNALING_ERROR:コール制御サーバは SIP シグナリング エラーを検出します。 たとえば、ACK の欠落などがあります。
    • SIP_CANCEL_RECEIVED:CANCEL または準備ができていない BYE などのコール制御サーバにより録音がキャンセルされました。
    • NO_MEDIA_RECEIVED:セッションは正常に終了しましたが、すべてのトラックのサイズがゼロです。
    • ORPHANED:セッションが消えずに残っています。 これは、サービスを再開した後にセッションを強制的に終了した場合に発生することがあります。
    • UNSUPPORTED_CODEC:コーデックがサポートされていません。

eventAction

  • 出力文字列。

  • eventAction(sessionEvent)パラメータは、新しい録音セッションの開始、または既存の録音セッションの更新、削除、または切り取りを通知します。 列挙値:

    • STARTED
    • UPDATED
    • ENDED
    • DELETED
    • PRUNED
  • eventAction(storageThresholdEvent)パラメータは、ストレージ ディスク容量が指定したしきい値に達するたびに送信されます。

  • eventAction(tagEvent)パラメータは、新しいタグの追加、または既存のタグの更新や削除を通知します。 列挙値:

    • ADDED
    • DELETED

eventType

  • 出力文字列。

  • 対応する MediaSense API にトリガーされるイベント。

  • 列挙値:

    • SESSION_EVENT

    • STORAGE_THRESHOLD_EVENT

    • TAG_EVENT

fieldConditions

  • 文字列の必須入力アレイ。

  • 呼び出されたフィールドに指定された条件。

  • フィールド名に対して複数の条件を指定します。

  • fieldOperator、fieldValues、および fieldConnector の詳細が含まれます。

  • このパラメータを使用する API によって列挙値は異なります。

fieldConnector

  • アレイ内に 1 個のフィールドがある場合のオプション入力文字列。

  • アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列。

  • 継続的条件により条件を論理接続するために使用します。

  • 列挙値:

    • かつ
    • または

fieldName

  • 必須の入力文字列。

  • 呼び出されたフィールドの名前。

  • このパラメータを使用する API によって列挙値は異なります。

fieldOperator

  • 必須の入力文字列。

  • [Each fieldOperator] セクションの [Values Expected] において指定された論理演算子の条件。

  • 各演算子のオペランドの許容数:

    • equals = 1
    • contains = 1
    • startsWith = 1
    • endsWith = 1
    • lessThan = 1
    • greaterThan = 1
    • between = 2(境界値を含む)
    • 例:11 ~ 14 には、11、12、13、および 14 が含まれます。 特別な否定演算子(! )* を AND および OR 以外のすべての演算子に追加して、それらの意味を否定できます。 例:
      • 「equals」は「!equals」により否定されます。
      • 「between」は「!between」により否定され、A ~ B の外側にあるすべて値を意味します。

fieldValues

  • 文字列の必須入力アレイ。

  • このアレイに渡される値の数は、[Each fieldOperator] セクションの [Values Expected] で指定された fieldOperator によって異なります。

  • 正規表現は使用できません(* や + など)。

  • このパラメータを使用する API によって列挙値は異なります。

firstName

  • 出力文字列。

  • Finesse エージェント デスクトップにログインしているエージェントの名。

forwardedEvent

  • イベントが MediaSense サーバでローカルに生成された場合、および転送が無効の場合は省略されます。

  • MediaSense 導入では、デフォルトで無効になっています。

  • 列挙値:

    • TRUE = 有効
    • FALSE(デフォルト) = 無効

httpUrl

  • リリース 10 では廃止になり、mp4Url が導入されます。

  • 出力文字列。

  • セッションの HTTPS リンク。

  • セッション状態が CLOSED_NORMAL の場合にのみ URL が存在します。

  • 最大文字数は 512 文字です。


    (注)  


    変換された mp4 と wav ファイルは、作成後または最終変更後 2 時間以内にシステムにより削除されます。


isConference

  • 出力ブール。

  • 参加者オブジェクト内で使用されます。

  • 参加者が会議ブリッジまたは個々のデバイスであるかどうかを示します。


    (注)  


    特定のケースでは、1 人の参加者が会議ブリッジを代表することもあります。


jobDuration

  • getJobById または getJobResult を使用する場合の出力整数。

  • getJobs を使用する場合のオプション入力整数。

  • jobStartTime からこのジョブが終了するまでの時間(ミリ秒単位)。

jobId

  • getJobs を使用する場合のオプション入力文字列。

  • 他のすべての API またはイベントを使用する場合の出力文字列。

  • ジョブ管理フレームワークにより作成および管理されるジョブ。

  • システムが生成。

  • ジョブ管理およびジョブ クエリー API とともに使用します。

jobState

  • getJobById または getJobResult を使用する場合の出力文字列。

  • getJobs を使用する場合のオプション入力文字列。

  • ジョブ ステータスを取得した後、ポーリング時の値に基づいて適切な値がデータベースから取得されます。

jobs

  • ジョブ オブジェクトの出力アレイ。

  • ジョブのリスト。

  • 各ジョブの詳細。

jobStartTime

  • getJobById または getJobResult を使用する場合の出力整数。

  • getJobs を使用する場合のオプション入力整数。

  • 1970 年 1 月 1 日 GMT からジョブの開始までに経過した時間(ミリ秒単位)。

  • ジョブの実行が開始される時刻。

jobType

  • getJobById または getJobResult を使用する場合の出力文字列。

  • getJobs を使用する場合のオプション入力文字列。

  • ジョブの目的。

  • 大文字と小文字を区別します。

  • 列挙値は BULK_DELETE_SESSIONS です。

lastName

  • 出力文字列。

  • Finesse エージェント デスクトップにログインしているエージェントの姓。

limit

  • 必須の入力整数。

  • 返されるレコード数(指定したオフセットから数えます)。

  • pageParameters 内で必須です。

  • オフセット パラメータと併用する必要があります。

  • デフォルトでは、最初の 100 件のレコードを返します。

  • ゼロ(0)より大きな正の値。

  • このパラメータの最大値は 1000 です。

lineDisplayName

  • 出力文字列。

  • 電話機に表示される発信側の名前。Cisco Unified Call Manager Administration の [Directory Number Configuration] ウィンドウの [Display(Caller ID)] フィールドに入力されます。

loginId

  • 出力文字列。

  • Finesse エージェント デスクトップにログインしているエージェントのログイン ID。

loginIdDomain

  • 出力文字列。

  • Finesse エージェント デスクトップにログインしているエージェントのログイン ID のドメイン。

loginName

  • 出力文字列。

  • Finesse エージェント デスクトップにログインしているエージェントのログイン名。

maxSessionStartDate

  • オプション入力整数。

  • minSessionStartDate に固有の値がない場合に必須の入力整数です。

  • 1970 年 1 月 1 日 GMT からセッション録音の開始まで、より正確にはこのセッションの最初のトラックが録音を開始するまでに経過した時間(ミリ秒単位)。

  • minSessionStartDate または maxSessionStartDate が欠落している場合、その方向に 2 時間と見なされます。

mediaType

  • 出力文字列と必須入力文字列。

  • 作成中のメディアのタイプを示します。

  • 大文字と小文字を区別します。

  • 列挙値は次のとおりです。

    • AUDIO

    • VIDEO

mediaStreams

  • メディア タイプの必須入力アレイ。

  • 作成中のメディア ストリーム。

  • 各ストリームはメディア タイプです。

  • mediaStreams はメディア タイプのアレイです。

  • 録音には、少なくとも 1 個のメディア ストリームが必要です。

  • アレイは順序付けされていません。

minSessionStartDate

  • オプション入力整数。

  • 1970 年 1 月 1 日 GMT からセッション録音の開始まで、より正確にはこのセッションの最初のトラックが録音を開始するまでに経過した時間(ミリ秒単位)。

  • minSessionStartDate または maxSessionStartDate が欠落している場合、その方向に 2 時間と見なされます。

mp4Url

  • 出力文字列。

  • セッションの mp4 リンク。

  • 最大文字数は 512 文字です。

  • mp4Url は、セッション状態が CLOSED_NORMAL の場合のみ存在し、次の HTTPS 応答コードを返すことがあります。

    • 200 OK
    • 404 Not Found
    • 500 Internal Server Error
    • 503 Service Unavailable(Cisco MediaSense メディア サービスが使用できない場合)セッションは、URL への最初のアクセス時に mp4 に 変換されます。これにより、結果が最初に返される前に遅延が生じることがあります。

    (注)  


    URL へのアクセス時に Mp4 ファイルが生成され、しばらくの間キャッシュされます。 ファイルを生成する必要がある場合、この URL 要求が応答する前に遅延が生じることがあります。

    変換された mp4 ファイルは、作成後または最終変更後 2 時間以内にシステムによって削除されます。


nodeId

  • 出力整数。

  • システムにより定義された数値。

nodeIPAddress

  • 出力文字列。

  • Cisco MediaSense サーバの IP アドレス。

  • 最大文字数は 54 文字です。

offset

  • オプション入力整数。

  • pageParameters 内の必須の入力整数になります。

  • 返される最初のレコード。

  • limit パラメータと併用する必要があります。

  • ゼロ(0)から始まる整数値。

order

  • オプション入力文字列。

  • sortParameters 内の必須の入力文字列になります。

  • 大文字と小文字を区別します。

  • 列挙値は次のとおりです。

    • ASC= Ascending:最小値を最初にして結果を並べ替えます。
    • DESC=Descending:最大値を最初にして結果を並べ替えます。

pageParameters

  • オプション入力。

  • JSON オブジェクト。

  • クライアントが要求結果表現の特定のサブセットを要求できるようにします。

  • 返すための要素を指定します。

  • これを使用すると、最初の 1000 セッションを返します。

  • limit パラメータおよび offset パラメータも指定する必要があります。

paramConnector

  • アレイにフィールドが 1 つしかない場合のオプション入力文字列。

  • アレイに 2 つ以上のフィールドがある場合に必須の入力文字列。

  • 大文字と小文字を区別します。

  • RequestParameters のアレイで 2 個の要素間の論理接続を指定します。

  • 列挙値は次のとおりです。

    • かつ
    • または

partition

  • 出力文字列。

  • 記憶域を使用するデータストアの名前。

  • 最大文字数は 128 文字です。

participantDuration

  • 出力整数。

  • セッション内で参加者がアクティブだった期間(ミリ秒単位)。


    (注)  


    この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。

participantInformation

  • 参加者情報の出力 JSON アレイ。

  • 情報には、loginId、lastName、firstName、loginIdDomain、および loginName パラメータの詳細が含まれます。

参加者

  • 参加者オブジェクトの出力 JSON アレイ。

  • 各オブジェクトには、deviceRef、participantStartDate、participantDuration、isConference、および xRefCi パラメータの詳細が含まれます。

participantStartDate

  • 出力整数。

  • 1970 年 1 月 1 日 GMT からこのトラックの録音が開始されるまでに経過した時間(ミリ秒単位)。

rtspUrl

  • 出力文字列。

  • 複数のトラックを含むことができるセッション全体への参照。

  • 特定のトラックにアクセスするには、rtspUrl の末尾に「-TRACK0」または「-TRACK1」を追加してください。 特定のセッションのトラックは同時に開始および終了します。

  • URL はセッション継続中は一定です。

  • 最大文字数は 512 文字です。

  • 列挙値は次のとおりです。

    • eventAction = STARTED/UPDATED である場合、rtspUrl = monitor(現在録音されているストリームのモニタリングに使用)です。
    • eventAction = ENDED の場合、rtspUrl = play(保存されたメディアの再生に使用)です。

sessions

  • セッション オブジェクトの出力 JSON アレイ。

  • 各オブジェクトには、sessionId、トラック、URL、sessionStartDate、および sessionDuration の値が含まれます。

sessionDuration

  • 出力整数。

  • セッションが継続した時間(ミリ秒単位)。


    (注)  


    この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。

sessionId

  • セッションのシステム生成識別子です。

  • すべての MediaSense サーバにわたり一意で、最大文字数は 128 です。 セッションは、1 個のセッションが 1 個の MP4 ファイルに変換されるキャプチャ サービスの単位です。

  • セッションは、1 個のセッションが 1 個の MP4 ファイルに変換されるキャプチャ サービスの単位です。

  • startRecording、stopRecording、addSessionTag、convertSession および getSessionBySessionId に必須の入力文字列。

  • 残りの API とイベントの出力文字列。

sessionIdList

  • 複数のカンマ区切りの sessionIds のリストを受け入れます。ただし、現在、最初の sessionId だけが強く関連した sessionIds を返します。

  • 追加の sessionIds は無視されます。

  • 今後の機能拡張のための List タイプで構成されています。

sessionStartDate

  • すべての API とイベントの出力整数。

  • getSessions に必須の入力整数。

  • 1970 年 1 月 1 日 GMT からセッション録音の開始まで、より正確にはこのセッションの最初のトラックが録音を開始するまでに経過した時間(ミリ秒単位)。

sortParameters

  • オプション入力 JSON アレイ。

  • 返された結果の並べ替え方法を指定します。

  • デフォルトの並べ替えは startDate に基づいて新しいセッションを最初に配置します。

sessionState

  • 出力文字列。

  • セッションのステート。

  • 列挙値は次のとおりです。

    • ACTIVE = セッション内の少なくとも 1 個のセッションがアクティブです。
    • CLOSED_NORMAL = セッション内のすべてのセッションがエラーなしで閉じられます。
    • DELETED = ユーザにより削除されたセッションまたはシステムにより切り取られたセッション
    • CLOSED_ERROR = セッション内の少なくとも 1 個のセッションにエラーがあります(録音不可)。

subscriptionFilters

  • 出力 JSON アレイとオプション入力 JSON アレイ。

  • イベントのリストまたはイベント カテゴリのリストを指定します。

  • アレイが使用される API によって意味は異なります。

    1. クライアントが登録するイベント。
    2. unsubscribeFromEvents API 内の場合:
      1. 要求で使用する場合:クライアントが登録を解除するイベント。
      2. 応答で使用する場合:登録解除の実行後もクライアントが登録しているイベント。
    3. クライアントが現在登録しているイベント。 大文字と小文字を区別した列挙値は次のとおりです。* ALL_EVENTS(カテゴリ)
      • RECORDING_EVENTS(カテゴリ)
        • SESSION_STARTED_EVENT
        • SESSION_UPDATED_EVENT
        • SESSION_ENDED_EVENT
      • CLEANUP_EVENTS(カテゴリ)
        • SESSION_DELETED_EVENT
        • SESSION_PRUNED_EVENT
      • TAG_EVENTS(カテゴリ)
        • TAG_ADDED_EVENT
        • TAG_DELETED_EVENT
        • TAG_UPDATED_EVENT
      • STORAGE_EVENTS(カテゴリ)
        • ENTER_LOW_STORAGE_ SPACE_EVENT
        • EXIT_LOW_STORAGE_ SPACE_EVENT
        • ENTER_CRITICAL_STORAGE_ SPACE_EVENT
        • EXIT_CRITICAL_STORAGE_ SPACE_EVENT
        • ENTER_EMERGENCY_STORAGE_ SPACE_EVENT
        • EXIT_EMERGENCY_STORAGE_ SPACE_EVENT

クライアントは、カテゴリ名または特定のイベント名を使用できます。 カテゴリを使用すると、クライアントはそのカテゴリ内のすべてのイベントに登録します。

subscriptionId

  • subscribeToEvents の出力文字列。

  • リスト内の他のすべての API とイベントに必須の入力文字列。

  • subscribeRecordingEvent API から受信したシステム生成 ID です。

subscriptionStatus

  • 出力文字列。

  • verifyEventSubscription API または verifyRecordingSubscription API から受信した応答。

  • 列挙値は次のとおりです。

    • ACTIVE
    • INACTIVE

subscriptionType

  • 出力文字列。

  • サブスクリプションのタイプ。

  • サーバ ベースのクライアントの場合、タイプは HTTP です。

subscriptionUri

  • 必須の入力文字列。

  • イベント通知がサーバ ベースのクライアントに送信される URI。

  • サブスクリプションは subscriptionUri パラメータで制御されます。

  • 特定の subscriptionUri に対してサブスクリプションが 1 件だけ許可されます。

tags

  • タグ オブジェクトの出力 JSON アレイ。

  • 各オブジェクトには、tagName、tagType、tagCreateDate、および tagOffset パラメータが含まれます。

  • 最大文字数は 255 文字です。

tagCreateDate

  • 出力整数。

  • 1970 年 1 月 1 日 GMT からこのタグの作成までに経過した時間(ミリ秒単位)。

tagName

  • 出力文字列。

  • 録音を分類するために使用される大文字と小文字を区別しない名前。

  • 最大文字数は 255 文字です。

  • tagtype = SYSTEM_DEFINED である場合、tagName の列挙値は次のとおりです。

    • タグがセッション レベルにある場合:
      • Pause
      • 再開
    • タグがトラック レベルにある場合:
      • TrackActive
      • TrackInactive

tagNameRegEx

  • オプション入力文字列。

  • タグ イベントだけに適用される Java 正規表現。

  • 付加的文字列です。つまり、イベントがサブスクライバが要求したアクションと一致する場合、および tagName がこのパラメータで指定されたサブスクライバのオプション正規表現と一致する場合に、MediaSense が tagEvent をサブスクライバに送信するだけです。

Java 正規表現の詳細については、http:/​/​download.oracle.com/​javase/​tutorial/​essential/​regex/​ を参照してください。

tagOffset

  • addSessionTag のオプション整数。

  • このタグのセッション開始から経過した時間(ミリ秒単位)。

  • tagOffset を使用して、録音のポイントを指定します。 たとえば、特定の録音開始から 10 秒後に、予期せぬイベントが発生します。 これは、リスト内の他のすべての API とイベントの出力整数です。

  • オフセットはセッションまたはトラックの最初から計算されます(トラック レベルまたはセッション レベルにあるタグは関係ありません)。

  • オフセットが指定されていない場合、タグはセッション内の特定のポイントではなく、セッション全体に適用されます。

tagType

  • 出力文字列。

  • 列挙値は次のとおりです。

    • SYSTEM_DEFINED = デフォルト。 ユーザによりトリガーされたシステム イベントに使用されます(一時停止と再開、TrackInactive および TrackActive)。
    • USER_DEFINED = ユーザはタグ(addSessionTag API)を作成できます。 ただし、すべてのタグ タイプはシステム定義され、ユーザは tagType の値を再定義できません。

trackDuration

  • 出力整数。

  • トラックが継続した時間(ミリ秒単位)。


    (注)  


    この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。

trackMediaType

  • 出力整数。

  • 列挙値は次のとおりです。

    • AUDIO
    • VIDEO

trackNumber

  • 出力整数。

  • システムで生成されるトラックの一意の識別子。

Unified Communications Manager の場合、トラック 0 には分岐デバイスからストリーミングされたメディアが含まれ、トラック 1 には分岐デバイスへストリーミングされるメディアが含まれます。

Unified Comminications Manager の sessionEvent では、各トラックは各トラックのメディアを生成している 1 人以上の参加者に関連付けられます。

Unified Border Element の場合、trackNumber の割り当ては任意であり、分岐デバイスに基づいていません。 要素がトラック アレイに表示される順番は任意のものであり、とくに意味はありません。

tracks

  • トラック オブジェクトの出力 JSON アレイ。

  • 各オブジェクトには、trackNumber、trackStartDate、trackDuration、trackMediaType、および participants パラメータに関する情報が含まれます。

trackStartDate

  • 出力整数。

  • 1970 年 1 月 1 日 GMT からトラック録音の開始(コール制御サービスが Unified Communications Manager または Unified Border Element から 200 件の OK メッセージを受信した時)までに経過した時間(ミリ秒単位)。

  • MediaSense はそれに従って Unified Communications Manager または Unified Border Element に確認応答(ACK)を返します。

urls

  • 出力 JSON オブジェクト。

  • httpUrl および rtspUrl パラメータの情報が含まれます。

wavUrl

  • 出力文字列。

  • セッションの wav リンク。

  • 最大文字数は 512 文字です。

  • ビデオ トラックも含むセッションの場合、wavUrl にはオーディオ トラックのみが含まれます。

  • wavUrl はセッション状態が CLOSED_NORMAL である場合のみ存在し、次の HTTPS 応答コードを返すことがあります。

    • 200 OK
    • 404 Not Found
    • 500 Internal Server Error
    • 503 Service Unavailable(MediaSense メディア サービスが使用できない場合)

    (注)  


    URL へのアクセス時に Wav ファイルが生成され、しばらくの間キャッシュされます。 ファイルを生成する必要がある場合、この URL 要求が応答する前に遅延が生じることがあります。

    変換された wav ファイルは、作成後または最終変更後 2 時間以内にシステムによって削除されます。


xRefCi

  • getSessionsByCCID を除く出力文字列。これは出力文字列とオプション入力文字列の両方です。

  • 特定のメディア ストリームに対する Unified Communications Manager 識別子。

  • 録音トラックと常に 1 対 1 で対応しているわけではありません。 ただし、この識別子を使用して、Unified Communications Manager JTAPI イベントを録音セッションに関連付ける必要があります。

  • xRefCi は、セッションの callControllerType が「Cisco-SIPGateway」または「Cisco-Unified Communications Manager」である場合に存在します。callControllerType が「direct」の場合、xRefCi は省略されます。

  • Unified Border Element はこの識別子を使用しません。