近接センサー API

近接センサーの値を取得

デバイスに耳や手が当たっているなどの近接センサーの値を取得します。

基本情報

APIパス : /gotapi/proximity/onuserproximity

HTTPメソッド : GET

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
proximity Object
near 真偽値
product 文字列
version 文字列

近接センサーの通知イベントを設定

近接センサーの値が変わった時にイベント通知する設定を行います。イベントの通知はWebSocketでくるので、近接センサーAPI(WebSocket)を参照してください。

基本情報

APIパス : /gotapi/proximity/onuserproximity

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
sessionKey 文字列 クエリー WebSocketで受け取るための一意のキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

近接センサーの通知イベントを削除

近接センサーの値が変わった時の通知イベントを削除します。

基本情報

APIパス : /gotapi/proximity/onuserproximity

HTTPメソッド : DELETE

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
sessionKey 文字列 クエリー WebSocketで受け取るための一意のキー

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列