Cisco MediaSense 開発者ガイド リリース 11.0(1)
セッション管理 API
セッション管理 API

セッション管理 API

はじめに

コンタクト センターまたは音声分析環境では、スーパーバイザ、エージェント、音声分析システムは、場合によっては、記録中の、またはすでに記録されているセッションにタグを追加する必要があります。 あるいは、一部のセッションを削除したり、保存して削除を防いだりすることで、セッション録音を効率的に管理する必要があります。

MediaSense はセッション管理 API を利用し、こうした管理機能を提供します。 これらの API を使用し、サードパーティ クライアントは 1 回に 1 つずつ、または一括でセッションにタグを追加したり、セッションからタグを削除したりできます。 クライアントはまた、mp4 や wav などのサポートされる形式にセッションを変換し、MediaSense システム上の事前に指定した場所に移動できます。


(注)  


アクティブなセッション録音と完了したセッション録音の両方でタグを追加したり、削除したりできますが、セッション録音自体は完了しているものだけ削除できます。 同様に、アクティブまたはエラー状態にあるセッションは変換できません。


addSessionTag

この API を使用し、終了(すでに記録されている)セッションまたはアクティブ(現在、記録中)セッションにタグを追加します。 タグは、録音にラベルを付けるためにユーザが割り当てる名前です。


(注)  


シスコでは、タグを追加するとき、各タグの先頭に接頭辞とコロン(:)を含め、タグを挿入するアプリケーションを特定できます。 たとえば、CCX アプリケーションによって挿入されるタグの接頭辞は「CCX:」です。 この規則に従うことで、複数の非依存クライアント アプリケーションが、互いに意味のある、または混乱させるタグ名を不注意で挿入せずに MediaSense にタグを挿入できます。


URI

https://<host>:<port>/ora/managementService/manage/addSessionTag

パラメータ

  • sessionId:必須入力文字列。 セッションのシステム生成識別子です。 共有パラメータを参照してください。

  • tagName:出力文字列。 録音を分類するために使用される大文字と小文字を区別しない名前。 共有パラメータを参照してください。

  • tagOffset:オプション整数。 タグのセッション開始から経過した時間(ミリ秒単位)。 共有パラメータを参照してください。

関連イベント

tagEvent:タグがセッションに追加またはセッションから削除された場合にイベントが送信されます。 詳細については、tagEventを参照してください。

HTTPS POST:

https://10.10.10.10:8440/ora/managementService/manage/
addSessionTag

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{
   "requestParameters":
                {
                    "sessionId": "AMS_10.194.118.56_1283550575777_2",
                    "tagName": "Sample tag",
                    "tagOffset": 10
               }
}

応答:

{
     "responseMessage":"Success: Your request was successfully completed.",
     "responseCode":2000
}

convertSession (廃止)

この API を使用し、要求で指定された形式に MediaSense セッションを変換します。 要求が成功した場合、変換されたファイルのリンクの一覧を応答で受け取ります。


(注)  


MediaSense セッションが要求の形式で存在する場合、既存のリンクが返されます。 新しいリンクはシステムに作成されません。 MediaSense セッションがアクティブまたはエラー状態にある場合、そのセッションは変換できません。

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


URI

https://<host>:<port>/ora/managementService/manage/convertSession

HTTP メソッド

POST

パラメータ(Parameters)

  • convertedLink:出力文字列。 これらの文字列は convertSession API の一部として生成されます。 URL のカンマで区切られたリスト。 各 URL はセッションのオーディオ録音を指します。 すべての値が文字列を構成します。

  • convertedFormat:入力文字列。 MediaSense セッションを変換する形式です。 列挙値は MP4 です。

  • sessionId:必須入力文字列。 セッションのシステム生成識別子です。 共有パラメータを参照してください。

例 1

HTTPS POST:

https://10.10.10.10:8440/ora/managementService/manage/
convertSession

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{ "requestParameters":
     {
         "sessionId": "AMS_10.10.10.10_1283550575777_2",
         "conversionFormat": "mp4"
     }
}

応答:

{
    "responseMessage":"Success: Your request was successfully completed.",
    "responseCode":2000,
    "responseBody":
        {
            "convertedLink":"http://10.10.10.10:8080/
             oramedia/mp4/Session-1-10.10.10.10-
             1283811989534.mp4"
        }
}

例 2 - システム容量超過

HTTPS POST:

 https://10.10.10.10:8440/ora/managementService/manage/
convertSession

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{ "requestParameters":
     {
         "sessionId": "AMS_10.10.10.10_1283550575777_2",
         "conversionFormat": "mp4"
     }
}

応答:

{
    “responseCode”: 5006,
    “responseMessage”: “Failure: Unable to convert the session. Try again later.”,
    "detail": "Capacity Exceeded"
}

deleteSessions

この API を使用し、指定したセッション ID に基づいて記録されたセッションを削除します。


(注)  


アクティブなセッションは削除できません。

成功した応答の jobId パラメータがジョブ クエリー API で使用され、ジョブのステータスと結果を取得します。


URI

https://<host>:<port>/ora/managementService/manage/deleteSessions

HTTP メソッド

POST

パラメータ(Parameters)

  • jobId:出力文字列。 システム生成 ID です。 共有パラメータを参照してください。

  • sessionIds:入力パラメータ。 セッション ID のリストです。

複数の録音を削除するには:

HTTPS POST:

https://10.194.118.64:8440/ora/managementService/manage/
deleteSessions

ヘッダー:

Content-Type: application/json

ボディ:

{
    "requestParameters": {
        "sessionIds": [
            "4ed31387d58902d1",
            "4ed31387d58923a3"
        ]
    }
}

応答:

 {
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "abcd1234"
}

deleteSessionTag

この API を使用し、セッションからタグを削除します。 タグは、録音にラベルを付けるためにユーザが割り当てる名前です。 ラベルまたはタグが必要なくなったら、この API を使用してこのセッションから削除します。 tagName パラメータと tagOffset パラメータはタグに対して一意です。 録音を削除するときは、(addSessionTag API を使用して)作成されたタグと同じ名前とオフセット フィールドが使用されていることを確認します。 タグを削除すると、この操作は元に戻すことができません。 ただし、タグ名とオフセット フィールドを指定し、セッションにタグを再追加できます。

URI

https://<host>:<port>/ora/managementService/manage/deleteSessionTag

HTTP メソッド

POST

パラメータ

  • sessionId:出力文字列。 セッションのシステム生成識別子です。 共有パラメータを参照してください。

  • tagName:出力文字列。 録音にラベルを付けるために使用される名前です。 共有パラメータを参照してください。

  • tagOffset:出力整数。 オフセットはセッションまたはトラックの最初から計算されます。 共有パラメータを参照してください。

関連イベント

tagEvent:タグがセッションに追加またはセッションから削除された場合にイベントが送信されます。 詳細については、tagEventを参照してください。

HTTPS POST:

https://10.78.95.207:8440/ora/managementService/manage/
deleteSessionTag

ヘッダー:

Content-Type: application/json
JSESSIONID: <the jsessionId received from a signIn request>

ボディ:

{
   "requestParameters":
                {
                		"sessionId": "3212d734fd0a71",
                  "tagName": "demo",
				              "tagOffset": 10
               }
}

応答:

{
     "responseMessage":"Success: Your request was 
      successfully completed.",
     "responseCode":2000
}