Cisco MediaSense 開発者ガイド リリース 10.5(1)
API のリスト
API のリスト

API のリスト

ユーザ認証

これらの API を使用し、ユーザを認証します。 他の API を使用するには、先にサインインする必要があります。 この signIn API は、認証するすべての後続要求で使用する JSESSIONID を返します。 要求がブラウザから発信される場合、そのブラウザが自動的にクライアントのセッションを処理します。

JSESSIONID は、ユーザがログアウトしたときか、または非アクティブになってから 30 分後(いずれか早いほう)に期限切れになります。

signIn

説明: ユーザ認証/サインインにはこの API を使用します。 signIn が成功した場合、JSESSIONID は HTTP 応答のヘッダーで返されます。 この JSESSIONID は認証のトークンとして機能し、後続のすべての要求で渡す必要があります。 JSESSIONID は、ユーザがサインアウトするか、非アクティブになってから 30 分経過すると期限切れになります(いずれか早いほう)。
API URI: https://<host>:<port>/ora/authenticationService/authentication/signIn
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
         "username": "<replace with your string>",
         "password": "<replace with your string>" 
          },
         "authenticationProviders": ["<replace with your string>", 
         "<replace with your string>",...]                      
}
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 1.5 で変更(下の注記を参照)。

リリース: 8.5(1)
注:

API ユーザのパスワードが Unified Communications Manager で変更されたとき、MediaSense でその変更が反映されるまで数分かかる場合があります。 成功応答は、cookie 内で JSESSIONID も返します。

この JSESSIONID はセッション ID であり、後続要求の認証手段として機能します。

リリース 10.0、バージョン 1.5 で次の変更が導入されました。

  • 新しい要求パラメータが導入されました(「パラメータの説明」を参照してください)。

    • authenticationProviders

例:

例 1

ポート 8440 でサーバ 10.194.118.1 にユーザ名「myUser」とパスワード「cisco」でユーザをサインインするには:

認証プロバイダーが指定されていないため、この要求は、AXL と Finesse を含む、考えられるすべての構成済み認証プロバイダーに対して認証を試みます。

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signIn 

ヘッダー:

Content-Type: application/json

ボディ:

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                      }
}

例 2

ポート 8440 でサーバ 10.194.118.1 にユーザ名「myUser」とパスワード「cisco」で Finesse スーパーバイザをサインインするには:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signIn 

ヘッダー:

Content-Type: application/json

ボディ:

{
   "requestParameters": {
                            "username":"myUser",
                            "password":"cisco"
                        },
                      "authenticationProviders": ["FINESSE"]

}

signOut

説明: この API はユーザをサインアウトするために使用されます。 ユーザはサインアウトするために JSESSIONID 以外のパラメータを必要としません。
API URI: https://<host>:<port>/ora/authenticationService/authentication/signOut
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ: なし
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
)
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用できます。
リリース: 8.5(1)
例:

前にサインインしたユーザーをサインアウトするには:

HTTPS POST:

https://10.194.118.1:8440/ora/authenticationService/
authentication/signOut

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

Content-Type: application/json

JSESSIONID で識別されたユーザがサインアウトされます。

イベント サブスクリプション

subscribeToEvents

説明: 以下のようなイベント通知を受信するのにこの API を使用します。録音が開始した、録音が終了した、録音データが更新された、録音にタグが追加された、録音からタグが削除されたときなど。 すべてのイベント、特定のカテゴリのイベント、特定の種類のイベントをサブスクライブできます。
API URI: https://<host>:<port>/ora/eventService/event/subscribeToEvents
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
If this subscription is for server-based clients, set the 
client's subscriptionType parameter to "http" (where it 
should receive events).
{
   "requestParameters": {
                            "subscriptionType" : "<replace with 
                             your string>",
                            "subscriptionUri" : "<replace with 
                             your string>",
                            "subscriptionFilters": ["<replace with 
                             your string>", "<replace with your 
                             string>",...],
                            "tagNameRegEx": "<java-regular-
                             expression>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody" : {
                       "subscriptionId": "<This is a String>",
                       "subscriptionFilters": ["<This is a 
                        String>", "<This is a String>",...],
                       "tagNameRegEx": "<java-regular-expression>"
                     }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類:storageThresholdEvent

イベント アクション:イベント アクション値

提供開始時期:

API バージョン 1.1 以降で使用可能

API バージョン 1.2 で変更

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

リリース: 8.5(2)
注:

同じ subscriptionUri がもう一度サブスクライブされると、既存のサブスクリプション内の subscriptionFilters は新しい subscriptionFilters に置き換えられます。 subscriptionFilters が同じ場合、エラーは生成されません。 2005 の 応答コード が生成され、サブスクリプションが既に存在することが示されます。

リリース 8.5(3)、バージョン 1.2 で次の変更が追加されました。

  • 導入された新しいパラメータ:
    • tagNameRegEx

例:

例 1:

すべてのイベントのイベント通知を受信するには:

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
subscribeToEvents

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionType": "http",
                        "subscriptionUri": "http://10.35.146.157:
                         8085/sessionEvent",
                        "subscriptionFilters": ["ALL_EVENTS"]
                      }
}

応答:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "EXIT_EMERGENCY_STORAGE_SPACE_EVENT",
            "TAG_ADDED_EVENT",
            "TAG_DELETED_EVENT",
            "TAG_UPDATED_EVENT",
            "SESSION_STARTED_EVENT",
            "SESSION_ENDED_EVENT",
            "EXIT_LOW_STORAGE_SPACE_EVENT",
            "EXIT_CRTITICAL_STORAGE_SPACE_EVENT",
            "ENTER_CRTITICAL_STORAGE_SPACE_EVENT",
            "ENTER_LOW_STORAGE_SPACE_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_DELETED_EVENT",
            "ENTER_EMERGENCY_STORAGE_SPACE_EVENT",
            "SESSION_PRUNED_EVENT"
        ],
        "subscriptionId": "3oV6jCEnJUlGYZo8"
    }
}

例 2

TAG_EVENTS のみに対してイベント通知を受信するには:

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
subscribeToEvents

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionType": "http",
                        "subscriptionUri": "http://10.35.146.157:
                         8085/sessionEvent",
                        "subscriptionFilters": ["TAG_EVENTS"]
                      }
}

応答:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "TAG_ADDED_EVENT",
            "TAG_DELETED_EVENT",
            "TAG_UPDATED_EVENT"
        ],
        "subscriptionId": "D52C4aeXISTURzM7"
    }
}

unsubscribeFromEvents

説明: 録音イベントの受信を停止するには、この API を使用します。
  • 「subscriptionFilters」パラメータを持たない要求は、クライアントを完全に登録解除し、サブスクリプションを終了します。
  • 「subscriptionFilters」パラメータを持つ要求は、サブスクリプションから指定されたフィルタのみを削除し、サブスクリプション全体はアクティブなままです。 サブスクライブされているフィルタがない場合は、「subscriptionFilters」パラメータが指定されていないときとまったく同じように、サブスクリプション全体が削除されます。
  • イベント タイプが残っている限り、応答には残りのサブスクリプション フィルタのリストが含まれます。
API URI: https://<host>:<port>/ora/eventService/event/unsubscribeFromEvents
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                            "subscriptionId" : "<replace with 
                             your string>",
                            "subscriptionFilters": ["<replace with 
                             your string>", "<replace with your 
                             string>",...]
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"
 }
{
    "responseCode": 2006,
    "responseMessage": "Success: The current subscription has been 
                        updated and you have been unsubscribed 
                        from the subscriptionFilters requested.
                        The subscription is still active.",
    "responseBody": {
                       "subscriptionFilters": ["<This is a String>",
                       "<This is a String>",...]
                    },
    "tagNameRegEx": "<java-regular-expression>"
 }
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

API バージョン 1.1 以降で使用可能

API バージョン 1.2 で変更

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

リリース: 8.5(2)
注:

リリース 8.5(3)、バージョン 1.2 で次の変更が導入されました。

  • 導入された新しいパラメータ:

    • tagNameRegEx

例:

例 1

あらゆるイベントのイベント通知の受信を停止するには(すべてのイベントをアンサブスクライブする):

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
unsubscribeFromEvents

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1",
                        "subscriptionFilters":[ALL_EVENTS]
                      }
}

または

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1"
                      }
}

応答:

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

例 2

クライアントは現在、RECORDING_EVENTS および CLEANUP_EVENTS に登録されており、今、CLEANUP_EVENTS からは登録解除しようとしているが、RECORDING_EVENTS への登録は維持したい。

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
unsubscribeFromEvents

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1",
                        "subscriptionFilters":[CLEANUP_EVENTS]
                      }
}

応答:(まだサブスクライブされているフィルタについてクライアントに伝えます。)

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "SESSION_STARTED_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_ENDED_EVENT"
        ]
    }
}

verifyEventSubscription

説明: イベント受信への登録がアクティブかどうかを確認するには、この API を使用します。
API URI: https://<host>:<port>/ora/eventService/event/verifyEventSubscription
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                            "subscriptionId": "<this is a string>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
                       "subscriptionStatus":"<this is a String>",
                       "subscriptionFilters": ["<this is a String>",
                       "<this is a String>",...],
                       "tagNameRegEx": "<java-regular-expression>"
                    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

API バージョン 1.1 以降で使用可能

API バージョン 1.2 で変更

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

リリース: 8.5(2)
注:

subscriptionStatus は、サブスクリプションがあるかどうかによって、ACTIVE または INACTIVE になります。

MediaSense はイベント カテゴリに関してサブスクリプションを保存しません。 カテゴリは eventTypes の対応するリストに常に展開され、そこで保存されます。 したがって subscriptionFilters 内に含まれる文字列のリストは常に、eventTypes のリストで、決してカテゴリ名は含まれません。

リリース 8.5(3)、バージョン 1.2 で次の変更が導入されました。

  • 導入された新しいパラメータ:
    • tagNameRegEx

例:

例 1

すべての RECORDING_EVENTS を受け取るように現在登録されていると想定し、その登録がアクティブであることを確認するには、次の API を使用します。

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
verifyEventSubscription

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI1"
                      }
}

応答:

{
    "responseMessage": "Success: Your request was successfully 
     completed.",
    "responseCode": 2000,
    "responseBody": {
        "subscriptionFilters": [
            "SESSION_STARTED_EVENT",
            "SESSION_UPDATED_EVENT",
            "SESSION_ENDED_EVENT"
        ],
        "subscriptionStatus": "ACTIVE"
    }
}

例 2

INACTIVE のサブスクリプションを確認します。

HTTPS POST:

https://10.194.118.1:8440/ora/eventService/event/
verifyEventSubscription

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "subscriptionId": "sN7DASoAArHmDfI2"
                      }
}

応答:

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

subscribeRecordingEvent(非推奨)

説明: 以下のようなイベント通知を受信するのにこの API を使用します。録音が開始した、録音が終了した、録音データが更新された、録音にタグが追加された、録音からタグが削除されたときなど。
API URI: https://<host>:<port>/ora/eventService/event/subscribeRecordingEvent
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
If this subscription is for server-based clients, set the 
client's subscriptionType parameter to "http" (where it 
should receive events).
{
   "requestParameters": {
                            "subscriptionType" : "<this is a 
                             string>",
                            "subscriptionUri" : "<this is a 
                             string>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "subscriptionId": "abcd1234",
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "subscriptionId": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類:storageThresholdEvent

イベント アクション:イベント アクション値

提供開始時期: API バージョン 1.0 以降で使用できます。

API バージョン 1.1 では非推奨、代わりに subscribeToEvents を使用します。

リリース: 8.5(1)
注: 同じ subscriptionUri がもう一度登録されると、エラーが返されます。その中には元の subscriptionId が含まれます。

unsubscribeRecordingEvent(非推奨)

説明: 録音イベントの受信を停止するには、この API を使用します。
API URI: https://<host>:<port>/ora/eventService/event/unsubscribeRecordingEvent
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                            "subscriptionId" : "<this is a string>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"

}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能

API バージョン 1.1 では非推奨、代わりに subscribeToEvents を使用します。

リリース: 8.5(1)
注: なし

verifyRecordingSubscription(非推奨)

説明: 録音サブスクリプションがアクティブかどうかを確認するには、この API を使用します。
API URI: https://<host>:<port>/ora/eventService/event/verifyRecordingSubscription
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                            "subscriptionId": "<this is a string>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "subscriptionStatus":"ACTIVE"

}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能

API バージョン 1.1 では非推奨、代わりに verifyEventSubscription を使用します。

リリース: 8.5(1)
注: subscriptionStatus は、サブスクリプションがあるかどうかによって、ACTIVE または INACTIVE になります。

ジョブ管理

ジョブを作成するか、またはキャンセルするために、これらの API を使用します。 ジョブは 1 つ以上のオペレーションを含むことができ、完了に時間がかかります。 各結果は各オペレーションごとに返されます。 ジョブの目的は、ジョブが完了するまでの間クライアントからサーバへの永続的な接続を必要とせずに、システムがジョブ要求を受け入れ、実行できるようにすることです。

ジョブは処理中に拒否される可能性があるため、最終的に実行できない場合があります。 未完了ジョブを返す応答メカニズムはありません。 ジョブ ステータスとオペレーション結果を取得するには、Job Query API を使用します。

cancelJob

説明: 既に進行中のジョブをキャンセルするには、この API を使用します。 この API は、ジョブの実行を停止するだけです。 データベースからジョブを削除するには、deleteJob API を使用します。
API URI: https://<host>:<port>/ora/eventService/manage/cancelJob
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
    "requestParameters": {
        "jobId": "<replace with your string>"
    }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

この API は、処理中のジョブをキャンセルします。 ジョブが RUNNING 状態でない場合、現在のジョブの状態とともに失敗エラー コードを返します。

