Phone - masaru-takano/DeviceConnect-Spec GitHub Wiki

周辺機器からスマートフォンの通話機能もしくは通話操作機能を提供するAPI。

API	概要
POST /gotapi/phone/call	スマートフォンに対して電話発信要求をリクエストする。
GET /gotapi/phone/onConnect	スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを取得する。
PUT /gotapi/phone/onConnect	スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを開始する。
DELETE /gotapi/phone/onConnect	スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを停止する。
PUT /gotapi/phone/set	スマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定をリクエストする。

one-shot

スマートフォンに対して電話発信要求をリクエストする。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
phoneNumber	string	Yes	電話番号。電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。

物理名	データ型	必須	説明
result	integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product	string	Yes	DeviceConnectシステムの名前
version	string	Yes	DeviceConnectシステムのバージョン名
hmac	string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを取得する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

物理名		データ型	必須	説明
result		integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
phoneStatus		object	Yes	電話機能の状態 電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
	phoneNumber	string	Yes	電話番号 相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
	state	float	Yes	通話状態 通話状態を示す定数。 0: 通話開始 1: 通話失敗 2: 通話終了
product		string	Yes	DeviceConnectシステムの名前
version		string	Yes	DeviceConnectシステムのバージョン名
hmac		string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}

event

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを開始する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

物理名	データ型	必須	説明
result	integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product	string	Yes	DeviceConnectシステムの名前
version	string	Yes	DeviceConnectシステムのバージョン名
hmac	string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

物理名		データ型	必須	説明
phoneStatus		object	Yes	電話機能の状態 電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
	phoneNumber	string	Yes	電話番号 相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
	state	float	Yes	通話状態 通話状態を示す定数。 0: 通話開始 1: 通話失敗 2: 通話終了
attribute		string	Yes	アトリビュート名
serviceId		string	Yes	サービスID
interface		string	Yes	インターフェース名
profile		string	Yes	プロファイル名

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "phone",
  "attribute" : "onconnect",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}

event

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを停止する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

物理名	データ型	必須	説明
result	integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product	string	Yes	DeviceConnectシステムの名前
version	string	Yes	DeviceConnectシステムのバージョン名
hmac	string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定をリクエストする。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	integer	Yes	電話のモード。電話のモードを指定 0:サイレント 1:マナー 2:音あり

物理名	データ型	必須	説明
result	integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product	string	Yes	DeviceConnectシステムの名前
version	string	Yes	DeviceConnectシステムのバージョン名
hmac	string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}