2.2 デバイスの API

2.2.1 ゲートウェイの追加 (/api/v3/gateway/add) ※開発中機能のためご利用できません

概要

ゲートウェイデバイスを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/add

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

identifier

string

Yes

SNB など、デバイスタイプの識別子

name

string

Yes

デバイス名

location

string

必須

デバイスの設置場所

ip

string

Yes

ゲートウェイ IP

port

int

Yes

ゲートウェイポート

account

string

Yes

ゲートウェイのログインアカウント

password

string

Yes

ゲートウェイのログインパスワード

認証パラメーター

パラメーター名

型

Yes

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"id": 1561,
		"name": "SNB",
		"location": "306",
		"direction": 0,
		"description":"",
		"ldid": "SNB-2ee63f9c699a7316a3e2a44646d0c844",
		"type_id": 10,
		"type_name": "SNB",
		"update_at": 1574854584,
		"create_at": 1574670842
	}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

デバイスの ID

name

string

名前

location

string

設置場所

description

string

デバイスの説明

direction

int

デバイスのアクセス方向

ldid

string

デバイスの LDID 番号

type_id

int

デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）

type_name

string

デバイスタイプ名

update_at

long

更新時間

create_at

long

作成時間

エラーレスポンスのフィールド

コード

メッセージ

説明

498

Param Invalid

パラメーターエラー

2.2.2 カメラの追加 (/api/v3/camera/add) ※開発中機能のためご利用できません

概要

カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/add

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

Yes

説明

channel

int

Yes

チャンネル

identifier

string

Yes

CAM など、デバイスタイプの識別子

gateway_id

string

Yes

ゲートウェイID

protocol

int

Yes

プロトコルタイプ。1 = RTSP、2 = ONVIF、3 = GB28181 を示します。

camera_name

string

Yes

カメラ名

location

string

Yes

カメラの設置場所

snap_mode

int

Yes

スナップモード。1 = 精密、2 = 時間制、3 = リアルタイムを示します。

url

string

条件による

RTSP モードはパスする必要があります

ip

string

条件による

カメラ ip、ONVIF GB28181 モードはパスする必要があります

port

int

条件による

カメラポート、ONVIF GB28181 モードはパスする必要があります

account

string

条件による

カメラのログインアカウント、ONVIF モードはパスする必要があります

password

string

条件による

カメラのログインパスワード、ONVIF モードはパスする必要があります

server_id

string

条件による

SIP サーバーの SIP ID、GB28181 モードはパスする必要があります

camera_id

string

条件による

カメラの SIP ID、GB28181 モードはパスする必要があります

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "data": {
 "id": 1562,
 "name": "40F",
 "location": "40F",
 "description": "",
 "direction": 0,
 "ldid": "CAM-b054ac85cb84137b75abaa2bd7fc4a38",
 "type_id": 11,
 "type_name": "CAM",
 "update_at": 1574851340,
 "create_at": 1574851340
 }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

デバイスのID

name

string

名前

location

string

設置場所

description

string

説明

direction

int

デバイスのアクセス方向

ldid

string

デバイスの LDID 番号

type_id

int

デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）

type_name

string

デバイスタイプ名

update_at

long

更新時間

create_at

long

作成時間

エラーレスポンスのフィールド

コード

メッセージ

説明

498

Param Invalid

パラメーターエラー

2.2.3 デバイスの更新 (/api/v3/device/update)

概要

デバイス情報を更新します。(ゲートウェイデバイスはグループに連携できません)

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://HOST:PORT/api/v3/device/update

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスのID

name

string

No

名前

location

string

No

設置場所

description

string

No

説明

direction

int

No

デバイスのアクセス方向。1 = In、2 = Out

group_staff

list<long>

No

従業員グループ (id のグループ)

group_visitor

list<long>

No

ビジターグループ (id のグループ)

group_blacklist

list<long>

No

ブラックリストグループ (id のグループ)

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "id": 2,
        "name": "勤務グループ ",
        "location": "日本東京都千代田区",
        "state": 0,
        "description": "",
        "direction": 1,
        "ip": "",
        "ldid": "SHL-3931ff3bd1fd7157866c4d22858c533c",
        "type_id": 1,
        "type_name": "SenseHello",
        "user_group": [{
            "id": 1,
            "name": "Default group",
            "type": 1,
            "devices": [],
            "is_default": 1,
            "person_count": 19988
        }],
        "guest_group": [ {
            "id": 105,
            "name": "test",
            "type": 2,
            "devices": [],
            "is_default": 0,
            "person_count": 5
        }],
        "blacklist_group": [ {
            "id": 148,
            "name": "User_1560842344639",
            "type": 5,
            "devices": [],
            "is_default": 0,
            "person_count": 23
        }],
        "update_at": 0,
        "create_at": 0,
        "last_offline_time":0
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