例:

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/cancelJob

ヘッダー:

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

ボディ:

{
 "requestParameters": {
 "jobId": "123456789"
 }
}

応答:

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

createJob

説明: 完了するまでに時間がかかるジョブ用のバッチ処理を作成する場合に、この API を使用します。 結果は各オペレーションに返されます。
API URI: https://<host>:<port>/ora/eventService/manage/createJob
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
       "jobType": "<replace with your string>",
       "jobParameters": "<replace with your string>"
    }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}
失敗した JSON 応答スキーマ:

 
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

ジョブ状態を参照してください。

deleteJob

説明: データベースからジョブを削除するには、この API を使用します。 この API は、すでに完了した、キャンセルされた、またはエラー状態にあるジョブにのみ適用されます。 ジョブが RUNNING 状態にある場合は、最初に cancelJob API を使用してジョブを停止し、次にそのジョブを削除するために deleteJob API を使用します。 この API は、データベースからジョブの詳細とすべてのジョブの結果を削除します。
API URI: https://<host>:<port>/ora/eventService/manage/deleteJob
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
    "requestParameters": {
        "jobId": "<replace with your string>"
    }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "<this is a string>"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
例:

HTTPS POST:

https://10.194.118.1:8440/ora/managementService/manage/deleteJob

ヘッダー:

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

ボディ:

{
 "requestParameters": { "jobId": "JobId_1" }
 }

応答:

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

ジョブ クエリー

ジョブ管理 API を使用して作成されたジョブの状態および結果を取得するために、これらの API を使用します。

getJobById

説明: jobId を使用して既存のジョブを取得するには、この API を使用します。 成功した JSON 応答のフィールド内で、jobstate、operationsCompleted、operationsRemaining のパラメータ値は、この API が呼び出されたときに取得されます。 この API への 2 回目以降のコールは異なる値が表示されることがあります。
API URI: https://<host>:<port>/ora/eventService/query/getJobById
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:
{        "jobId": "<replace with your string>"    }
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
"responseCode": 2000
"responseMessage": "Successful"”
"responseBody":  {
   "jobs":[{
      "jobType":"<this is a string>",
      "jobDuration":<this is an integer>,
      "jobStartTime":<this is an integer>,
      "jobId":"<this is a string>",
      "jobState":"<this is a string>",
      "operationsCompleted":<this is an integer>,
      "operationsRemaining":<this is an integer>
           }]
  }
}
失敗した JSON 応答スキーマ:

    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

ジョブ状態を参照してください。

例:

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/ 
getJobById?jobId=AMS_10.194.118.1_1282948026491_5

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn request>

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 203567,
                "jobStartTime": 1343333766345,
                "jobId": "AMS_10.194.118.1_
                 1282948026491_5",
                "jobState": "COMPLETED"
            }
        ],
        "operationsCompleted": 2,
        "operationsRemaining": 0
    }
}

getJobResult

説明: 存在するジョブの結果を取得するには、この API を使用します。 「requestParameters」パラメータは、省略可能です。 指定されていない場合、指定されたジョブ ID のすべてのジョブ オペレーションが返されます。 「requestParameters」パラメータで指定されたクエリー フィルタが、指定されたジョブ ID のジョブ オペレーションと一致しない場合、応答には、「jobOperationResultset」パラメータは含まれません。
API URI: https://<host>:<port>/ora/eventService/query/getJobResult
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
    "jobId": "<replace with your string>",
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with 
                     your string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with 
                     your string>"                }
            ],
            "paramConnector": "<replace with your 
             string>"        }
    ],
    "pageParameters": {
        "offset": <replace with your integer>,
        "limit": <replace with your integer>    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>", 
            "order": "<replace with your string>"        }
    ]
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "<this is a string>",
    "responseBody": {
        "job": [
            {
                "jobType":"<this is a string>",
                "jobDuration":<this is an integer>,
                "jobStartTime": "<this is a string>",
                "jobId": "<this is a string>",
                "jobState": "<this is a string>"
            }
        ] ,
        "jobOperationsResultset": [
            {
                "responseCode": <this is an integer>,
                "operationData": "<this is a string>",
                "operationId": "<this is a string>",
                "operationResponse": "<this is a 
                 string>"            },
           {
              ..              ..
            },
            ..
        ]
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

ジョブ状態を参照してください。

例:

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobResult

ヘッダー:

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

ボディ:

{
    "jobId": "AMS_10.27.185.20_1287093966514_162",
    "requestParameters": [
        {
            "fieldName" : "operationResult",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "2000"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "operationResult",
            "order": "ASC"
        }
    ]
}

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "job": {
            "jobType": "BULK_DELETE_SESSIONS",
            "jobDuration": 36005,
            "jobId": "AMS_10.27.185.20_1287093966514_
             162",
            "jobStartTime": 1287171904409,
            "jobState": "COMPLETED"
        },
        "jobOperationsResultset": [
             {
                "responseCode": 2000,
                "operationData": "Session-1-10.194.118.
                 92-1287017042781",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_163",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            },

            {
                "responseCode": 2000,
                "operationData": "Session-11-10.194.118.
                 92-1287178816956",
                "jobOperationId": "AMS_10.27.185.20_
                 1287093966514_164",
                "OperationResponse": "Successful: Your 
                 request was successfully completed."
            }
        ]
    }
}

getJobResult のパラメータの詳細

getJobResult 用の fieldOperators

パラメータ このパラメータに許容された fieldOperators
operationId equals
operationData equals
operationResult equals
operationFailureReason

equals

contains

startsWith

endsWith

getJobResult 用の Enum

パラメータ このパラメータに許可される列挙
byFieldName

operationId

operationData

operationResponse

getJobs

説明: ジョブ パラメータ名のいずれかを使用して既存のジョブを取得するには、この API を使用します。
API URI: https://<host>:<port>/ora/eventService/query/getJobs
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with 
                     your string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with 
                     your string>"
                }
            ],
            "paramConnector": "<replace with your 
             string>"
        }
    ],
    "pageParameters": {
        "offset": <replace with your integer>,
        "limit": <replace with your integer>"    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>",
            "order": "<replace with your string>"
        }
    ]
}
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
"responseCode": 2000
"responseMessage": "Successful"”
"responseBody":  {
   "jobs":[{
      "jobType":"<this is a string>",
      "jobDuration":<this is an integer>,
      "jobStartTime":<this is an integer>,
      "jobId":"<this is a string>",
      "jobState":"<this is a string>"
     }]
  }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>",
    "jobId": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

ジョブ状態を参照してください。

例:

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/
getJobs

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "jobState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "completed"
                    ]
                }
            ]
        }
    ],
    "sortParameters": [
        {
            "byFieldName": "jobId",
            "order": "ASC"
        }
    ]
}

応答:

{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "jobs": [
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 34200,
                "jobStartTime": 1343334076111,
                "jobId": "Job_123",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 44200,
                "jobStartTime":1343334075432,
                "jobId": "Job_234",
                "jobState": "COMPLETED"
            },
            {
                "jobType": "BULK_DELETE_SESSIONS",
                "jobDuration": 43678,
                "jobStartTime": 1343334073567,
                "jobId": "Job_345",
                "jobState": "COMPLETED"
            }
        ]
    }
}

getJobs のパラメータの詳細

getJobs 用の fieldOperators

パラメータ このパラメータに許容された fieldOperators
jobId equals
jobState equals
jobType equals
jobStartTime

between

lessThan

greaterThan

jobDuration

between

lessThan

greaterThan

getJobs の Enum

パラメータ このパラメータに許可される列挙
byFieldName

jobId

jobState

jobType

jobStartTime

jobDuration

録音の制御

これらの API を使用して、進行中(リアルタイム)のセッションの一時停止や再開などの録音制御処理を実行します。

pauseRecording

説明: この API を使用して、セッションの録音を一時停止します。
API URI: https://<host>:<port>/ora/controlService/control/pauseRecording
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                        "sessionId": "<replace with 
                         your string>"
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: tagEvent

イベント アクション: added

提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
例:

現在進行中の録音を一時停止する方法:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
pauseRecording

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "sessionId": "Session-1234.abc.
                         5678"
                      }
}

応答:

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

resumeRecording

説明: この API を使用して、セッションの録音を再開します。
API URI: https://<host>:<port>/ora/controlService/control/resumeRecording
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                        "sessionId": "<replace with 
                          your string>"
                      }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: tagEvent

イベント アクション: added

提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
例:

HTTPS POST:

 https://10.194.118.1:8440/ora/controlService/control/
resumeRecording

ヘッダー:

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

ボディ:

{
   requestParameters: {
                        "sessionId": "Session-1234.abc.
                         5678"
                      }
}

応答:

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

startRecording

説明: この API を使用して MediaSense で電話機にコールし、受信者のオーディオおよびビデオ入力を録音します。
API URI: https://<host>:<port>/ora/controlService/control/startRecording
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                        "deviceRef": "<replace with 
                         your string>",
                        "mediaStreams": 
                            [{
                            "mediaType":
                            "<replace with your string>"
                                        }]
                         }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessionId": "<this is a string>",
        "callControllerIP": "<this is a string>",
        "callControllerType": "<this is a string>",
        "CCID": "<this is a string>",
        "sessionStartDate": "<this is an integer>",
        "sessionDuration": "<this is an integer>",
        "sessionState": "<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>"
            }
        ],
        "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>",
                        "deviceId": "<this is a string>"
                    }
                ]
            }
        ],
        "urls": {
            "httpUrl": "<this is a string>",
            "rtspUrl": "<this is a string>",
            "mp4Url": "<this is a string>",
            "wavUrl": "<this is a string>"

        }
    }
}
失敗した JSON 応答スキーマ:
{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: sessionEvent

イベント アクション: started

提供開始時期:

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

API バージョン 1.2 で変更

API バージョン 1.4 で変更

API バージョン 1.5 で変更

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

リリース: 8.5(1)
注:

この API では、Cisco MediaSense 管理のコール制御サービス プロバイダーを設定し、発信先の電話機がその Unified Communications Manager にアクセスできることが必要です。

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

例:

例 1

deviceRef 1000 を使用したデバイスでオーディオおよびビデオ トラックを含むブログの録音を開始する方法:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
startRecording 

ヘッダー:

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

ボディ:

{
    "requestParameters": {
        "deviceRef": "1000",
        "mediaStreams": [
            {
                "mediaType": "VIDEO"
            },
            {
                "mediaType": "AUDIO"
            }
        ]
    }
}

例 2

deviceRef 1111 を使用したデバイスでオーディオ トラックだけが含まれるブログの録音を開始する方法:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
startRecording 

ヘッダー:

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

ボディ:

{
    "requestParameters": {
        "deviceRef": "1111",
        "mediaStreams": [
            {
                "mediaType": "AUDIO"
            }
        ]
    }
}

stopRecording

説明: この API を使用して、発信コール(startRecording API により開始)の終了後すぐにデバイスの録音を停止します。
API URI: https://<host>:<port>/ora/controlService/control/stopRecording
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{	"requestParameters":
			{
        "deviceRef": "<replace with your string>"
			 }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessionId": "<this is a string>",
        "callControllerIP": "<this is a string>",
        "callControllerType": "<this is a string>",
        "CCID": "<this is a string>",
        "sessionStartDate": "<this is an integer>",
        "sessionDuration": "<this is an integer>",
        "sessionState": "<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>"
            }
        ],
        "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>",
                        "deviceId": "<this is a string>"

                    }
                ]
            }
        ],
        "urls": {
            "httpUrl": "<this is a string>",
            "rtspUrl": "<this is a string>">",
            "mp4Url": "<this is a string>">",
            "wavUrl": "<this is a string>"

        }
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: sessionEvent

イベント アクション: ended

提供開始時期:

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

API バージョン 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
例:

deviceRef 1000 を使用したデバイスで進行中のブログ録音を停止する方法:

HTTPS POST:

https://10.194.118.1:8440/ora/controlService/control/
stopRecording

ヘッダー:

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

ボディ:

{	"requestParameters":
			{
                            "deviceRef": "1000"
			 }
}

launchMediaPlayer

説明:

この API を使用して MediaSense メディア プレーヤーを起動し、特定の録音を再生します。 この API は、ブラウザのプロキシとして機能するサーバ ベースのアプリケーションと連携するように設計されています。ただし、ブラウザから直接呼び出すことも可能です。 アプリケーションがブラウザ クライアントの代わりにこの要求を発行すると、実行のためにそのブラウザに JNLP ファイルを渡します。 それから、ブラウザは直接 MediaSense とやり取りして、プレーヤー アプリケーションをダウンロードし、再生するメディア ストリームを取得します。

API URI:

https://<host>:<port>/ora/controlService/control/launchMediaPlayer

サポートされる応答形式:

正常な応答の場合:application/x-java-jnlp-file

エラーの場合:application/json

HTTP メソッド:

GET

リクエスト パラメータ:

このパラメータは、URL のクエリー セクションで指定する必要があります。

rtspUrl=<ユーザが指定した文字列>

rtspUrl は起動時にメディア プレイヤーで再生するセッションの rtsp URL です。 この URL は、クエリー API(getSessions など)を使用して取得します。 クライアントは、launchMediaPlayer 要求で使用する少し前に MediaSense からこの rtspUrl を取得します。 MediaSense により提供されるすべての URL と同様に、録音されたセッションの rtspUrl は予告なしに随時変更されることがあります。

ヘッダー パラメータ:

signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:

メディア プレーヤー アプレットを起動する JNLP ファイル。

失敗した JSON の応答スキーマ:

{
  "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

なし

提供開始時期:

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

リリース: 10.0(1)
注:

クライアント マシンに Java の特定のバージョンをインストールする必要があります。 Java 要件の詳細については、『MediaSense ユーザ ガイド』の「検索と再生」の項を参照してください。

例:

例 1

メディア プレイヤーの rtspUrl 「13092154564622」でセッションを再生する方法:

HTTPS GET:https://<server>:<port>/ora/controlService/control/

launchMediaPlayer?rtspUrl=rtsp://<server>/archive/2413e6746c8441

ヘッダー:JSESSIONID(前の signIn 要求から受信した jsessionID)

応答:

(注)     

この応答は、説明のみを目的としています。 アプリケーションでこの応答を解析する必要はありません。 Java が正常にインストールされている場合、この応答により JWS を使用したメディア プレイヤー アプレットが自動的に起動されます。

...
Content-type: application/x-java-jnlp-file
...

<?xml version="1.0" encoding="UTF-8"?>
<jnlp codebase="https://<server>:<port>/mediasense/
 " spec="1.0+">
   <information>
      <title>MediaSensePlayer</title>
      <vendor>Cisco Systems</vendor>
      <homepage href="http://www.cisco.com" />
      <description>MediaSensePlayer</description>
      <description kind="short">MediaSensePlayer</description>
   </information>
   <update check="always" />
   <security>
      <all-permissions />
   </security>
   <resources>
      <j2se version="1.7.0_11" />
      <jar href="java/MediaSensePlayer.jar" main="true" />
      <jar href="java/jna-3.4.0.jar" />
   </resources>
   <application-desc main-class="com.cisco.cbabu.videoplayer.
    Main">
      <argument>rtsp://<server>/archive/2413e6746c8441?
       token=HQFmZ0yl2ynton0CvOKMifXwe6gBONLAOeMqaPzw2jTrrbhh
       SjbnjOr2siZJmIIqcg2gJDNsFpMrDheQyUGYveUhDQAwdT6ze6mQeek
       JPhipAhtI15Rrfaackd6r6jlj</argument>
   </application-desc>
</jnlp>

例 2

失敗した応答の例。 (GET 要求が必要な rtspUrl パラメータなしで送信された場合)。

HTTPS GET:https://<server>:<port>/ora/controlService/control/launchMediaPlayer

ヘッダー:JSESSIONID(前の signIn 要求から受信した jsessionID)

応答:

...
Content-type: application/json
...

{
    "responseMessage": "Failure: Missing parameter in message.",
    "responseCode": 4061,
    "detail": "rtspUrl"
}

セッション管理

これらの API を使用し、記録されたセッションを管理します。 これらの API では、タグの追加と削除やセッションの削除などの操作を実行できます。

addSessionTag

説明: この API を使用し、終了(すでに記録されている)セッションまたはアクティブ(現在、記録中)セッションにタグを追加します。 タグは、録音にラベルを付けるためにユーザが割り当てる名前です。
API URI: https://<host>:<port>/ora/managementService/manage/addSessionTag
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters":
                {
                "sessionId": "<replace with your string>",
                                "tagName": "<replace with 
                                 your string>",
                                "tagOffset": <replace with 
                                 your integer>
               }
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
         "responseCode": 2000,
         "responseMessage": "Successful"
 }
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: tagEvent

イベント アクション: added

提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
(注)

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

例:

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 セッションを変換します。 要求が成功した場合、変換されたファイルのリンクの一覧を応答で受け取ります。
API URI: https://<host>:<port>/ora/managementService/manage/convertSession
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                        "sessionId": "<replace with your 
                         string>",
                        "conversionFormat": "<replace with 
                          your string>"
                      }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "convertedLink": "<This is a String>"
    }
}
失敗した JSON 応答スキーマ:
{
    “responseCode”: <this is an integer>,
    “responseMessage”: “Failure: <this is a string>”,
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: sessionEvent

イベント アクション: 更新

提供開始時期:

API バージョン 1.0 以降で使用可能

API バージョン 1.5 では廃止になり、mp4Url が導入されます。

パラメータの説明」を参照してください。

リリース: 8.5(1)
注:

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

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

例:

例 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 に基づいて記録されたセッションを削除します。

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

アクティブなセッションを削除しようとすると、エラー メッセージが表示されます。
API URI: https://<host>:<port>/ora/managementService/manage/deleteSessions
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters": {
                         "sessionIds": ["<replace with your 
                          string>", "<replace with your 
                          string>", ...]
                        }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "jobId": "abcd1234"
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: sessionEvent

イベント アクション: 削除

提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
注:

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

例:

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

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 を使用して)作成されたタグと同じ名前とオフセット フィールドが使用されていることを確認します。

録音を削除した場合、その操作は元に戻すことができません。ただし、タグ名とオフセット フィールドを指定し、セッションにタグを再追加できます。

API URI: https://<host>:<port>/ora/managementService/manage/deleteSessionTag
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters":
                {
                "sessionId": "<replace with your string>",
                                "tagName": "<replace with 
                                 your string>",
                                "tagOffset": <replace with 
                                 your integer>
               }
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
         "responseCode": 2000,
         "responseMessage": "Successful"
 }
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント:

イベントの種類: tagEvent

イベント アクション: 削除

提供開始時期: API バージョン 1.1 以降で使用可能
リリース: 8.5(2)
例:

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
}

セッション クエリー

これらの API を使用し、MediaSense システムに問い合わせます。 getSessions API では、クエリー基準の組み合わせを使用し、詳細検索できます。

簡易検索を実行するには(deviceRef のみによるセッションの検索など)、よりシンプルなラッパー API を使用します。

getAllActiveSessions
説明: この API を使用し、アクティブな録音をすべて検索します。 返されたセッションは sessionStartDate により自動的にソートされます(降順)。
API URI: https://<host>:<port>/ora/queryService/query/getAllActiveSessions
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ: これらのパラメータは、URL のクエリー セクションで指定する必要があります。
  • offset=<整数と置換します>
  • limit=<整数と置換します>
  • minSessionStartDate=<整数と置換します>
  • maxSessionStartDate=<整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an 
                 integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<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>"
                    }
                ],
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 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
      • minSessionStartDate
      • maxSessionStartDate
    • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
      • TrackActive
      • TrackInactive
  • この API の応答はクエリーによって異なります。一部のパラメータは応答によっては使用できません。 たとえば、アクティブなセッションには sessionDuration や downloadUrl などのパラメータがありません。 同様に、httpUrl はセッションが変換されている場合にのみ使用できます。
例:

例 1

2012 年 7 月 26 日 20:45:40 GMT の時点で最後の 2 時間のアクティブ セッションをすべて取得するには(18:45:40 から 20:45:40 まで):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/
query/getAllActiveSessions?maxSessionStartDate=
1343335540154
 

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

例 2

2012 年 7 月 26 日 18:45:40 GMT と 2012 年 7 月 26 日 20:45:40 GMT (2 時間の時間枠)の間のアクティブなセッションから最初の 10 件を取得するには:

HTTPS GET:

https://10.194.118.1:8443/ora/queryService/query/
getAllActiveSessions?offset=0&limit=10&
minSessionStartDate=1343328340000&maxSessionStartDate
=1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

getAllPrunedSessions

説明: この API を使用し、取り除かれた録音をすべて検索します。 返されたセッションは sessionStart 日付により自動的にソートされます。 「取り除かれた」という用語は、MediaSense システムによって削除された録音を意味します。 deleteSessions API を使用し、明示的に録音を削除した場合、それらは「削除された」録音であり、「取り除かれた」録音ではありません。
API URI: https://<host>:<port>/ora/queryService/query/getAllPrunedSessions
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

これらのパラメータは、URL のクエリー セクションで指定する必要があります。

  • offset =<整数と置換します>
  • limit =<整数と置換します>
  • minSessionStartDate =<整数と置換します>
  • maxSessionStartDate= <整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an 
                 integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<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>"
                    }
                ],
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 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
      • minSessionStartDate
      • maxSessionStartDate
    • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
      • TrackActive
      • TrackInactive
例:

例 1

2012 年 7 月 26 日 20:45:40 GMT の時点で最後の 2 時間を対象に、取り除かれたセッションをすべて取得するには(18:45:40 から 20:45:40 まで):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getAllPrunedSessions?maxSessionStartDate=1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

例 2

2012 年 7 月 26 日 18:45:40 GMT と 2012 年 7 月 26 日 20:45:40 GMT (2 時間の時間枠)の間を対象に、取り除かれたセッションから最初の 10 件を取得するには:

HTTPS GET:

 https://10.194.118.1:8440/ora/queryService/query/
getAllPrunedSessions?offset=0&limit=10&
minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

getAssociatedSessions

説明: この API を使用し、関連性の強いセッションを sessionID 別に検索し、取得します。 関連性の強いセッションには共通して 1 xRefci が含まれます。
(注)      MediaSense 10.5 では、Unified Border Element 録音にコール関連付け機能を利用できません。
API URI: https://<host>:<port>/ora/queryService/query/getAssociatedSessions
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
   "requestParameters":{
        "sessionIdList" : [
            "<replace with your string>"
        ]
    }
}
(注)      要求パラメータの sessionIDList は将来の拡張機能の一覧タイプのパラメータです。ただし、現在のところ、最初の sessionId のみが関連性の強い sessionId を返すと見なされます。 追加の sessionIds は無視されます。
ヘッダー パラメータ: JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
   "responseMessage":"Success: Your request was successfully completed.",
   "responseCode":2000,
   "responseBody":{
      "sessions":[
         {
            "sessionState":"<this is a string>",
            "callControllerType":"<this is a string>",
            "sessionId":"<this is a string>",
            "urls":{
               "httpUrl":"<this is a string>",
               "rtspUrl":"<this is a string>",
               "mp4Url":"<this is a string>",
               "wavUrl":"<this is a string>"
            },
            "sessionStartDate":"<this is an integer>",
            "tracks":[
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is a an integer>",
                        "isConference":"<this is a boolean>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               },
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a boolean>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               }
            ],
            "sessionDuration":"<this is an integer>",
            "callControllerIP":"<this is a string>"
         },
         {
            "sessionState":"<this is a string>",
            "callControllerType":"<this is a string>",
            "sessionId":"<this is a string>",
            "urls":{
               "httpUrl":"<this is a string>",
               "rtspUrl":"<this is a string>",
               "mp4Url":"<this is a string>",
               "wavUrl":"<this is a string>"
            },
            "sessionStartDate":"<this is an integer>",
            "tracks":[
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a string>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               },
               {
                  "trackStartDate":"<this is an integer>",
                  "trackDuration":"<this is an integer>",
                  "codec":"<this is a string>",
                  "downloadUrl":"<this is a string>",
                  "trackNumber":"<this is an integer>",
                  "trackMediaType":"<this is a string>",
                  "participants":[
                     {
                        "participantStartDate":"<this is an integer>",
                        "deviceRef":"<this is an integer>",
                        "isConference":"<this is a string>",
                        "xRefCi":"<this is an integer>",
                        "participantDuration":"<this is an integer>",
                        "deviceId":"<this is a string>"
                     }
                  ]
               }
            ],
            "sessionDuration":"<this is an integer>",
            "callControllerIP":"<this is a string>"
         }
      ]
   }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": “<this is an integer>”,
   "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.6 以降で使用可能
リリース: 10.5
(注)

コール関連付け機能は、保存されている録音を順に処理し、共通 xRefCi 値を検索することで動作します。

たとえば、会話に(いずれも BiB がアクティベートされた)エージェント間のコール転送が含まれている場合、生成された録音セッションは、一連の共通 xRefCi 値により、互いにリンクされます。 コール関連付け機能はこれを利用し、互いに関連付けられている一連の録音を用意します。

(注)      (セッションが xRefCi にもデータベースの他のセッションと共通ではない)のあるコール シナリオの結果隔離された録音セッション。一部のコール シナリオでは、結果として、録音セッションが分離されます(その xRefCi とデータベースの他のセッションに共通点がないセッション)。 そのようなセッションはこの機能で関連付けることができません。
例:

HTTPS POST:

https://10.78.170.114:8440/ora/queryService/query/g
etAssociatedSessions

ヘッダー:

Content-Type: application/json

ボディ:

{
   "requestParameters":{
        "sessionIdList" : [
            "514406fbae4a1"
        ]
    }
}

応答:

{
   "responseMessage":"Success: Your request was successfully completed.",
   "responseCode":2000,
   "responseBody":{
      "sessions":[
         {
            "sessionState":"CLOSED_NORMAL",
            "callControllerType":"Cisco-CUCM",
            "sessionId":"614406fbae5e1",
            "urls":{
               "httpUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/614406fbae5e1.mp4",
               "rtspUrl":"rtsp://10.78.170.114/archive/614406fbae5e1",
               "mp4Url":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/614406fbae5e1.mp4",
               "wavUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/wav/614406fbae5e1.wav"
            },
            "sessionStartDate":1391686561,
            "tracks":[
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78119,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=614406fbae5e1-TRACK1",
                  "trackNumber":1,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341051",
                        "isConference":false,
                        "xRefCi":"20248680",
                        "participantDuration":78119,
                        "deviceId":"SEP70F39517B88A"
                     }
                  ]
               },
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78119,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=614406fbae5e1-TRACK0",
                  "trackNumber":0,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341052",
                        "isConference":false,
                        "xRefCi":"20248679",
                        "participantDuration":78119,
                        "deviceId":"SEP402CF4ECA126"
                     }
                  ]
               }
            ],
            "sessionDuration":78119,
            "callControllerIP":"10.65.157.134"
         },
         {
            "sessionState":"CLOSED_NORMAL",
            "callControllerType":"Cisco-CUCM",
            "sessionId":"514406fbae4a1",
            "urls":{
               "httpUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/514406fbae4a1.mp4",
               "rtspUrl":"rtsp://10.78.170.114/archive/514406fbae4a1",
               "mp4Url":"https://10.78.170.114:19443/recordedMedia/oramedia/mp4/514406fbae4a1.mp4",
               "wavUrl":"https://10.78.170.114:19443/recordedMedia/oramedia/wav/514406fbae4a1.wav"
            },
            "sessionStartDate":1391686561,
            "tracks":[
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78093,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=514406fbae4a1-TRACK1",
                  "trackNumber":1,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341052",
                        "isConference":false,
                        "xRefCi":"20248679",
                        "participantDuration":78093,
                        "deviceId":"SEP402CF4ECA126"
                     }
                  ]
               },
               {
                  "trackStartDate":1391686561,
                  "trackDuration":78093,
                  "codec":"PCMU",
                  "downloadUrl":"http://10.78.170.114:8081/mma/ExportRaw?recording=514406fbae4a1-TRACK0",
                  "trackNumber":0,
                  "trackMediaType":"AUDIO",
                  "participants":[
                     {
                        "participantStartDate":1391686561,
                        "deviceRef":"1341051",
                        "isConference":false,
                        "xRefCi":"20248680",
                        "participantDuration":78093,
                        "deviceId":"SEP70F39517B88A"
                     }
                  ]
               }
            ],
            "sessionDuration":78093,
            "callControllerIP":"10.65.157.134"
         }
      ]
   }
}

