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

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

はじめに

eventSubscription API は、さまざまなイベント通知のサブスクライブ、サブスクリプションの確認、およびアンサブスクライブを可能にします。

subscribeToEvents

以下のようなイベント通知を受信するのにこの API を使用します。録音が開始した、録音が終了した、録音データが更新された、録音にタグが追加された、録音からタグが削除されたときなど。 すべてのイベント、特定のカテゴリのイベント、特定の種類のイベントをサブスクライブできます。

URI

https://<host>:<port>/ora/eventService/event/subscribeToEvents

HTTP メソッド

POST

パラメータ(Parameters)

  • subscriptionFilters:出力 JSON アレイとオプション入力 JSON アレイ。 イベントのリストまたはイベント カテゴリのリストを指定します。 共有パラメータを参照してください。

  • subscriptionId:出力文字列。 共有パラメータを参照してください。

  • subscriptionType:出力文字列。 サブスクリプションのタイプを指定します。 共有パラメータを参照してください。

  • subscriptionUri:必須入力文字列。 イベント通知がサーバ ベースのクライアントに送信される場所の URI を指定します。 共有パラメータを参照してください。

  • tagNameRegEx:オプション入力文字列。 タグ イベントだけに適用される Java 正規表現です。 共有パラメータを参照してください。


(注)  


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


例 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」パラメータが指定されていないときとまったく同じように、サブスクリプション全体が削除されます。

  • イベント タイプが残っている限り、応答には残りのサブスクリプション フィルタのリストが含まれます。

URI

https://<host>:<port>/ora/eventService/event/unsubscribeFromEvents

HTTP メソッド

POST

パラメータ(Parameters)

  • subscriptionId:必須入力文字列。 共有パラメータを参照してください。

  • subscriptionFilters:出力 JSON アレイとオプション入力 JSON アレイ。 イベントのリストまたはイベント カテゴリのリストを指定します。 共有パラメータを参照してください。

  • tagNameRegEx:オプション入力文字列。 タグ イベントだけに適用される Java 正規表現です。 共有パラメータを参照してください。

例 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 を使用します。

URI

https://<host>:<port>/ora/eventService/event/verifyEventSubscription

HTTP メソッド

POST

パラメータ(Parameters)

  • subscriptionFilters:出力 JSON アレイとオプション入力 JSON アレイ。 イベントのリストまたはイベント カテゴリを指定します。 共有パラメータを参照してください。

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

  • subscriptionStatus:出力文字列。 API から受信した応答です。 共有パラメータを参照してください。

  • tagNameRegEx:オプション入力文字列。 タグ イベントだけに適用される Java 正規表現です。 共有パラメータを参照してください。

例 1

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

HTTPS POST:

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

ヘッダー:

{
   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 を使用します。録音が開始した、録音が終了した、録音データが更新された、録音にタグが追加された、録音からタグが削除されたときなど。

URI

https://<host>:<port>/ora/eventService/event/subscribeRecordingEvent

HTTP Post

POST

パラメータ(Parameters)

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

  • subscriptionType:出力文字列。 サブスクリプションのタイプです。 共有パラメータを参照してください。

  • subscriptionUri:必須入力文字列。 イベント通知がサーバ ベースのクライアントに送信される場所の URI です。 共有パラメータを参照してください。


(注)  


同じ subscriptionUri がもう一度登録されると、エラーが返されます。その中には元の subscriptionId が含まれます。


関連イベント

storageThresholdEvent:このイベントは、ストレージのディスク容量が各種しきい値に達するたびに送信されます。 詳細については、storageThresholdEventを参照してください。

unsubscribeRecordingEvent(非推奨)

録音イベントの受信を停止するには、この API を使用します。

URI

https://<host>:<port>/ora/eventService/event/unsubscribeRecordingEvent

HTTP メソッド

POST

パラメータ

subscriptionId:必須入力文字列。 システム生成 ID です。 参照先 共有パラメータ

verifyRecordingSubscription(非推奨)

録音サブスクリプションがアクティブかどうかを確認するには、この API を使用します。

URI

https://<host>:<port>/ora/eventService/event/verifyRecordingSubscription

HTTP メソッド

POST

パラメータ

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

  • subscriptionStatus:出力文字列。 API から受信した応答です。 共有パラメータを参照してください。


(注)  


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