Skip to content

VideoChat Profile

Jump to bottom
Ryo Mizuno edited this page Mar 31, 2016 · 2 revisions

目次

API 機能概要
VideoChat Get Profile API プロフィール情報を取得する。
VideoChat Update Profile API プロフィール情報を更新する。
VideoChat Get Address API 接続先のアドレス一覧を取得する。
VideoChat Call API VideoChatの接続を行う。
VideoChat Stop Call API 接続中のビデオチャットの切断を行う。
VideoChat Incoming Event API 他デバイスからの着信イベントを受領する。
VideoChat OnCall Event API 通話開始イベントを受領する。
VideoChat Hangup Event API 切断イベントを受領する。

機能概要

スマートデバイスが持つビデオチャットを操作する機能を提供する。

参考API

なし

VideoChat Get Profile API

インターフェース名称 Version 種別
VideoChat Get Profile API 2.0.0 同期I/F

概要

プロフィール情報を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/videochat/profile
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
名前 name string - デバイス自身の名前
アドレスID addressId string - デバイス自身のアドレスID

リクエストサンプル

GET http://localhost:4035/gotapi/videochat/profile?accessToken=xxxxx&serviceId=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "name":"WebRTC Service",
    "addressId": "xxxxx"
}

VideoChat Update Profile API

インターフェース名称 Version 種別
VideoChat Update Profile API 2.0.0 同期I/F

概要

プロフィールを更新する。

リクエスト

HTTPメソッド URI
PUT /gotapi/videochat/profile
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
名前 name string - デバイスに付ける新規の名前
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/videochat/profile
PUTデータ
accessToken=xxxxx&serviceId=xxxxx&name=xxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

VideoChat Get Address API

インターフェース名称 Version 種別
VideoChat Get Address API 2.0.0 同期I/F

概要

接続先のアドレス一覧を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/videochat/address
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
アドレスID addressId string ○ 指定しない場合は、接続できるすべてのアドレスを返却する
指定した場合は、接続先アドレスに対応する情報のみ取得できる
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
アドレス一覧 addresses array - アドレス一覧を格納する配列
デバイス名 name string - デバイス名
接続先アドレスID addressId string - 接続先のアドレス
状態 status string - デバイスの状態
  • idle: 待機状態
  • calling: 発信状態
  • talking: 通話中

リクエストサンプル

GET  http://localhost:4035/gotapi/videochat/address?accessToken=xxxxx&serviceId=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "addresses": [
        {
            "name": "Sample 1",
            "addressId": "xxxxxx",
            "status": "idle"
        },
        {
            "name": "Sample 2",
            "addressId": "xxxxx",
            "status": "calling"
        },
        {
            "name": "Sample 3",
            "addressId": "xxxxx",
            "status": "talking"
        }
    ]
}

VideoChat Call API

インターフェース名称 Version 種別
VideoChat Call API 2.0.0 同期I/F

概要

VideoChatの接続を行う。

リクエスト

HTTPメソッド URI
POST /gotapi/videochat/call
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
接続先アドレスID addressId string - 接続先のアドレス
映像リソースURI video string ○
  • true: デバイス標準のカメラから取得できる映像を利用する。
  • false: 映像リソースを利用しない。
  • URI: 指定されたURIの映像リソースを利用する。
省略された場合は、trueと同じ扱い。
音声リソースURI audio string ○
  • true: デバイス標準のマイクから取得できる映像を利用する。
  • false: 音声リソースを利用しない。
  • URL: 指定されたURIの音声リソースを利用する。
省略された場合は、trueと同じ扱い。
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列
出力設定 outputs string ○
  • HOST表示: host
  • アプリケーション表示:app
ホストデバイスの画面上に表示する場合はhostを指定する。省略された場合はhost指定として動作する。アプリケーション等でURIを参照して表示する場合は、appを指定する。
サンプリング周波数 audioSampleRate number ○
  • 48000
  • 44100
  • 32000
  • 22050
サンプリング周波数を設定する。省略された場合は48000。
量子化ビット数 audioBitDepth string ○
  • PCM_8BIT
  • PCM_16BIT
  • PCM_FLOAT
量子化ビット数を設定する。省略された場合はPCM_FLOAT。
チャンネル数 audioChannel string ○
  • Monaural
  • Stereo
チャンネル数を設定する。省略され場合は、Monaural。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

POST  http://localhost:4035/gotapi/videochat/call
POSTデータ
serviceId=xxxxx&accessToken=xxxxx&addressId=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

VideoChat Stop Call API

インターフェース名称 Version 種別
VideoChat Stop Call API 2.0.0 同期I/F

概要

接続中の Video Chat の切断を行う。

リクエスト