getSessionBySessionId

説明: この API を使用し、記録済みセッションまたはライブ セッションをそのセッション ID で検索し、取得します。
API URI: https://<host>:<port>/ora/queryService/query/getSessionBySessionId
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

このパラメータは、URL のクエリー セクションで指定する必要があります。

value =<文字列と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a 
                 string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "this is an 
                 integer>",
                "sessionDuration": "this is an integer>",
                "sessionState": "this is an integer>",
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 1.4 で変更

API バージョン 1.5 で変更

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

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

sessionId が「13092154564622」のセッションを取得するには:

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionBySessionId?value=13092154564622

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

getSessions

説明:

この API を使用し、記録済み、ライブ、または取り除かれたセッションを検索し、取得します。

要件: スケーラビリティを実行するには、この API に sessionStartDate フィールド条件が必要です。

制限: この API はどのような種類のクエリーでも不可能であることを要求します。 この制限は、クエリーの異なるパラメータ間で論理コネクタが使用されることに起因します。

f1、f2、f3 の 3 つのフィールドに問い合わせるとき、そのクエリーが "f1=<query> and f2=<query> or f3=<query>" であれば、SQL 先行ルールがフィールドに適用され、クエリーは "[ ( f1=<query> and f2=<query> ) or (f3=<query> ) ]" として解釈されます。

括弧を使用することで、f1 と F2 が最初に計算され、その計算結果と f3 が計算されます。

制限を要約すると、"[(f1) and (f2 or f3)]" のようなクエリーは不可能になります。

API URI: https://<host>:<port>/ora/queryService/query/getSessions
サポートされる応答形式: JSON
HTTP メソッド: POST
リクエスト パラメータ:
{
    "requestParameters": [
        {
            "fieldName" : "<replace with your string>",
            "fieldConditions": [
                {
                    "fieldOperator" : "<replace with your 
                     string>",
                    "fieldValues": [
                        "<replace with your string>",
                        "<replace with your string>",
                        …
                    ],
                    "fieldConnector": "<replace with your 
                     string>"                }
            ],
            "paramConnector": "<replace with your string>"        }
    ],
    "pageParameters": {
        "offset": "<replace with your string>",
        "limit": "<replace with your string>"    },
    "sortParameters": [
        {
            "byFieldName": "<replace with your string>",
            "order": "<replace with your string>"        }
    ]
}
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
		"sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
		"sessionStartDate": <this is an integer>,
                "sessionDuration": <this is an integer>,
                "sessionState": "<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>
                    }
                ],
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }

            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{
    “responseCode”: <this is an integer>,
    “responseMessage”: “Failure: <this is a string>”,
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

API バージョン 1.0 以降で使用可能

API バージョン 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 で次の変更が導入されました。
  • スケーラビリティを実行するには、この API に sessionStartDate フィールド条件が必要です。
  • この API は現在、検索可能な fieldName として sessionId をサポートしません。
  • 導入されたパラメータ:
    • callControllerIP
    • callControllerType
    • ccid
  • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
    • TrackActive
    • TrackInactive
例:

例 1

クエリー: ( ( tagName = "foo" で、sessionStartDate が 2010/11/02 21:21:40 と 2010/11/03 21:21:40 の間 ) または ( deviceRef = "1000" で、sessionState = "active" ) ) のセッションをすべて取得する

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "tagName",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "foo"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ],
            "paramConnector": "OR"
        },
        {
            "fieldName" : "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "1000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "active"
                    ]
                }
            ]
        }
    ]
}

例:

例 2

クエリー: ( ( xRefCi = 12345678 で、tagName = foo ) または ( sessionState = active で、sessionStartDate が Nov 2, 2010 21:21:40 と Nov 3, 2010 21:21:40 の間 ) ) のセッションをすべて取得する

(注)     

「or」コネクタを指定するときは注意してください。 「or」の前の部分式は、2 つ目の部分式の sessionStartDate により制限されます。 最初の部分式がスケーラブルであることを確認する必要があります。あるいは、最初の部分式に sessionStartDate フィルタを追加する必要があります。 この例では、「xRefCi」を指定するフィルタを使用します。 これはスケーラブル フィールドです。そのため、sessionStartDate によってさらに制限する必要はありません。「tagName」は非スケーラブルですが、「and」演算子により xRefCi フィルタに接続されるため、完全な部分式はスケーラブルになります。

スケーラブル クエリーの式を記述する方法の詳細については、「非スケーラブル クエリーを回避する」を参照してください。

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "xRefCi",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "12345678"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "tagName",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "foo"
                    ]
                }
            ],
            "paramConnector": "OR"
        },
        {
            "fieldName" : "sessionState",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "active"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

例:

例 3

クエリー: ( ( (deviceRef = "1000" または deviceRef="2000") または tagName="foo" ) および sessionState="active" ) のセッションをすべて取得する

A query where higher precedence is intended for an 'OR' 
operation over an 'AND' operation is not possible.

例:

例 4

クエリー: ( deviceRef = "1000" で、sessionStartDate が 2010/11/02 21:21:40 と 2010/11/03 21:21:40 の間 ) のセッションをすべて取得する

(注)     

シンプルな getSessionsByDeviceRef API を利用してシンプルなクエリーを簡単に作成できますが、getSessions API を使用することもできます。

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "1000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

例:

例 5

クエリー: トラックが nodeIPAddress "10.35.146.158" で記録されており、パーティション "/common" が 2010/11/02 21:21:40 と 2010/11/03 21:21:40 の間にあるセッションをすべて取得する

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "nodeIPAddress",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "10.35.146.158"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "partition",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "/common"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

例:

例 6

クエリー: 2010/11/02 21:21:40 と 2010/11/03 21:21:40 の間でシステムにより取り除かれたセッションをすべて取得する

クエリー: 2010/11/02 21:21:40 と 2010/11/03 21:21:40 の間でシステムにより取り除かれたセッションをすべて取得する

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "pruned",
            "fieldConditions": [
                {
                    "fieldOperator" : "equals",
                    "fieldValues" : [
                        "true"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

例:

例 7

クエリー: 特定の日付範囲内に入るセッションをすべて取得する。例: Tue, 02 Nov 2010 21:21:40 GMT と Wed, 03 Nov 2010 21:21:40 GMT の間

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName" : "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator" : "between",
                    "fieldValues" : [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000  // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}

例:

例 8

クエリー: ( (deviceRef = 1000 または deviceRef = 2000 または deviceRef = 3000) および sessionStartDate は Nov 2, 2010 21:21:40 と Nov 3, 2010 21:21:40 の間 ) ) のセッションをすべて取得する

HTTPS POST:

https://10.194.118.1:8440/ora/queryService/query/getSessions

ヘッダー:

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

ボディ:

{
    "requestParameters": [
        {
            "fieldName": "deviceRef",
            "fieldConditions": [
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "1000"
                    ],
                    "fieldConnector": "OR"
                },
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "2000"
                    ],
                    "fieldConnector": "OR"
                },
                {
                    "fieldOperator": "equals",
                    "fieldValues": [
                        "3000"
                    ]
                }
            ],
            "paramConnector": "AND"
        },
        {
            "fieldName": "sessionStartDate",
            "fieldConditions": [
                {
                    "fieldOperator": "between",
                    "fieldValues": [
                        1288732900000, // Tue, 02 Nov 2010 
                        21:21:40 GMT
                        1288819300000 // Wed, 03 Nov 2010 
                        21:21:40 GMT
                    ]
                }
            ]
        }
    ]
}


getSessions のパラメータの詳細

getSessions の fieldOperators

fieldName パラメータ

各 fieldName パラメータに許可される fieldOperators

tagName

equals

contains

startsWith

endsWith

tagType

equals

deviceRef

equals

contains

startsWith

endsWith

between

sessionState

equals

sessionDuration

lessThan

greaterThan

equals

mediaType

equals

sessionStartDate

between

xRefCi

equals

pruned

equals

partition

equals

nodeIPAddress

equals

ccid

equals

getSessions の Enumerations

パラメータ このパラメータに許可される列挙
byFieldName

sessionId

sessionState

sessionDuration

sessionStartDate

ccid

getSessionsByCCID

説明: この API を使用し、Call Correlation Identifier (CCID) で記録済みセッションまたはライブ セッションを検索し、取得します。 返されたセッションは sessionStartDate によって自動的に降順でソートされます。
API URI: https://<host>:<port>/ora/queryService/query/getSessionsByCCID
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

これらのパラメータは、URL のクエリー セクションで指定する必要があります。

  • value=<文字列と置換します>
  • offset=<整数と置換します>
  • limit=<整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "this is an integer>",
                "sessionDuration": "this is an integer>",
                "sessionState": "this is an integer>",
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

API バージョン 1.2 以降で使用可能

API バージョン 1.4 で変更

API バージョン 1.5 で変更

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

リリース: 8.5(3)
注:

リリース 10.0、バージョン 1.5 で次の変更が導入されました。

    • httpUrl が非推奨となり、mp4Url が導入されます。
    • URL に 2 種類の新しいパラメータが導入されました(詳しくは、パラメータの説明の表を参照してください)。
      • mp4url
      • wavurl
  • リリース 9.0(1)、バージョン 1.4 で次の変更が導入されました。
    • トラックに新しいパラメータが導入されました(詳しくは、パラメータの説明の表を参照してください)。
      • コーデック

例:

例 1

ccid が「0584071424-0000065536-0000000016-0671746570」のセッションをすべて取得するには:

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=0584071424-0000065536-0000000016-
0671746570&offset=0&limit=0

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

例 2

ccid が「0584071424-0000065536-0000000016-0671746570」のセッションの最初の 10 件を取得するには:

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=13092154564622%4010.194.118.71
&offset=0&limit=10

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

例 3

ccid が「0584071424-0000065536-0000000016-0671746570」のセッションの最初の 100 件(返されるレコードのデフォルト数)を取得するには:

HTTPS GET:

https://10.194.118.1:8080/ora/queryService/query/
getSessionsByCCID?value=0584071424-0000065536-0000000016-
0671746570

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>
(注)     

オフセットまたは制限パラメータがない場合、要求は、最初の 100 セッションを返すように初期設定されます。

getSessionsByDeviceRef

説明: この API を使用し、デバイス Ref (電話番号、IP アドレス、デバイス別の URI/URL)別に記録済みセッションまたはライブ セッションを検索し、取得します。 返されたセッションは sessionStartDate により自動的にソートされます(降順)。
API URI: https://<host>:<port>/ora/queryService/query/getSessionsByDeviceRef
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

これらのパラメータは、URL のクエリー セクションで指定する必要があります。

  • value=<文字列と置換します>
  • offset=<整数と置換します>
  • limit=<整数と置換します>
  • minSessionStartDate=<整数と置換します>
  • maxSessionStartDate=<整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<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>"
                    }
                ],
                "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": "<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>"
                            }
                        ]
                    }
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 1.2 で変更

API バージョン 1.4 で変更

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

リリース: 8.5(1)
注:
  • リリース 9.0(1)、バージョン 1.4 で次の変更が導入されました。
    • トラックに新しいパラメータが導入されました(詳しくは、パラメータの説明の表を参照してください)。
      • コーデック
  • リリース 8.5(3)、バージョン 1.2 で次の変更が導入されました。
    • 導入されたパラメータ:
      • callControllerIP
      • callControllerType
      • ccid
      • minSessionStartDate
      • maxSessionStartDate
    • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
      • TrackActive
      • TrackInactive
例:

例 1

2012 年 7 月 26 日 20:45:40 GMT の時点で最後の 2 時間を対象に、deviceRef が "1000" のセッションをすべて取得するには(18:45:40 から 20:45:40 まで):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByDeviceRef?value=1000&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

例 2

2012 年 7 月 26 日 18:45:40 GMT と 2012 年 7 月 26 日 20:45:40 GMT (2 時間の時間枠)の間を対象に、deviceRef が "1000" のセッションから最初の 10 件を取得するには:

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByDeviceRef?value=1000&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn 
request>

getSessionsByMediaType

説明: この API を使用し、メディア タイプ(オーディオ、ビデオ、オーディオとビデオ、スクリーン キャプチャ)に基づいて記録済みセッションまたはライブ セッションを検索し、取得します。 返されたセッションは sessionStartDate によって自動的にソートされます。最新のセッションが一番上になります。
API URI: https://<host>:<port>/ora/queryService/query/getSessionsByMediaType
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

次のパラメータは、URL のクエリー セクションで指定する必要があります。

  • value=<文字列と置換します>
  • offset=<整数と置換します>
  • limit=<整数と置換します>
  • minSessionStartDate=<整数と置換します>
  • maxSessionStartDate=<整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<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>"
                    }
                ],
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

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