デバイスの ID

name

string

デバイス名

location

string

デバイスの設置場所

state

string

デバイスのステータス

description

string

説明

direction

int

デバイスのアクセス方向。0 - デフォルト（Null）、1 - In、2 - Out

ip

string

IP アドレス

ldid

string

デバイスの sn 番号

type_id

int

デバイスタイプ

type_name

string

デバイスタイプ名

user_group

list<group>

従業員グループ

guest_group

list<group>

ビジターグループ

blacklist_group

list<group>

ブラックリストグループ

update_at

long

デバイスの最新の更新タイムスタンプ

create_at

long

デバイスの最初のオンラインタイムスタンプ

last_offline_time

long

デバイスの最新のオフラインタイムスタンプ

group フィールドの説明

パラメーター名

型

説明

id

long

グループ ID

name

string

グループ名

type

int

グループタイプ

is_default

int

デフォルトのグループかどうかを示します

person_count

int

グループ内の人数を示します

エラーレスポンスのフィールド

コード

メッセージ

説明

498

Param Invalid

パラメーターエラー

2.2.4 デバイスの削除 (/api/v3/device/delete)

概要

デバイス (ゲートウェイまたはカメラデバイス) を削除します。

v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。

リクエストアドレスの例

https://HOST:PORT/api/v3/device/delete

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

エラーレスポンスのフィールド

code

メッセージ

説明

498

Param Invalid

パラメーターエラー

600

Sync Failed

RPC が失敗しました

2.2.5 サブカメラのリストの取得 (/api/v3/gateway/cameraList) ※開発中機能のためご利用できません

概要

カメラのリストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/gateway/cameraList

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

gateway_id

long

Yes

ゲートウェイデバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": [{
        "id":1562
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "channel": 2,
        "position": "",
        "url": "172.20.4.110",
        "state": 1,
        "camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
        "camera_name": "2"
    }, {
        "id":1563
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "channel": 1,
        "position": "",
        "url": "172.20.4.110",
        "state": 1,
        "camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
        "camera_name": "1"
    }]
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

カメラデバイスのID

sn

string

Nebula デバイスの sn 番号

channel

string

チャンネル番号

position

string

設置場所

url

string

Nebula デバイスの IP アドレス

camera_sn

string

カメラの sn 番号

camera_name

string

カメラ名

state

int

1 = オンライン、2 = オフライン

エラーレスポンスのフィールド

code

メッセージ

説明

498

Param Invalid

パラメーターエラー

2.2.6 親デバイスの取得 (/api/v3/camera/gatewayList) ※開発中機能のためご利用できません

概要

関連する親デバイスを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/camera/gatewayList

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスのID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": "",
    "data": {
        "id":1561,
        "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
        "name": "306",
        "location": "306",
        "host": "172.20.4.110",
        "port": 80,
        "cameras": [{
            "id":1562,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 1,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-525747229d7f3994caa9e595f72fcfdb",
            "camera_name": "1"
        }, {
            "id":1563,
            "sn": "SNB-4828af35b4c652a4dd34f6736ef6c110",
            "channel": 2,
            "position": "",
            "url": "172.20.4.110",
            "camera_sn": "CAM-51b4ef5a2a4949d5a2e329aecd56b7ff",
            "camera_name": "2"
        }]
    }
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

Nebula デバイスのID

sn

string

Nebula デバイスの sn 番号

name

string

名前

location

string

設置場所

host

string

IP

port

int

ポート番号

state

int

オンライン状態。 1 = オンライン、2 = オフライン

cameras

list<camera>

カメラリスト

cameraフィールドの説明

パラメーター名

型

説明

id

long

カメラデバイスのID

sn

string

Nebula デバイスの sn 番号

channel

string

チャンネル番号

position

string

カメラの設置場所

url

string

Nebula デバイスの IP アドレス

camera_sn

string

カメラの sn 番号

camera_name

string

カメラ名

エラーレスポンスのフィールド

code

メッセージ

説明

498

Param Invalid

パラメーターエラー

2.2.7 デバイスリストの表示 (/api/v1/device)