HTTPメソッド URI
DELETE /gotapi/videochat/call
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
接続先アドレスID addressId string - 接続先のアドレス
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE  http://localhost:4035/gotapi/videochat/call?accessToken=xxxxx&serviceId=xxxxx&addressId=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

VideoChat Incoming Event API

インターフェース名称 Version 種別
VideoChat Incoming Event API 2.0.0 同期I/F

概要

他デバイスからの着信イベントを受領する。

リクエスト

HTTPメソッド URI
PUT /gotapi/videochat/incoming
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
セッションキー sessionKey string - セッションキー
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/videochat/incoming
PUTデータ
accessToken=xxxxx&serviceId=xxxxx&sessionKey=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト incoming object - 発信元デバイスの情報を格納したオブジェクト。
デバイス名 name string - 発信元デバイスの名前。
接続先アドレスID addressId string - 発信元デバイスのアドレス。

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "servieId":  "xxxxx",
    "sessionKey" : "xxxxx",
    "profile" : "videochat",
    "attribute" : "incoming",
    "incoming" : {
        "name": "xxxx",
        "addressId": "xxxx"
    }
}

VideoChat OnCall Event API

インターフェース名称 Version 種別
VideoChat OnCall Event API 2.0.0 同期I/F

概要

通話開始イベントを受領する。

リクエスト

HTTPメソッド URI
PUT /gotapi/videochat/oncall
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
セッションキー sessionKey string - セッションキー
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/videochat/oncall
PUTデータ
accessToken=xxxxx&serviceId=xxxx&sessionKey=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト oncall array - 通話を開始したデバイスの情報の配列。
デバイス名 name string - 発信元デバイスの名前。
接続先アドレスID addressId string - 発信元デバイスのアドレス。
相手局リソース情報 remote array ○ 相手局リソース情報
映像関連情報 video array ○ 映像関連情報
映像リソースURI uri string ○ 映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い。
MIME Type mimeType string ○ 映像リソースのMIMEタイプ。
フレームレート frameRate number ○ 映像リソースのフレームレート。
幅 width number ○ 通知時点での幅（可変）
高さ height number ○ 通知時点での高さ（可変）
音声関連情報 audio array ○ 音声関連情報
音声リソースURI uri string ○ 音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
MIME Type mimeType string ○ 音声リソースのMIMEタイプ。
サンプルレート sampleRate number ○ 音声リソースのサンプルレート。
チャンネル数 channels number ○ 音声リソースのチャンネル数。
サンプルサイズ sampleSize number ○ 音声リソースのサンプルサイズ。
ブロックサイズ blockSize number ○ 音声リソースのブロックサイズ。
自局リソース情報 local array ○ 自局リソース情報
映像関連情報 video array ○ 映像関連情報
映像リソースURI uri string ○ 映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い。
MIME Type mimeType string ○ 映像リソースのMIMEタイプ。
フレームレート frameRate number ○ 映像リソースのフレームレート。
幅 width number ○ 通知時点での幅（可変）
高さ height number ○ 通知時点での高さ（可変）
音声関連情報 audio array ○ 音声関連情報
音声リソースURI uri string ○ 音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
MIME Type mimeType string ○ 音声リソースのMIMEタイプ。
サンプルレート sampleRate number ○ 音声リソースのサンプルレート。
チャンネル数 channels number ○ 音声リソースのチャンネル数。
サンプルサイズ sampleSize number ○ 音声リソースのサンプルサイズ。
ブロックサイズ blockSize number ○ 音声リソースのブロックサイズ。

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "servieId":  "xxxxx",
    "sessionKey" : "xxxxx",
    "profile" : "videochat",
    "attribute" : "oncall",
    "oncall" : [
        {
            "name": "xxxx",
            "addressId": "xxxx"
        }
    ]
}

VideoChat Hangup Event API

インターフェース名称 Version 種別
VideoChat Hangup Event API 2.0.0 同期I/F

概要

切断イベントを受領する。

リクエスト

HTTPメソッド URI
PUT /gotapi/videochat/hangup
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイスのID
セッションキー sessionKey string - セッションキー
コンフィグ config string ○ 必要に応じてAPIキーなどを格納する任意の文字列。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/videochat/hangup
PUTデータ
accessToken=xxxxx&serviceId=xxxxx&sessionKey=xxxxx&config=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト hangup array - 発信元デバイスの情報を格納したオブジェクト
接続先アドレスID addressId string - 発信元デバイスのアドレス

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "servieId":  "xxxxx",
    "sessionKey" : "xxxxx",
    "profile" : "videochat",
    "attribute" : "hangup",
    "hangup" : {
        "addressId": "xxxx"
    }
}
  1. アプリケーション開発マニュアル
  2. 単体テスト動作マニュアル

Clone this wiki locally