カスタマーサポートポータルのデバイス登録API

Ooyala Rights Locker APIの一部として、OoyalaのRESTベースのデバイス登録API がカスタマーサポートツール構築に使用できます。APIは、カスタマーサポートが使うプロバイダーの管理 ポータルを提供しているサーバーからコールされるよう設計されています。APIは 次のような機能があります。

  • お客様に固有のアカウントの削除、追加、エラー履歴を1年までさかのぼって取得
  • 特定アカウントでのデバイス制限のオーバーライド
  • 特定カウントでのデバイス情報の更新
  • 削除制限数を増加させずにデバイスを削除
注: これらコールのエンドポイントはrl.ooyala.comです。

更新/削除のアクターについて

リモート設定の更新または削除に PUTDELETE に依存するリクエストでは、操作に必要とされるその他プロパティに加えて、 リクエストボディは、actor値が管理者のユーザー名である次のプロパティを 含まなければいけません。
{
     .
     .
     .
     "actor" : "admin username"
     "actor_type" : "admin" 
     .
     .
     .
}               

視聴者の登録デバイスの一覧を取得

[GET] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/devices

レスポンス

レスポンスでは、 devicesは、視聴者が登録した各デバイスのための次のフィールドを含んだ配列です。

{
    “device_limit” : “maximum number of devices allowed”,
    “next_delete_time” : “time at which the device can be deleted (ISO 8601)”
    “devices”:
           [
              {
                 "public_device_id": “sample_device_id”,
                 "user_agent": ”sample_user_agent”,
                 "registration_time": “time at which registered (ISO 8601)”
                 "nickname": “device_nickname”
              },
              .
              .
              .
               ] 
}
         

アカウントの全アクション履歴を取得

アカウント履歴は、サポートに使用され、デバイスの削除、名前変更、デバイスのアカウント への追加といったお客様の問題を診断します。アカウント履歴はどんなアクションが 取られたか、いつ取られたのか、誰によってといったことを表示します。

[GET] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/history

レスポンス

[
   {
     “public_device_id”: “sample_device_id”,
     “user_agent”: “sample_user_agent”,
     “action_time”: “time at which action occurred (ISO 8601)”,
     “action”: “sample_action”,
     “nickname”: “”,
     "actor": “sample_actor”
   },
   .
   .
   .
]
         
  • action_time:アクションが起こった時間
  • action:デバイス登録、デバイスの削除、デバイスのニックネームの追加を含む、実行ずみアクション
  • actor:カスタマーサポートAPIがアクションをコールした場合、ユーザーアカウント IDまたは管理サポートが電子メールを送信します。

単一デバイスを削除

[DELETE] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/devices/public_device_id
{
     "actor"      : "admin username"
     "actor_type" : "admin" 
}

レスポンス

200 {"message":"OK"} - リクエストが成功しました

404 {"message" "device does not exist"} - pcodeaccount_id 見つかりません。

全デバイスを削除

[DELETE] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/devices
{
     "actor"      : "admin username"
     "actor_type" : "admin" 
}

レスポンス

200 {"message":"OK"} - リクエストが成功しました

404 {"message" "device does not exist"} - pcodeaccount_id 見つかりません。

デバイス制限の編集

[PUT] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/device_limit
{
     "device_limit": device_limit
}

レスポンス

200 {"message":"OK"} - リクエストが成功しました

404 {"message" "device does not exist"} - pcodeaccount_id が見つかりません

デバイス制限の取得

[GET] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/device_limit

レスポンス

{
  “device_limit”: “actual limit”,
}
         

デバイスのニックネームを更新

[PUT] rl.ooyala.com/v2/device_management/pcode/pcode/account_id/account_id/devices/public_device_id
{
     "nickname"     : "someNickname"
     "actor"           : "admin username"
     "actor_type" : "admin" 
}

レスポンス

200 {"message":"OK"} - リクエストが成功しました。

404 {"message" "device does not exist"} - pcodeaccount_id が見つかりません

この記事はお役にたちましたか?