概要

デバイスリストを表示します。デフォルトの順序は ID の降順です。

リクエストアドレスの例

https://HOST:PORT/api/v1/device

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

page

int

No

ページ番号 (デフォルトは 1 です)

size

int

No

1 ページあたりのデータ数 (デフォルトは 20 です)

ids

list<long>

No

デバイスID の配列

typeId

int

No

デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）

location

string

No

デバイスの設置場所

name

string

No

デバイス名

description

string

No

デバイスの説明

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
	"code": 200,
	"message": "OK",
	"data": {
		"total": 406,
		"pageNum": 1,
		"size": 20,
		"pageSize": 20,
		"totalPage": 21,
		"data": [{
			"device_type": {
			  "id": 2,
				"name": "SenseID",
				"identifier": "SID",
				"description": "SenseID",
				"create_at": "2018-08-15 10:08:12.0",
				"update_at": "2018-08-15 10:08:15.0"
			},
			"device": {
				"id": 31,
				"sn": "SID-5f51f769de2cdc8681e85ad590456516",
				"name": "306 試験機",
				"direction": 0,
				"location": "306",
				"ip": null,
				"status": 2,
				"groups": [{
					"id": 2,
					"name": "Default group",
					"type": 2
				}],
				"active": 1,
				"type_id": 2,
				"description": null,
				"software_version": null,
				"info": null,
				"company_id": 1,
				"group_count": 1,
				"create_at": "2019-03-20 09:50:08.0",
				"update_at": "2019-08-28 08:56:05.0"
			}
		}]
	}
}

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

total

int

総計

size

int

サイズ

data

object

pageNum

int

現在のページ番号

pageSize

int

ページサイズ

totalPage

int

ページ合計

data.dataフィールドの説明

パラメーター名

型

説明

device_type

object

デバイスタイプ

device

object

デバイス情報

device_type フィールドの説明

パラメーター名

型

説明

id

long

デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）

name

string

デバイスタイプ名

identifier

string

デバイスタイプの識別子 (略称)

description

string

デバイスタイプの説明

create_at

string

作成時間

update_at

string

更新時間

node_type

int

ノードのタイプ。0 = 共通のデバイス、1 = ゲートウェイデバイス

device フィールドの説明

パラメーター名

型

説明

id

long

デバイスのID

sn

string

デバイスの sn 番号

name

string

デバイス名

direction

string

デバイスの向き

location

string

デバイスの設置場所

ip

string

デバイスの IP

status

int

デバイスのオンライン状態

groups

list<group>

デバイスが連携されたグループ

active

int

偽削除フラグ

type_id

long

デバイスタイプID（4：SensePass、19：SenseThunder-Mini、20：SenseThunder-E）

description

string

デバイスの説明

software_version

string

ソフトウェアのバージョン番号

info

string

デバイス情報

company_id

long

企業ID

group_count

int

デバイスに連携されているグループの数

create_at

string

作成時間

update_at

string

更新時間

last_offline_time

long

最後のオフラインタイムスタンプ

group フィールドの説明

パラメーター名

型

説明

id

long

グループID

name

string

グループ名

type

int

グループタイプ

エラーレスポンスのフィールド

code

メッセージ

説明

30001

Param Invalid

無効なデバイスの sn 番号

30001

Param Invalid

無効なデバイスのステータス

50001

RPC FAILED

リモートでデバイスリストを取得できませんでした

2.2.8 リモート構成（一括複数アップデート）(/api/v2/device/update/config/batch)

概要

同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。

現在サポートされているデバイスタイプは、SensePass、SensePassProです。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/update/config/batch

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

device_ids

list<long>

Yes

ID リスト。デバイスID のタイプは同じである必要があります。

key

json

Yes

ターゲットのデバイスタイプ。小文字の sps、spsp から 1 つ選択します。それぞれ SensePass、SensePassProの略称です。

app_key

string

Yes

Appキー。

sign

string

Yes

シグネチャ。URL に記述されます。

timestamp

string

Yes

タイムスタンプです。URL に記述されます。

構成項目とパラメーターの説明

構成項目

型

値の範囲 / オプション

Pass

(sps)

PassPro

(spsp)

実行ステータス

device_run_type

int

  • 1 : 実行

  • 2 : 停止

✓

✓

利用モード

use_mode

int

✓ (1 : ゲートモード、2 :ドアモード)

✓ (3　: 1 人モード、4 : 複数人モード)