API バージョン 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
    • minSessionStartDate
    • maxSessionStartDate
  • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
  • TrackActive
  • TrackInactive
例:

例 1

2012 年 7 月 26 日 20:45:40 GMT の時点で最後の 2 時間を対象に、mediaType が "AUDIO" のセッションをすべて取得するには(18:45:40 から 20:45:40 まで):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByMediaType?value=AUDIO&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn request>

例 2

2012 年 7 月 26 日 18:45:40 GMT と 2012 年 7 月 26 日 20:45:40 GMT (2 時間の時間枠)の間を対象に、mediaType が "AUDIO" のセッションから最初の 10 件を取得するには:

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByMediaType?value=AUDIO&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn request>

getSessionsByTag

説明: この API を使用し、ユーザが割り当てたタグ名で記録済みセッションまたはライブ セッションを検索し、取得します。 タグは録音のラベルとしてユーザが割り当てる名前です。 返されたセッションは sessionStartDate により自動的にソートされます(降順)。
API URI: https://<host>:<port>/ora/queryService/query/getSessionsByTag
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

次のパラメータは、URL のクエリー セクションで指定する必要があります。

  • value=<文字列と置換します>
  • offset=<整数と置換します>
  • limit=<整数と置換します>
  • minSessionStartDate=<整数と置換します>
  • maxSessionStartDate=<整数と置換します>
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseCode": 2000,
    "responseMessage": "Successful",
    "responseBody": {
        "sessions": [
            {
                "sessionId": "<this is a string>",
                "callControllerIP": "<this is a string>",
                "callControllerType": "<this is a string>",
                "ccid": "<this is a string>",
                "sessionStartDate": "<this is an integer>",
                "sessionDuration": "<this is an integer>",
                "sessionState": "<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>"
                    }
                ],
                "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": "<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": "<this is a string>",
                    "rtspUrl": "<this is a string>",
                    "mp4Url": "<this is a string>",
                    "wavUrl": "<this is a string>"

                }
            }
        ]
    }
}
失敗した JSON 応答スキーマ:
{ "responseCode": <this is an integer>,
  "responseMessage": "Failure: <this is a string>",
  "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期:

API バージョン 1.0 以降で使用可能

API バージョン 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
      • minSessionStartDate
      • maxSessionStartDate
  • トラックにタグを追加できるようになりました。 次の SYSTEM_DEFINED tagName の列挙値はトラック レベルで使用できます。
    • TrackActive
    • TrackInactive
例:

例 1

2012 年 7 月 26 日 20:45:40 GMT の時点で最後の 2 時間を対象に、タグが "mysampletag1" のセッションをすべて取得するには(18:45:40 から 20:45:40 まで):

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByTag?value=mysampletag1&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous signIn request>

例 2

2012 年 7 月 26 日 18:45:40 GMT と 2012 年 7 月 26 日 20:45:40 GMT (2 時間の時間枠)の間を対象に、タグが "mysampletag1" のセッションから最初の 10 件を取得するには:

HTTPS GET:

https://10.194.118.1:8440/ora/queryService/query/
getSessionsByTag?value=mysampletag1&offset=0&limit=
10&minSessionStartDate=1343328340000&maxSessionStartDate=
1343335540154

ヘッダー:

JSESSIONID: <the jsessionId received from a previous 
signIn request>

スケーラブルでないクエリー

getSessions API により、クライアントはセッションごとに収集されたメタデータのカスタム クエリーを実行できます。 この API により、クライアントはセッションのメタデータ内にある複数の重要なデータ フィールドでのフィルタリングを可能にする、カスタム クエリーを形成できます。 また、これらのクエリーを組み合わせた柔軟な方法で、パワフルなメタデータ検索を実行できます。


(注)  


このカスタム クエリー機能は、正しく使用しないと、クエリー自体だけでなく MediaSense システム全体のパフォーマンスに重大な影響を与えることがあります。 これは、システム上のトラフィックや使用中の保持機能に応じて、大量のセッション記録を保存することが可能であるためです。 これは正常です。 ただし、クエリーが大量のデータを処理する場合は完了までに数分かかる場合があります。 また、新しい記録とメタデータの処理に使用するシステム上のリソースに影響する可能性があります。


この問題を回避するため、クライアントはスケーラブル クエリーを形成する必要があります。 スケーラブル クエリーとは、データベースにどの程度データがあるかに関係なく、パフォーマンスが一定となるクエリーです。 スケーラブル クエリーの一例を次に示します。「開始日時が本日の 4 ~ 5 時の間であるセッションをすべて検索する」。データベース内にどれだけ多くのセッションが存在する場合でも、4 ~ 5 時の間のセッション数は、かなり安定して少ないままです。 スケーラブルでないクエリーの一例を次に示します。「すべてのセッションを検索する」。返されるセッション数は、データベース内のセッション数に比例します。 大量のセッションが保存されている場合、結果は膨大な数になります。 そのため完了するまでに相当な時間がかかり、MediaSense システムの他の機能が必要とするリソースに影響を及ぼします。

getSessions API で「すべてのセッションを検索する」クエリーを発行する直接的な方法はありませんが、ほぼ同じ結果を得られるカスタム クエリーを形成することはできます。 たとえば、すべてのセッションにメディア タイプが「オーディオ」のトラックが少なくとも 1 つあるので、「メディア タイプがオーディオであるすべてのセッションを検索する」というクエリーを送信する可能性があります。このクエリーを防ぐことはできませんが、システムのパフォーマンスに重大な影響を及ぼす原因になる可能性があります。 メディア タイプの特定の値(「オーディオ」)が指定されていますが、これで十分に制限されるわけではありません。 これは、すべてではなくてもほとんどのセッションに「オーディオ」のメディア タイプがあるからです。大量のセッションがデータベースに保存されている場合、クエリーはこれらすべてのセッションを処理する必要があります。 これはスケーラブルでありません。


(注)  


小さいページ サイズの指定にページ番号の使用は役立ちません。 ページは、完全な結果のセットが処理された後に取得されます。 これでは遅すぎます。


処理されるセッション数を減らして、クエリーの範囲を小さくするのが優れた方法です。 この場合、クライアントが実際に必要とするのは、発生した過去数回のセッションです。 それは次の方法で行えます。「開始日時が 1 時間以上前のすべてのセッションを検索する」。そうすれば結果の数は非常に絞られます。 さらに重要なこととして、データベース内のセッション数に関係なく、ほぼ同じセッション数を返します。 これがスケーラブル クエリーです。

最新の 10 セッションのみが必要な場合、クライアントは開始日時フィールドの結果をソートする修飾子を追加して、最後の 10 行を表示するページ番号を指定することもできます。 基本の結果セットが小さいため、手間のかかる操作ではありません。

メディア タイプをフィルタすることは、常に問題をもたらすわけではありません。 たとえば、次のクエリーは非常にスケーラブルです。「開始日時が前の火曜日で、メディア タイプがビデオであるすべてのセッションを検索する」。 まず、時間枠の設定によって結果セット全体を絞り込みます。 このクエリーは、メディア タイプが「ビデオ」となっているものだけを探すため、小さいセッションのセットのみを検索することになります。この場合、メディア タイプ フィールドはスケーラブル フィルタと統合されるため、スケーラビリティに影響を与えません。

メタデータの各フィールドでは、スケーラビリティの程度を変えてセッションをフィルタすることができます。 参考として次の表をご覧ください。

フィールド名 相対的スケーラビリティ 注記
sessionId スケーラブル この値は一意です。 特定の ID を持つセッションについてクエリーを行うと、結果は 1 つだけ得られます。
sessionStartDate スケーラブル 使用には注意が必要です。 不当に大きなウィンドウ サイズを指定すると、データベース内のセッションの大部分が結果として返されることになります。 時間枠は最大限に絞ってください。
maxSessionStartDate スケーラブル minSessionStartDate と併用すると、このパラメータで時間枠の上限を指定することができます。 結果の数を制限するために、適切なサイズの枠を使用してください。 このパラメータがない場合、minSessionStartDate が必要となり、時間枠は 2 時間であると見なされます。
minSessionStartDate スケーラブル maxSessionStartDate と併用すると、このパラメータで時間枠の下限を指定することができます。 結果の数を制限するために、適切なサイズの枠を使用してください。 このパラメータがない場合、maxSessionStartDate が必要となり、時間枠は 2 時間であると見なされます。
xrefCi スケーラブル この値は、通常は一意で循環にしばらく時間がかかります。 特定の xrefCi 値を使用してフィルタリングを行った場合は、わずかな数のセッションしか取得しません。
pruned ほとんどスケーラブルでない これはブール フィールドです。 「false」を選択すると、データベースの大部分のセッションを取得する可能性があります。 もちろん「true」を選択すると、結果のセットは小さくスケーラブルになります。

tagType

sessionState

mediaType

ほとんどスケーラブルでない わずか 2 つから 5 つの値です。 mediaType の「Audio」や sessionState の「Completed」などの値の場合、戻されるセッション数はデータベース内のセッション数に比例します。 もちろん、その他の値も小さな結果セットを返すかもしれませんが、それもデータベース内のセッション数に比例します。
tagName あまりスケーラブルでない タグを使用すると、同じタグ名が多数のセッションで繰り返し使用されていることがあります。 タグを使用するかぎり、返された結果のうち、特定のタグを含んでいるものの数は、データベース内のセッション数に比例する可能性があります。
deviceRef あまりスケーラブルでない deviceRef フィールドにある内線番号は、多くのセッションでも出現する傾向があります。 頻繁に使用される数は、多数のセッションと関連付けられている傾向があります。 この数は、データベース内のセッション数に比例する可能性があります。
sessionDuration あまりスケーラブルでない 継続時間は多少違っても、「継続時間が 2 分未満のすべてのセッションを検索する」のように単純なクエリーは、データベース内のセッションの大部分を返すことになります。
nodeIPAddress partition スケーラブルでない パーティション数またはノード数は比較的少ないものです。 そのため、特定のパーティションやサーバ(ノード)と関連付けられているセッションは、データベース内のセッション数に比例したセッション数を返します。

フィールド演算子はスケーラビリティに影響を与えます。 次の表を参照してください。

Operator 相対的スケーラビリティ 注記
  多くはスケーラブル フィールドがスケーラブルである場合、通常これは非常に少ない数のセッションしか返しません。 ただし、フィールドがスケーラブル(たとえば「mediaType が Audio の場合)でない場合、これはデータベース内のセッションの大部分を返します。
between 多くはスケーラブル Use with caution. たとえば、フィールドが開始日時で、範囲の開始が数年前の日付である場合、データベースの内容全体を返します。 この演算子を使用する場合は、範囲を狭く保つよう注意してください。

greaterThan

lessThan

状況によって異なる 値の範囲をカッコに入れ、その範囲が十分に狭ければ、これらはスケーラブルです。 ただし、単独で使用する場合、データベース内のセッションの大部分が返される可能性があります。

contains

startsWith

endsWith

それほどスケーラブルではない スケーラブル フィールドとともに使用する場合でも、データベース内のセッションの大部分が返される可能性があります。

フィールドとパラメータのコネクタがスケーラビリティに影響を与えます。 次の表を参照してください。

コネクタ 相対的スケーラビリティ 注記
および スケーラブル このコネクタはフィルタのスコープを絞り込むため、通常は結果セットがより小さくなります。
または スケーラブルでない このコネクタはフィルタのスコープを広げるため、結果セットがより大きくなります。 これは、スケーラブルな演算子を使用したスケーラブル フィールドの接続フィルタに限定する必要があります。

クエリー フィルタを定義する場合は、スケーラブル フィルタを必ず使用してください。 スケーラブルでないフィールドでフィルタリングする必要がある場合は、常に「and」のコネクタを使用して、結果セットの絞り込みを行うスケーラブル フィルタに接続します。

以下は、クライアント アプリケーションがシステム パフォーマンスに影響を及ぼすことなく MediaSense API を効果的に使用する方法のいくつかの例です。

セッションの進行状況を追跡するため、クライアント アプリケーションは、MediaSense のクエリーとイベントの両方の機能を活用することがあります。 最初にクライアントは、知りたいセッションの状態情報を収集する必要があります。 これは、「最終日に開始された、有効な内線番号 nnnn を含むすべてのセッションを検索する」のような最初のクエリーで行えます。これはセッション数を最終日に開始したセッションのみに絞り込むので、スケーラブルになります。 次に、指定された内線番号を含む有効なセッションはわずかしかないため、すぐに見つけ出します。

このとき、クライアントはアプリケーション イベントをサブスクライブする必要があります。 セッションの状態が変わるにしたがい、この方法によってクライアントは進行状況を追跡できます。

これは、前述のシナリオと同様です。 アクティブ セッションの現在のセットを設定する最初のクエリーを作成します。「最終日に開始された、有効なすべてのセッションを検索する」などです。データベース内のすべてのセッションを検索するのに、システム リソースを使い過ぎずに、すべてのアクティブなセッションをすべて検索するには 1 日で十分です。

クライアントは、イベント メカニズムを使用して、アクティブ セッションの進行状況を監視できます。 新しいセッションが作成されると、イベントはこれを追跡できるようにクライアントに通知します。 同様に、セッションを閉じた場合、追跡されたセッションのクライアント リストから削除することができます。 重要な点は、クライアントが初期設定のために主なデータベース クエリーを実行する必要があるということです。 それによって、システム リソースへの影響が最小限に抑えられます。

記録優先度の保存モードを使用するようにシステムが設定されていると、保存されている期間に基づいてセッションがプルーニングされます。 ただし、それらのセッションと関連づけられたメタデータは削除されません。 削除する前に管理者が確認できるように保存されます。 予測されるシーケンスは、クライアント アプリケーションが「プルーニング済み」セッションのリストを要求します。 その後、これらのセッションから該当のメタデータを表示します。 最後に、プルーニングされたセッションの中から、削除するものを 1 つ以上選択することができます。

次のようなクエリーによって、最初の一歩を踏み出すことができます。「直近 2 日間に開始された、プルーニングされた状態が「true」であるすべてのセッションを検索する」。クエリーをスケーラブルにするために妥当な時間枠を使用します。 プルーニングは経過時間に基づくメカニズムを使用するため、少なくとも昨日よりも前の日付を参照してください。 これを毎日行わない場合、時間枠をほぼ 1 日に制限することもできます。 これは、サイトのトラフィックに依存します。 一度に約 100 件のセッションを返すクエリーは選択したくないものです。 これには何らかのテストが必要となる場合があります。

クライアントは、前回この操作を実行した最後の日までさかのぼって検索するまで、前日について 1 日ずつこの操作を繰り返す必要があります。 クライアントは、ユーザにそのリストを示し、セッションを削除してよいか確認する場合もあります(同様に「delete all」オプションも提供します)。 クライアントは、API の deleteSessions メソッドを使用して、選択したセッションを削除するジョブを送信します。 deleteSessions メソッドは各セッションの削除を連続的に行うため、この場合はスケーラビリティの問題がありません。

削除の進行状況を監視するために、クライアントはイベント メカニズムを使用します。 各セッションが削除されると、イベント タイプが「deleted」のセッション イベントが生成されます。

System Information

これらの API を使用し、MediaSense API バージョン情報を取得します。 この API を使用するためにサインインする必要はありません。 getAPIVersion API は MediaSense 展開で実行されている API の浮動小数点バージョン番号を返します。

getAPIVersion

説明: この API を使用し、システムで実行されている API の現在のバージョンを取得します。 バージョン番号は 1.0 から始まります。製品バージョンには関連しません。 バージョン番号は x.y.z ではなく、x.y です(たとえば、1.0.1 ではなく、1.0 です)。
API URI: https://<host>:<port>/ora/infoService/info/getAPIVersion
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ: なし
ヘッダー パラメータ: なし
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "apiVersion": "<this is string>"
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.0 以降で使用可能
リリース: 8.5(1)
例:

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getAPIVersion

応答:

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

getSystemTime

説明:

この API を使用し、システムの現在の時刻を取得します。 この時間は 1970 年 1 月 1 日 GMT 以降の秒数で返されます。

すべての MediaSense サーバが NTP クライアントとして設定されるため、サーバ間の違いが少ないことが求められます。 そのため、システム時刻が 1 つだけ返されます。この時間が MediaSense クラスタ内のすべてのサーバに適用されます。

API URI: https://<host>:<port>/ora/infoService/info/getSystemTime
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ: なし
ヘッダー パラメータ: signIn API から取得した JSESSIONID
パラメータの説明:

パラメータの説明」を参照してください。

成功した JSON 応答スキーマ:
{
    "responseMessage": "Success: Your request was 
     successfully completed.",
    "responseCode": 2000,
    "responseBody": {
        "currentSystemTime": <this is an integer>
    }
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>",
    "detail": "<this is a string>"
}
関連エラー コード:

API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.1 以降で使用可能
リリース: 8.5(2)
注:
  • currentSystemTime が生成された時刻から、この要求を発行するクライアントが実際に受信した時刻まで、遅延が発生することがあります。
  • システム時刻は UNIX のエポック時間で返されます。エポック コンバータを使用し、この時間を読み取り可能な形式に変換できます。
例:

HTTPS GET:

https://10.194.118.72:8440/ora/infoService/info/
getSystemTime

ヘッダー:

JSESSIONID: <the jsessionId received from a signIn 
request>

応答:

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

getSessionsResponseSchema

説明:

この API を使用し、システムで実行されている getSessions 応答スキーマの現在のバージョンを取得します。

API URI: https://<host>:<port>/ora/infoService/info/getSessionsResponseSchema
サポートされる応答形式: JSON
HTTP メソッド: GET
リクエスト パラメータ:

なし

ヘッダー パラメータ:

なし

パラメータの説明:

なし

成功した JSON 応答:
{
	"type":"object",
	"$schema": "http://json-schema.org/draft-03/schema",
	"apiVersion": "string representation of api version",
	"properties": 
   {"responseCode": 
     {"type":"number",
      "required":true },
		  "responseMessage": 
     {"type":"string",
      "required":true }
    "responseBody": 
     {"type":"object",
      "required":false
      "properties":
       {"sessions": 
         {"type":"array",
					     "required":true,
					     "items":
           {"type":"object",
            "required":true,
							     "properties":
             {"callControllerIP": 
               {"type":"string",
									       "required":true },
								      "callControllerType": 
               {"type":"string",
                "required":true },
								      "ccid": 
               {"type":"string",
									       "required":false,
                "searchable": 
                 {"operations": ["equals"] }
             },
								    "sessionDuration": 
             {"type":"number",
              "required":false,
              "minimum":0,
              "searchable": 
               {"operations": ["equals", "lessThan", 
                  "greaterThan"] }
             },

								    "sessionId": 
             {"type":"string",
									     "required":true },
								    "sessionStartDate": 
             {"type":"number",
									     "required":true,
              "minimum":0,
              "searchable": 
               {"operations": ["between"] }
             },
            "sessionState": 
             {"description":"string values are ACTIVE, 
               CLOSED_NORMAL, DELETED, and CLOSED_ERROR",
             "type":"string",
    									"required":true,
             "searchable": 
              {"operations": ["equals"] }
             },
	   							"tags": 
            {"type":"array",
             "required":false,
             "items": 
              {"type":"object",
               "required":true,
											    "properties":
                {"tagCreateDate": 
                  {"type":"number",
												       "required":true },
     												"tagName": 
                  {"type":"string",
													      "required":true,
                   "searchable": 
                    {"operations": ["equals", "contains", 
                       "startsWith", "endsWith"] }
                  },
   												  "tagOffset": 
                  {"type":"number",
											        "required":false },
     												"tagType": 
                  {"description":"string values are 
                    SYSTEM_DEFINED and USER_DEFINED",
                   "type":"string",
                   "required"true,
                   "searchable": 
                    {"operations": ["equals"] }
											        }
										       }
         						},             

             "tracks": 
              {"type":"array",
									      "required":true,
									      "items":
                {"type":"object",
											      "required":true,
											      "properties":
                  {"codec": 
                    {"type":"string",
													        "required":true },
												       "downloadUrl": 
                    {"type":"string",
												         "required":false },
    												   "participants": 
                    {"type":"array",
     													   "required":true,
                     "items": 
                      {"type":"object",
     															   "required":true,
     															   "properties":
                         {"deviceId": 
                           {"type":"string",
							       										    "required":true },
      																    "deviceRef": 
                           {"type":"string",
																	           "required":true,
                            "searchable": 
                             {"operations": ["equals", 
                              "contains", "startsWith", 
                              "endsWith", "between"] }
                           },
                          "isConference": 
                            {"type":"boolean",
									         								   "required":true },
        																  "participantDuration": 
                            {"type":"number",
																             "required":false },
																          "participantStartDate": 
                            {"type":"number",
																	            "required":true },
																          "xRefCi": 
                            {"type":"string",
																	            "required":false,
                             "searchable": 
                               {"operations": ["equals"] }
                            }
															           }
														          }
												          },

												   "tags": 
                 {"type":"array",
                  "required":false,
													     "items": 
                   {"type":"object",
															     "required":true,
															     "properties":
                     {"tagCreateDate": 
                       {"type":"number",
																	       "required":true },
																      "tagName": 
                       {"type":"string",
																	       "required":true },
																      "tagOffset": 
                       {"type":"number",
																        "required":false },
																      "tagType": 
                       {"description":"string values are 
                        SYSTEM_DEFINED and USER_DEFINED", 
                        "type":"string",
                        "required":true, }
															    }
														   }
   												},

												"trackDuration": 
             {"type":"number",
												  "required":false },
												"trackMediaType": 
             {"description":"string values are AUDIO and 
               VIDEO",
              "required":true,
              "type":"string" },
												"trackNumber": 
             {"type":"number",
              "required"true },
												"trackStartDate": 
             {"type":"number",
													 "required":true }
											}
									}
							},
					"urls": 
       {"type":"object",
        "required":false,
								"properties":
         {"mp4Url": 
           {"type":"string",
            "required":false },
										"rtspUrl": 
           {"type":"string",
            "required":false },
										"wavUrl": 
           {"type":"string",
            "required":false	}
									}
							}
					 }
				 }
			 }
		 }
		}
	}
}
失敗した JSON 応答スキーマ:
{
    "responseCode": <this is an integer>,
    "responseMessage": "Failure: <this is a string>"
}
関連エラー コード:

HTTP の障害シナリオ(404 や 500 など)。 「API 応答コード」を参照してください。

トリガーされたイベント: なし
提供開始時期: API バージョン 1.5 以降で使用可能
リリース: 10.0(1)
注:

スキーマの「required」タグは、親プロパティが実際の応答に入っていなければならないことを意味します。 「required」が指定されていない場合、または false に設定されている場合、そのプロパティは応答で返されないことがあります。

MediaSense は json スキーマのドラフトとは少し異なる方法で「searchable」を使用します。ノードは、可能な操作のアレイであるオブジェクトから構成されます。 「searchable」値が存在する場合、それに該当するプロパティを検索できます。 存在しないか、false に設定されている場合、そのプロパティは検索できません。

アレイはプロパティ(equals、greaterThan、lessThan、between など)を定義します。このプロパティでオブジェクトを検索できます。 between プロパティには lowerBound 値と upperBound 値があります。

例:

HTTPS GET:

https://10.10.10.10:8440/ora/infoService/info/
getSessionsResponseSchema

応答:

上記の「成功した JSON 応答スキーマ」を参照してください。

API パラメータ

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

次の API パラメータ説明表の [Description] 列では、パラメータは次のように分類されます。

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

API パラメータの説明(A ~ D)

パラメータ API またはイベントの種類 説明と制約
apiVersion getAPIVersion 出力文字列。 現在システムで動作している API のバージョン番号。 このバージョンは文字列として返されますが、浮動小数点数でもあります。 比較的小さな数値は、古いバージョンを示します。 比較的大きな数値は、新しいバージョンを示します。
authenticationProviders signIn 文字列のオプション入力アレイ。 ユーザ認証に使用するサービスの識別子。 列挙値:
  • AXL

  • FINESSE

このパラメータを指定しない場合、システムは上記の順序でプロバイダーと認証を試み、最初の認証が成功すると戻ります。

byFieldName
  • getJobResult
  • getJobs
  • getSessions
オプション入力文字列。 byFieldName パラメータも sortParameters 内で必須の入力文字列です。 関連情報については、sortParameter を参照してください。 列挙値はこのパラメータを使用している API によって異なります。
callControllerIP
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。
  • callControllerType = Cisco-SIPGateway の場合、録音を開始したゲートウェイの IP アドレスです。
  • callControllerType = Cisco-Unified Communications Manager の場合、録音を開始した Unified Communications Manager デバイスの IP アドレスです。
  • callControllerType = direct の場合、IOS の IP アドレスまたは MediaSense と通信する Unified Ccommunications Manager デバイスです。
callControllerType
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 列挙値(大文字と小文字が区別され、太字で識別):
  • Cisco SIP Gateway(Unified Border Element からのコール)。
  • Cisco Unified Communications Manager(Unified Communications Manager から分岐されたコール)。
  • direct(MediaSense により開始されたダイレクト発信/受信コール)。
  • Cisco-Unified Communications Manager-Gateway(Unified Communications Manager の制御下でゲートウェイから分岐されたコール)
ccid
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 ccid パラメータも getSessions を使用する場合のオプション入力文字列、および getSessionsByCCID を使用する場合に必須の入力文字列です。 このフィールドは、Unified Border Element Gateway から分岐されたコールに常に存在します。ただし、Unified Communications Manager の電話機から分岐されたコールには存在しない場合があります。 この Call Correlation ID (CCID)は同じコールの一部となっている録音セッションを識別するために使用されます。 これは、Unified Border Element Gateway 二より提供される「シスコ guid」フィールドに対応するため、ソリューションの他のコンポーネントからのコール情報に録音セッションを関連付けるために使用することもできます。
コーデック
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent

出力文字列。 トラックのコーデック。 これには、コーデックの SDP 定義からの標準の名前が含まれます。

(注)     

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

convertedLinks convertSession 出力文字列。 convertSession API の一部として生成された変換済みリンク。 URL のカンマで区切られたリスト。 各 URL はセッションのオーディオ録音を指します。 すべての値が文字列を構成します。
conversionFormat convertSession 出力文字列。 MediaSense セッションを変換する形式。 列挙値 = MP4。
currentSystemTime getSystemTime 出力整数。 要求が処理されたシステム時刻(1970 年 1 月 1 日 GMT からの経過時間をミリ秒単位で表示)。
detail すべての API 出力文字列。 このパラメータは、応答コードに関する情報を提供します。
deviceId
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 getSessions を使用する場合、deviceId パラメータもオプション入力文字列です。 デバイスの一意の識別子。
deviceRef
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent

出力文字列。 各デバイスの電話番号。

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

downloadUrl
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 raw 形式で録音をダウンロードするために使用される URL。 ただし、downloadUrl は次の 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 秒間です。

API パラメータの説明(E ~ H)

パラメータ API またはイベントの種類 説明と制約
eventAction
  • sessionEvent
  • storageThresholdEvent
  • tagEvent
出力文字列。
  1. eventAction(sessionEvent)パラメータは、新しい録音セッションの開始、または既存の録音セッションの更新、削除、または切り取りを通知します。 列挙値:
    • STARTED
    • UPDATED
    • ENDED
    • DELETED
    • PRUNED
  2. eventAction(storageThresholdEvent)パラメータは、ストレージ ディスク容量が指定したしきい値に達するたびに送信されます。
  3. eventAction(tagEvent)パラメータは、新しいタグの追加、または既存のタグの更新や削除を通知します。 列挙値:
    • ADDED
    • DELETED
eventType
  • sessionEvent
  • storageThresholdEvent
  • tagEvent
出力文字列。 対応する MediaSense API にトリガーされるイベント。 列挙値:
  1. SESSION_EVENT
  2. STORAGE_THRESHOLD_EVENT
  3. TAG_EVENT
fieldConditions
  • getJobResult
  • getJobs
  • getsessions
必須の入力。 文字列のアレイ。 呼び出されたフィールドに指定された条件。 フィールド名に対して複数の条件を指定します。 このパラメータには、fieldOperator、fieldValues、および fieldConnector の詳細が含まれます。 このパラメータを使用する API によって列挙値は異なります。
fieldConnector
  • getJobResult
  • getJobs
  • getsessions

アレイ内に 1 個のフィールドがある場合のオプション入力文字列。 アレイ内に 2 個以上のフィールドがある場合に必要な入力文字列。 継続的条件により条件を論理接続するために使用します。 優先順位のルールを参照してください。

列挙値:

  • かつ
  • または
fieldName
  • getJobResult
  • getJobs
  • getsessions
必須の入力文字列。 呼び出されたフィールドの名前。 このパラメータを使用する API によって列挙値は異なります。
fieldOperator
  • getJobResult
  • getJobs
  • getsessions
必須の入力文字列。 [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
  • getJobResult
  • getJobs
  • getsessions
必須の入力。 文字列のアレイ。 このアレイに渡される値の数は、[Each fieldOperator] セクションの [Values Expected] で指定された fieldOperator によって異なります。 このパラメータに正規表現は使用できません(* や + など)。 このパラメータを使用する API によって列挙値は異なります。
forwardedEvent
  • sessionEvent
  • storageThresholdEvent
  • tagEvent
イベントが MediaSense サーバでローカルに生成された場合、および転送が無効の場合、このフィールドは省略されます。 MediaSense 展開では、イベント転送がデフォルトで無効になっています。 列挙値:
  • TRUE = 有効
  • FALSE(デフォルト) = 無効
httpUrl
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent

このパラメータはリリース 10 で非推奨になり、代わりに mp4Url が推奨されています。 出力文字列。 セッションの HTTPS リンク。 セッション状態が CLOSED_NORMAL の場合にのみ URL が存在します。 httpUrl パラメータに最大 512 文字を入力できます。

(注)     

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

API パラメータの説明(I ~ L)

パラメータ API またはイベントの種類 説明と制約
isConference
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力ブール。 参加者オブジェクト内で使用されます。 参加者が会議ブリッジまたは個々のデバイスであるかどうかを示します。 (注:特定のケースでは、1 人の参加者が会議ブリッジを代表することもあります)。
JSESSIONID すべての API 出力文字列と必須の入力文字列の両方。 JSESSIONID はヘッダー パラメータです。 これは、セッション識別子であり、後続の要求の認証手段として機能します。 JSESSIONID は、ユーザが明示的にログアウトした時点、または非アクティブになってから 30 分後(どちらか早い方)に期限切れになります。
job JobResult 出力ジョブ オブジェクト。 要求されたジョブの詳細。
jobDuration
  • getJobById
  • getJobResult
  • getJobs
getJobById または getJobResult を使用する場合の出力整数。 getJobs を使用する場合のオプション入力整数。 jobStartTime からこのジョブが終了するまでの時間(ミリ秒単位)。
jobId
  • cancelJob
  • deleteJob
  • getJobById
  • getJobResult
  • getJobs
  • deleteSessions
getJobs を使用する場合のオプション入力文字列。 他のすべての API またはイベントを使用する場合の出力文字列。 ジョブ管理フレームワークにより作成および管理されるジョブ。 この jobID はシステムにより生成されます。 ジョブ管理およびジョブ クエリー API とともにこの jobID を使用します。
jobOperationsResultset getJobResult 出力。 文字列のアレイ。 特定のジョブに対する個々の操作結果のセットを表します。
jobState
  • getJobById
  • getJobResult
  • getJobs
getJobById または getJobResult を使用する場合の出力文字列。 getJobs を使用する場合のオプション入力文字列。 ジョブ ステータスを取得した後、ポーリング時の値に基づいて適切な値がデータベースから取得されます。
jobs
  • getJobById
  • getJobs
出力。 ジョブ オブジェクトのアレイ。 ジョブのリストと各ジョブと詳細。
jobStartTime
  • getJobById
  • getJobResult
  • getJobs
getJobById または getJobResult を使用する場合の出力整数。 getJobs を使用する場合のオプション入力整数。 1970 年 1 月 1 日 GMT からこのジョブの開始までに経過した時間(ミリ秒単位)。 このジョブの実行が開始する時刻。
jobType
  • getJobById
  • getJobResult
  • getJobs
getJobById または getJobResult を使用する場合の出力文字列。 getJobs を使用する場合のオプション入力文字列。 ジョブの目的。 たとえば、セッションを一括削除することです。 大文字と小文字を区別します。 列挙値は BULK_DELETE_SESSIONS です。
limit
  • getJobResult
  • getJobs
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
必須の入力整数。 返されるレコード数(指定したオフセットから数えます)。 pageParameters 内で必須です。 オフセット パラメータと併用する必要があります。 デフォルトでは、最初の 100 件のレコードを返します。 ゼロ(0)より大きな正の値。 このパラメータの最大値は 1000 です。

API パラメータの説明(M ~ P)

パラメータ API またはイベントの種類 説明と制約
maxSessionStartDate
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
オプション入力整数。 minSessionStartDate に固有の値がない場合に必須の入力整数です。 1970 年 1 月 1 日 GMT からセッション録音の開始まで、より正確にはこのセッションの最初のトラックが録音を開始するまでに経過した時間(ミリ秒単位)。 minSessionStartDate または maxSessionStartDate が欠落している場合、その方向に 2 時間と見なされます。
mediaType
  • startRecording
  • getSessionsByMediaType
出力文字列。 必須の入力文字列。 作成中のメディアのタイプを示します。 大文字と小文字を区別します。 列挙値:
  • AUDIO
  • VIDEO
mediaStreams startRecording 必須の入力。 mediaTypes のアレイ。 作成中のメディア ストリーム。 各ストリームはメディア タイプです。 したがって、mediaStreams はメディア タイプのアレイです。 録音には、少なくとも 1 個のメディア ストリームが必要です。 アレイは順序付けされていません。
minSessionStartDate
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
オプション入力整数。 1970 年 1 月 1 日 GMT からセッション録音の開始まで、より正確にはこのセッションの最初のトラックが録音を開始するまでに経過した時間(ミリ秒単位)。 minSessionStartDate または maxSessionStartDate が欠落している場合、その方向に 2 時間と見なされます。
mp4Url
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
出力文字列。 セッションの 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 storageThresholdEvent 出力整数。 システムにより割り当てられた数値。 nodeId はシステム定義のため定義できません。
nodeIPAddress
  • storageThresholdEvent
  • getSessions
出力文字列。 Cisco MediaSense サーバの IP アドレス。 nodeIPAddress パラメータに最大 54 文字を入力できます。
offset
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
オプション入力整数。 pageParameters 内の必須の入力整数になります。 返される最初のレコード。 limit パラメータと併用する必要があります。 ゼロ(0)から始まる整数値。
order
  • getJobResult
  • getJobs
  • getSessions
オプション入力文字列。 sortParameters 内の必須の入力文字列になります。 大文字と小文字を区別します。 列挙値:
  • ASC= Ascending:最小値を最初にして結果を並べ替えます。
  • DESC=Descending:最大値を最初にして結果を並べ替えます。
operationData getJobResult 出力文字列。 オプション入力文字列。 ジョブ内の個々の操作の入力データ。 大文字と小文字を区別します。
operationID getJobResult 出力文字列。 オプション入力文字列。 ジョブ内の個々の操作。 大文字と小文字を区別します。
operationResponse getJobResult 出力文字列。 オプション入力文字列。 ジョブ内の個々の操作の応答。 大文字と小文字を区別します。
operationsCompleted getJobById 出力整数。 このジョブで完了した操作の数。 この数は、いつこのパラメータが呼び出されたかによって異なります。 ゼロ(0)から始まるカウンタ。
operationsRemaining getJobById 出力整数。 このジョブで残っている操作の数。 この数は、いつこのパラメータが呼び出されるかによって異なります。
pageParameters
  • getJobResult
  • getJobs
  • getSessions
オプション入力。 JSON オブジェクト。 クライアントが要求結果表現の特定のサブセットを要求できるようにします。 返すための要素を指定します。 これを使用すると、最初の 1000 セッションを返します。 limit パラメータおよび offset パラメータも指定する必要があります。 関連情報については、各パラメータを参照してください。
paramConnector
  • getJobResult
  • getJobs
  • getSessions
アレイにフィールドが 1 つしかない場合のオプション入力文字列。 アレイに 2 つ以上のフィールドがある場合に必須の入力文字列。 RequestParameters のアレイで 2 個の要素間の論理接続を指定するために使用します。 大文字と小文字を区別します。 列挙値:
  • かつ
  • または
partition
  • storageThresholdEvent
  • getSessions
出力文字列。 記憶域を使用するデータストアの名前。 partition パラメータに最大 128 文字を入力できます。
participantDuration
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 セッション内で参加者がアクティブだった期間(ミリ秒単位)。
(注)      この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。
参加者
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
参加者オブジェクトの出力 JSON アレイ。 各オブジェクトには、deviceRef、participantStartDate、participantDuration、isConference、および xRefCi パラメータの詳細が含まれます。 関連情報については、これらのパラメータをそれぞれ参照してください。
participantStartDate
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 1970 年 1 月 1 日 GMT からこのトラックの録音が開始されるまでに経過した時間(ミリ秒単位)。
password signIn 必須の入力文字列。 大文字と小文字を区別します。 MediaSense ユーザとしてプロビジョニングされる Unified Communications Manager ユーザのパスワード。 すべての Unified Communications Manager パスワード制限が適用されます。 Unified Border Element が SSH 認証を使用するため、MediaSense はすべての MediaSense ユーザに対し Unified Communications Manager 認証を使用します。
percentageUtilization storageThresholdEvent 出力整数。 録音メディアで使用されるストレージ ディスク容量の割合。 割合のトリガーの詳細については、「ストレージのしきい値」の項を参照してください。
pruned getSessions 出力ブール。 オプション入力ブール。 セッションがシステムによって削除されたかどうかを示します。 ユーザによって削除されたセッションは切り取られたとは見なされません。 セッションが削除されていない場合、pruned は省略されます。 列挙値:
  • TRUE
  • FALSE

API パラメータの説明(Q ~ T)

パラメータ API またはイベントの種類 説明と制約
responseCode すべての API 出力整数。 対応するエラー コード。
responseMessage すべての API 出力文字列。 トラブルシューティングを目的とした responseCode の説明。 これらの説明は変更されることがあります。
rtspUrl
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 複数のトラックを含むことができるセッション全体への参照。 特定のトラックにアクセスするには、rtspUrl の末尾に「-TRACK0」、「-TRACK1」を追加してください。 特定のセッションのトラックは同時に開始および終了します。 URL はセッション継続中は一定です。 httpUrl パラメータに最大 512 文字を入力できます。 列挙値:
  • eventAction = STARTED/UPDATED である場合、rtspUrl = monitor(現在録音されているストリームのモニタリングに使用)です。
  • eventAction = ENDED の場合、rtspUrl = play(保存されたメディアの再生に使用)です。
sessions
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力。 セッション オブジェクトの JSON アレイ。 各オブジェクトには、sessionId、トラック、URL、sessionStartDate、および sessionDuration の値が含まれます。 関連情報については、各パラメータを参照してください。
sessionDuration
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 セッションが継続した時間(ミリ秒単位)。
(注)      この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。
sessionId
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
  • addSessionTag
  • convertSession
  • tagEv

sessionId パラメータは、セッションのシステム生成識別子です。 この値はすべての MediaSense サーバにわたり一意で、最大文字数は 128 です。 セッションは、1 個のセッションが 1 個の MP4 ファイルに変換されるキャプチャ サービスの単位です。

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

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

sessionIdList getAssociatedSessions

sessionIdList パラメータは、複数のカンマ区切りの sessionIds のリストを受け入れます。ただし、現在、最初の sessionId だけが強く関連した sessionIds を返します。 追加の sessionIds は無視されます。 この入力パラメータは、今後の機能拡張のために List タイプで構成されています。

sessionIds deleteSessions セッション ID の出力リスト。
sessionStartDate
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
すべての API とイベントの出力整数。

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

sortParameters
  • getJobResult
  • getJobs
  • getSessions
オプション入力。 JSON アレイ。 この順序付けされたアレイは返された結果の並べ替え方法を指定します。 並べ替えが指定されない場合、デフォルトの並べ替えは startDate に基づいて新しいセッションを最初に配置します。
sessionState
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 セッションのステート。 列挙値:
  • ACTIVE = セッション内の少なくとも 1 個のセッションがアクティブです。
  • CLOSED_NORMAL = セッション内のすべてのセッションがエラーなしで閉じられます。
  • DELETED = ユーザにより削除されたセッションまたはシステムにより切り取られたセッション
  • CLOSED_ERROR = セッション内の少なくとも 1 個のセッションにエラーがあります(録音不可)。
subscriptionFilters
  • subscribeToEvents
  • unsubscribeFromEvents
  • verifyEventSubscription

出力 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
  • unsubscribeFromEvents
  • verifyEventSubscription
  • subscribeRecordingEvent
  • unSubscribeRecordingEvent
  • verifyRecordingSubscription
subscribeToEvents の出力文字列。

リスト内の他のすべての API とイベントに必須の入力文字列。 subscriptionId パラメータは、subscribeRecordingEvent API から受信したシステム生成 ID です。

subscriptionStatus
  • verifyEventSubscription
  • verifyRecordingSubscription
出力文字列。 verifyEventSubscription API または verifyRecordingSubscription API から受信した応答。 列挙値:
  • ACTIVE
  • INACTIVE
subscriptionType
  • subscribeToEvents
  • subscribeRecordingEvent
出力文字列。 サブスクリプションのタイプ。 サーバ ベースのクライアントの場合、タイプは HTTP です。
subscriptionUri
  • subscribeToEvents
  • subscribeRecordingEvent
必須の入力文字列。 イベント通知がサーバ ベースのクライアントに送信される URI。 サブスクリプションは subscriptionUri パラメータで制御されます。 特定の subscriptionUri に対してサブスクリプションが 1 件だけ許可されます。
タグ
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力。 タグ オブジェクトの JSON アレイ。 各オブジェクトには、tagName、tagType、tagCreateDate、および tagOffset パラメータが含まれます。 タグ パラメータに最大 255 文字を入力できます。
tagCreateDate
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
  • tagEvent

出力整数。 1970 年 1 月 1 日 GMT からこのタグの作成までに経過した時間(ミリ秒単位)。
tagName
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
  • tagEvent

出力文字列。 録音を分類するために使用される大文字と小文字を区別しない名前。 このパラメータに最大 255 文字を入力できます。 tagtype = SYSTEM_DEFINED である場合、tagName の列挙値は次のとおりです。
  • タグがセッション レベルにある場合:
    • Pause
    • 再開
  • タグがトラック レベルにある場合:
    • TrackActive
    • TrackInactive
tagNameRegEx
  • subscribeToEvents
  • unsubscribeFromEvents
  • verifyEventSubscription
オプション入力文字列。 タグ イベントだけに適用される Java 正規表現。 この文字列は付加的です。つまり、イベントがサブスクライバが要求したアクションと一致する場合、および tagName がこのパラメータで指定されたサブスクライバのオプション正規表現と一致する場合に、MediaSense が tagEvent をサブスクライバに送信するだけです。 Java 正規表現の詳細については、http:/​/​download.oracle.com/​javase/​tutorial/​essential/​regex/​ を参照してください。
tagOffset
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
  • tagEvent

addSessionTag のオプション整数。 このタグのセッション開始から経過した時間(ミリ秒単位)。 tagOffset を使用して、録音のポイントを指定します。 (たとえば、特定の録音開始から 10 秒後に、予期せぬイベントが発生しました)。これは、リスト内の他のすべての API とイベントの出力整数です。 オフセットはセッションまたはトラックの最初から計算されます(トラック レベルまたはセッション レベルにあるタグは関係ありません)。 オフセットが指定されていない場合、タグはセッション内の特定のポイントではなく、セッション全体に適用されます。
tagType
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
  • tagEvent

出力文字列。 列挙値:
  • SYSTEM_DEFINED = デフォルト。 ユーザによりトリガーされたシステム イベントに使用されます(一時停止と再開、TrackInactive および TrackActive)。
  • USER_DEFINED = ユーザはタグ(addSessionTag API)を作成できます。 ただし、すべてのタグ タイプはシステム定義され、ユーザは tagType の値を再定義できません。
trackDuration
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 トラックが継続した時間(ミリ秒単位)。
(注)      この期間は SIP コール制御情報から取得され、通常、実際のメディアの期間よりも数秒長くなります。
trackMediaType
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 列挙値:
  • AUDIO
  • VIDEO
trackNumber
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 システムで生成されるトラックの一意の識別子。

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

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

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

トラック
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力。 トラック オブジェクトの JSON アレイ。 各オブジェクトには、trackNumber、trackStartDate、trackDuration、trackMediaType、および participants パラメータに関する情報が含まれます。
trackStartDate
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力整数。 1970 年 1 月 1 日 GMT からトラック録音の開始(コール制御サービスが Unified Communications Manager または Unified Border Element から 200 件の OK メッセージを受信した時)までに経過した時間(ミリ秒単位)。 MediaSense はそれに従って Unified Communications Manager または Unified Border Element に確認応答(ACK)を返します。

API パラメータの説明(U ~ Z)

パラメータ API イベントの種類 説明と制約
urls
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力。 JSON オブジェクト。 httpUrl および rtspUrl パラメータの情報が含まれます。
username signIn 必須の入力文字列。 MediaSense ユーザとしてプロビジョニングされる Unified Communications Manager ユーザ。 MediaSense が username(大文字と小文字の区別なし)を使用するのに対し、Unified Communications Manager は「User ID」を使用します。 Unified Comminications Manaer ユーザ ID の制限すべてが適用されます。 Unified Border Element が SSH 認証を使用するため、MediaSense はすべての MediaSense ユーザに対し Unified Communications Manager 認証を使用します。
wavUrl
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent
出力文字列。 セッションの 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
  • startRecording
  • stopRecording
  • getAllActiveSessions
  • getAllPrunedSessions
  • getSessions
  • getSessionsByCCID
  • getSessionsByDeviceRef
  • getSessionsByMediaType
  • getSessionsByTag
  • getSessionBySessionId
  • sessionEvent

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

リスト内のすべての API およびイベントは出力文字列です。getSessionsByCCID は出力文字列とオプション入力文字列の両方です。

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

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

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

ジョブの状態

ジョブの状態 説明
RUNNING ジョブの実行は正常に開始され、引き続き実行されています。
COMPLETED ジョブが正常に完了しました。 注: 「正常に完了しました」とは、すべてのオペレーションが成功したという意味ではなく、このジョブのすべてのオペレーションが正常に試行されたことを単に示します。
CANCELED ジョブは cancelJob API を使用して取り消され、現在は実行されていません。
ERROR システム エラーが原因でジョブは実行を停止しました。

paramConnector および fieldConnector の優先順位ルール

ルール番号 [Details] 説明 クエリーの変換
1 同じフィールドに複数の条件がある場合に、論理優先順位が最も高くなります。 requestParameters アレイの 1 個のフィールドには複数の条件を指定できます。 このクエリは次のようになります。
  • 正:(((deviceRef = 1000 or deviceRef=2000) and tagName=foo) or state=active) And not
  • 誤:(deviceRef = 1000 or (deviceRef=2000 and tagName=foo) or state=active)

deviceRef=1000 or deviceRef=2000 and tagName=foo or state=active

優先順位ルールを使用すると

「and」は「or」よりも優先され

、クエリーは #1 ではなく上記の #2 のようになります。
2 「and」は「or」よりも優先されます。 Param コネクタは、2 つ以上のフィールドを論理接続するために使用されます。 異なるコネクタにより相互に接続された 3 個以上のフィールドがある場合、優先順位を確認する必要があります。 このクエリーは

ambiguous

になり、次のいずれかを意味します。
  • 正:(tagName = tagName1 or deviceRef=1000) and (state=active)
  • 誤:(tagName = tagName1) or (deviceRef=1000 and state=active)

tagName = tagName1 or deviceRef = 1000 and state = active

優先順位ルールを使用すると

「and」は「or」よりも優先され

、クエリーは #1 ではなく上記の #2 のようになります。

API 応答コード

2xxx 成功応答コード

操作が正常に受信され、理解され、受け入れられました。

応答コード 説明
2000 成功:リクエストは正常に完了しました。
2001 成功:このクライアント要求に一致する結果は見つかりませんでした。
2002 成功:セッションのレコーディングが正常に一時停止しましたが、データベースは更新されませんでした。
2003 成功:セッションのレコーディングが正常に再開されましたが、データベースは更新されませんでした。
2004 成功:セッションのレコーディングは正常に削除されましたが、データベースは更新されませんでした。
2005 成功:指定されたサブスクリプション Uri を持つサブスクリプションはすでに存在します。
2006 成功:現在のサブスクリプションは更新され、要求された subscriptionFilters から解除されました。 サブスクリプションはまだアクティブです。

3xxx リダイレクト応答コード

要求を完了するには、クライアントは追加アクションを実行する必要があります。

応答コード 説明
3001 失敗:要求を処理できません。 リダイレクトを指定し、再試行してください。

4xxx クライアント エラー応答コード

要求に不正な構文が含まれているか、要求を実行できません。

応答コード 説明
4000 失敗:要求は無効です。
4001 失敗:安全でない HTTP は許可されません。 要求に HTTPS を使用します。
4005 失敗:データベースには値が見つかりません。 詳細:<parameter name>: <parameter value>
4019 失敗:認証されていない MediaSense ユーザ。
4020 失敗:ログイン認証情報(ユーザ名またはパスワード)は無効です。
4021 失敗:無効なセッションです。 セッションが期限切れになっている可能性があります。 再度ログインするか、または有効な JSESSIONID を入力してください。
4022 失敗:指定したユーザは Finesse スーパーバイザではありません。
4023 失敗:Cisco Finesse サーバへの接続に失敗しました。 Cisco Finesse の設定を確認し、再試行してください。
4030 失敗:この deviceRef を使用してコールを確立できません。 deviceRef を確認し、再試行してください。
4031 失敗:deviceRef が使用できないか、使用中です。 デバイスを確認し、後で再試行してください。
4032 失敗:この deviceRef を使用してコールを接続解除できません。 コールが存在していることを確認し、再試行してください。
4033 失敗:サポートされていない mediaStreams の組み合わせです。 このパラメータの許容ストリームを確認し、再試行してください。
4041 失敗:fieldName パラメータは無効です。
4042 失敗:fieldOperator パラメータは無効です。
4043 失敗:fieldValue パラメータ数が無効です。
4045 失敗:connector パラメータが無効です。
4046 失敗:order パラメータが無効です。
4047 失敗:fieldName パラメータが欠落しています。
4048 失敗:fieldCondition パラメータが欠落しています。
4049 失敗:fieldOperator パラメータが欠落しています。
4050 失敗:fieldValue パラメータが欠落しています。
4051 失敗:fieldConnector パラメータが欠落しています。
4052 失敗:paramConnector パラメータが欠落しています。
4053 失敗:fieldName パラメータが欠落しています。 fieldName でソートできません。
4054 失敗:order パラメータが欠落しています。
4055 失敗:requestParameter が欠落しています。
4056 失敗:無効な JSON 構文です。 構文を確認し、再試行してください。
4057 失敗:1 つ以上の fieldValue パラメータはタイプが不正です。
4058 失敗:tagName パラメータが欠落しています。
4059 失敗:認証プロバイダーが無効です。 有効な認証プロバイダーは、AXL、FINESSE です。
4060 失敗:クライアント要求に値が欠落しています。
4061 失敗:メッセージにパラメータが欠落しています。 詳細:<parameter name>
4062 失敗:パラメータの構文が無効です。 詳細:<parameter name>
4063 失敗:offset パラメータが無効です。
4064 失敗:limit パラメータが無効です。
4070 失敗:セッション ID が無効であるか、アクティブなセッションがありません。
4071 失敗:セッション ID が無効であるか、非アクティブなセッションがありません。
4072 失敗:セッション ID が無効であるか、セッションがありません。
4073 失敗:conversionFormat が無効です。 サポートされている形式を確認し、再試行してください。
4080 失敗:指定された subscriptionUri を持つサブスクリプションはすでに存在します。
4081 失敗:指定された subscriptionUri を持つサブスクリプションは存在しません。
4082 失敗:ACTIVE または ERROR 状態のセッションを変換することはできません。
4090 失敗:jobId が無効であるか、特定のジョブがこの時点で実行されていません。

5xxx サーバ エラー応答コード

サーバは有効と思われる要求を実行できませんでした。

応答コード 説明
5000 失敗:不明なサーバ エラーが発生しました。 後でもう一度試してください。
5001 失敗:データベース エラーが発生しました。 後でもう一度試してください。
5002 失敗:セッションを一時停止できません。 後でもう一度試してください。
5003 失敗:セッションを再開できません。 後でもう一度試してください。
5004 失敗:セッションを削除できません。 後でもう一度試してください。
5006 失敗:セッションを変換できません。 後でもう一度試してください。 詳細:<Reason For Failure>
5020 失敗:Unified Communications Manager の AXL サービスがタイムアウトしました。 後でもう一度試してください。
5021 失敗:Unified Communications Manager の AXL サービスはアクティブになっていません。 サービスをアクティブにし、再試行してください。
5022 失敗:AXL 認証は無効です。 Unified Communications Manager の設定を確認し、再試行してください。
5023 失敗:不明な AXL ホスト。 Unified Communications Manager の設定を確認し、再試行してください。
5024 失敗:不明な AXL サービス エラー。 後でもう一度試してください。
5025 失敗:AXL サービスへの接続が失敗しました。 後でもう一度試してください。
5030 失敗:このシステムに関連する DeviceRef を使用してコールを確立できません。 Unified Communications Manager または Unified Border Element システムへの接続を確認し、再試行してください。
5031 失敗:コールをレコーディングできません。 MediaSense Media Service が動作していることを確認し、再試行してください。
5032 失敗:コールをレコーディングできません。 MediaSense Media Service のディスク容量が不足しています。
5040 失敗:要求を処理できません。 要求されたオペレーションのジョブの状態が無効です。 ジョブの状態を確認し、再試行してください。 詳細:<Job State>
5041 失敗:リクエストがタイムアウトになりました。 要求を再送信します。
5042 失敗:このシステムは、同時要求の最大数を超えました。 後でもう一度試してください。