Phone Profile

目次

API	機能概要
Phone Call API	周辺機器からスマートフォンに対して電話発信要求を依頼する。
Phone Setting API	周辺機器からスマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定を依頼する。
Phone Connect API	周辺機器からスマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知する。

機能概要

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

参考API

https://developer.mozilla.org/en-US/docs/Web/Guide/API/Telephony?redirectlocale=en-US&redirectslug=Web%2FGuide%2FTelephony

Phone Call API

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

概要

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

リクエスト

HTTPメソッド	URI
POST	/gotapi/phone/call

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

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

POST  http://localhost:4035/gotapi/phone/call

POSTデータ
serviceId=localhost.deviceconnect.org&phoneNumber=090xxxxxxxx&accessToken=xxxxx

レスポンスサンプル

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

Phone Setting API

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

概要

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

リクエスト

HTTPメソッド	URI
PUT	/gotapi/phone/set

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
電話のモード	mode	number	-	電話のモードを指定 0:サイレント 1:マナー 2:音あり

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/phone/set

PUTデータ
serviceId=localhost.deviceconnect.org&mode=1&accessToken=xxxxxx

レスポンスサンプル

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

Phone Connected Event API

インターフェース名称	Version	種別
Phone Connect Event API	2.0.0	非同期I/F(イベントI/F)

概要

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

イベント情報

イベント名	Content-Type
/gotapi/phone/onconnect	application/json

メッセージ

論理名	物理名		データ型	省略	設定値
オブジェクト	phoneStatus		object	-	イベントの内容を保持するオブジェクト
電話番号		phoneNumber	string	-	電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
通話状態		state	number	-	スマートフォンの通話状態を返す 0:通話開始 1:通話失敗 2:通話終了

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "serviceId":"localhost.deviceconnect.org",
    "api" : "gotapi",
    "profile":"phone",
    "attribute":"onconnect",
    "sessionKey":"0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "phoneStatus":{
        "phoneNumber":"090xxxxxxxx",
        "state":0
    }
}