認証モード

mode

int

  • 9 : 顔認証

  • のみ利用可能

✓

✓

音声ブロードキャスト

voice_broadcast

bool

  • true : オン

  • false　: オフ

×

✓

スマートフィルライト

fill_light

bool

  • true : オン

  • false　: オフ

×

×

デバイスのメインメッセージ

welcome_tip

string

長さ制限 : 50

✓

✓

認証メッセージverify_success_tip

string

長さ制限 : 50

認証エラーメッセージverify_fault_tip

string

長さ制限 : 50

認証従業員情報show_user_info

string

  • 0 - 表示なし、1 -表示する。表示順は、従業員ID、部署、役職、ID 番号、カスタマイズプロンプトです。例 : 01000 は部署情報のみが表示されることを示します。

認証成功後に写真を表示する

use_show_avatar

bool

  • true : オン

  • false　: オフ

認証成功後に名前を表示する

show_user_name

bool

  • true : オン

  • false　: オフ

ブラックリストメッセージblack_list_tip

string

長さ制限 : 50

ブラックリストドアオープンblack_list_open

bool

  • true : オン

  • false　: オフ

生体認識

liveness

bool

  • true : オン

  • false　: オフ

✓

✓

生体認識閾値liveness_threshold

float

[0、1]　小数点以下 2 桁です。推奨値は 0.99 です。

顔認証閾値

verify_threshold

float

[0、1]　小数点以下 2 桁です。推奨値は 0.83 です。

IDカード比較閾値certificate_threshold

float

当機能はご利用いただけません。0.5 で仮の値をリクエストしてください。

顔認識距離(メートル)

verification_distance

float

  • 0.5

  • 1

  • 1.5

  • 2

ドアオープンモード

open_door_type

int

  • 0 : ローカルリレー

  • 1 :　 Wiegand 26 (8+16bit id)

  • 2 : Wiegand 32

  • 3 : Wiegand 34

  • 4　: ネットワークリレー + リレー ip

  • 5 : Wiegand 26 (24bit id)

✓

✓

ネットワークリレー IP アドレス

network_relay_address

string

  • ドアオープンモードでネットワークリレーを指定した際に必要です。

  • {IP}:{PORT} 形式 (例 : 192.168.2.1:12345)

✓

✓

ドアオープンタイム (秒)

keep_door_open_duration

int

[1、30]、整数

✓

✓

認証インターバル (秒)

open_interval

int

[3、30]、整数

✓

✓

GPIO A - 出力

gpio_a

int

  • 1 : なし

  • 2 : Doorbell

  • 3 : アラート

✓

✓

GPIO B - 入力

gpio_b

int

  • 1 :　 なし

  • 2 :　 ドアセンサー

  • 3 : Exit ボタン

  • 4 : Fire signal

✓

✓

GPIO C - 入力

gpio_c

int

  • 1 : なし

  • 2 : ドアセンサー

  • 3 : Exit ボタン

  • 4 : Fire signal

✓

✓

Wiegand入力

wigan_input

int

  • 1 : なし

  • 2 : Wiegand 26 (8 +16bit id)

  • 3 : Wiegand 26 (24bit id)

  • 4 : Wiegand 32

  • 5 : Wiegand 34

✓

✓

アラート音スイッチ

buzzer_status

bool

  • true : オン

  • false　: オフ

✓

✓

システム言語

language_type

int

  • 1 : 中国語

  • 2 : 英語

✓

✓

自動スタンバイ

standby_open

bool

  • true: オン

  • false: オフ

✓

✓

スタンバイ時間 (分)

wait_time

int

[3、30]、整数

✓

✓

自動再起動

auto_reboot

bool

true: オン

false: オフ

✓

✓

再起動時間

reboot_time

string

hh:mm:ss (時間、分、秒)

✓

✓

Wiegand入力

card_read_protocol

int

1 : オリジナルの IC カード番号

2 : Wiegand 26 (8 +16bit)

3 : Wiegand 26 (24 bit)

4 :　 Wiegand 32

5 :　 Wiegand 34

×

×

リクエスト例

{
    "device_ids": [
        3
    ],
    "sps": {
        "device_run_type": 1,
        "use_mode": 1,
        "mode": 1,
        "welcome_tip": "welcomeTip22222222",
        "verify_success_tip": "verifySuccessTip",
        "verify_fault_tip": "verifyFaultTip",
        "show_user_info": "00100",
        "liveness": true,
        "liveness_threshold": 0.95,
        "verify_threshold": 0.9,
        "face_width": 300,
        "open_door_type": 1,
        "keep_door_open_duration": 10,
        "gpio_a": 1,
        "gpio_b": 1,
        "gpio_c": 1,
        "buzzer_status": true,
        "language_type": 1,
        "auto_reboot": false,
        "reboot_time": "09:52:50",
        "standby_open": false,
        "wait_time": 10,
        "recognition_distance": 1.5,
        "wigan_input": 1,
        "network_relay_address": "",
        "open_interval": 5,
        "use_show_avatar": true
    }
}

通常のレスポンス

{
  "code": 200,
  "message": "OK"
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

50001

RPC FAILED

RPCに失敗しました

30001

Param Invalid

無効なパラメーターです

498

Param Invalid

無効なパラメーターです。デバイスID リストが空です。

498

Param Invalid

無効なパラメーターです。デバイスタイプが存在しません。

2.2.9 リモートドアオープン (/api/v2/device/open)

概要

オンラインデバイスにドアオープンコマンドを送信します。

リクエストアドレスの例

https://HOST:PORT/api/v2/device/open

リクエスト方法

POST: form-data

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

デバイスの ID

remark

string

No

ドアオープンの備考。長さ制限は 255。

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

498

Param Invalid

無効なパラメーターです。デバイスが存在しません。

603

Device Offline

デバイスがオンラインではありません。

30001

Param Invalid

無効なパラメーターです。デバイスID は空にはできません。

2.2.10 通知の送信 (/api/v3/device/notify) ※開発中機能のためご利用できません

概要

オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。

リクエストアドレスの例

https://HOST:PORT/api/v3/device/notify

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

payload

object[]

Yes

通知メッセージの対象。複数の送信が可能です。

payload.ldid

string

Yes

メッセージを受信するデバイスの LDID

payload.type

string

Yes

通知タイプ。0000 はカスタマイズ通知を示します。メッセージは payload.content を通してカスタマイズします。

payload.content

object

No

メッセージの内容は、透過的にデバイスに送信されます。

trace_id

string

Yes

リクエストされるイベントのシリアル番号です。記号列は UUID と類似しています。

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。2.2.1 シグネチャ（sign）の計算 の章を参照してください。

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    "desc": ""
}

エラーレスポンスのフィールド

code

メッセージ

エラーの説明

10003

Request Expired

タイムスタンプが期限切れになりました。

10005

Signature Failed

無効な署名です。

60001

grpc fail

通知の送信に失敗しました。

60001

Device Not Exist

デバイスが存在しません。

30001

the Device is out line

デバイスがオンラインではありません。

リクエスト例

パラメーター

説明

例

type：“0000”

サードパーティーがカスタマイズした内容です

{

"trace_id":"75d836b4-4a71-4b32-bb16-d215d208195a",

"payload":[

{

"type": "0000",

"ldid":"SPS-8366d77b20689ca0cd0dbfadbea85a2e",

"content": "instruction1" //これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます。 },

{

"type": "0000",

"ldid":"SPSP-8366d77b20689ca0cd0dbfadbea85a2e",

"content": "instruction2" // これはオブジェクトです。必ずしも string である必要はなく、他の値も利用可能です。以下に例を示します。値は透過的にデバイスエンドに送信されます。 }

]

}

2.2.11 デバイスLDIDの取得（/api/v3/device/ldid）

概要

デバイスのシリアル番号でデバイスのLDIDを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/device/ldid

リクエスト方法

GET

リクエストパラメーター

パラメータ名

型

必須

説明

duid

string

Yes

デバイスシリア番号

Identifier

string

Yes

デバイス識別子、詳細について、次のデバイス型番識別子をご参照ください

app_key

string

Yes

Appキー

sign

string

Yes

シグネチャ。計算ルールについては、ドキュメントをご参照ください

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

{
    "code": 200,
    "message": "OK",
    " data": " SPS-c725f19ddf7d5d9fabee189c29f10b11"
}

エラーレスポンスのフィールド

デバイス名称

デバイス型番識別子

SensePass

SPS

SensePass Pro

SPSP

SenseThunder-E

SPSPE

SenseThunder-E Mini

SPSE

レスポンスのフィールド

パラメータ

型

説明

code

int

コード

message

string

メッセージ

data

string

デバイスLDID

前へ2.1 システムのAPI次へ2.3 デバイスアラートの API

最終更新