概要

TTS Open APIを利用することで、販売代理店やアプリ開発事業者は、APIを通じて独自のGUIクライアント、アプリ、またはWebサイト上で顧客向けのトラッキングサービスを提供できます。
これにより、各社のサービスに合わせたローカライズや、ユーザー体験の向上が期待されます。

なお、アプリやWebクライアントはTTSのAPIサーバーに直接接続するのではなく、自社のアプリケーションサーバーを経由してTTSサーバーと通信する必要があります。

使用方法

1. APIの利用には、appKeyおよびappSecretの申請が必要です。申請をご希望の方は、当社までご連絡ください。申請時にはアカウント情報のご提供をお願いしております。
2. 本ドキュメントに沿ってアプリケーションサーバーを構築し、まずはaccess_tokenを取得してください。
3. 取得したaccess_tokenを使って、各種インターフェースを呼び出し、必要なビジネスロジックを実装していただけます。

規約

エンコーディング・フォーマット・タイムゾーン

デフォルトでUTF-8およびJSONが使用されます。

Context-Type: default application/json charset=utf-8

APIは、デフォルトでUTC（GMT+0）の時間を使用します。
フォーマット: yyyy-MM-dd HH:mm:ss

共通レスポンスフィールド

結果コードの説明

エラーコード詳細：

ワークフロー

APIワークフロー

APIの機能

API説明

リクエストURL

唯一のリクエストURLは以下の通りです：

https://openapi-tts-tracker.tanaka-tracker-system.jp/route/rest

セキュリティ

インターフェースを呼び出す前に、クライアントはまず tts.oauth.token.get を用いて access_token を取得する必要があります（appKeyおよびappSecretを使用）。

API呼び出し時には、appKey および access_token に基づいてリクエストパラメータに署名（sign）を行う必要があります。TTSサーバーは、署名値を検証してリクエストの正当性を確認します。

共通パラメータ

各リクエストには、共通パラメータとインターフェース固有のパラメータが含まれている必要があります。例えば、「tts.oauth.token.get」を呼び出す場合：

7つの共通パラメータ + 3つの個別パラメータ = 合計10のパラメータ（キー／バリュー）

共通パラメータは以下の通りです：

バージョン（v）による違い：

• v=0.9：署名の検証を行いません
• v=1.0：署名の検証を行います

署名検証の目的：
受信者が、送られてきたデータが送信者によって発行されたものであり、かつ途中で改ざんされていないかを検証するために、署名値（digest）を比較します。送信者と同じ方法で生成したdigestと署名から復号したdigestが一致すれば、データは正しいと判断されます。

署名（Sign）について

API呼び出しを不正アクセスから守るため、すべての呼び出しには署名が必要です。TTSサーバーは、パラメータに基づいて署名を検証し、不正なリクエストは拒否します。 対応している署名アルゴリズムは md5（上記共通パラメータ sign_method 参照）です。

署名アルゴリズムの概要：

1. リクエストパラメータ（共通＋個別、signとbyte型は除く）をキーのアルファベット順でソート
   
   例:

   foo=1, bar=2, foo_bar=3, foobar=4

   結果:

   bar=2, foo=1, foo_bar=3, foobar=4

2. イコールやカンマを省いて連結

   bar2foo1foo_bar3foobar4

3. その前後にappSecretを追加し、md5を取得：

   md5(appSecrect+bar2foo1foo_bar3foobar4+appSecrect)

   例:

   md5(h9lri085eachcz4sn7gwnkh6j0jt0yz4bar2foo1foo_bar3foobar4h9lri085eachcz4sn7gwnkh6j0jt0yz4)

4. UTF-8エンコード＋大文字の16進数文字列で返却:

   hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”

5. バイト配列の場合は16進数変換を行う:

JAVA example：
Algorithm

public static String signTopRequest(Map<String, String> params, String seccode, String signMethod) throws IOException {
    // 1: sort parameter key
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);

    // 2: put all parameter names and parameter values together
    StringBuilder query = new StringBuilder();
    if (Constants.SIGN_METHOD_MD5.equals(signMethod)) {
        query.append(seccode);
    }

    for (String key : keys) {
        String value = params.get(key);
        if (StringUtils.areNotEmpty(key, value)) {
            query.append(key).append(value);
        }
    }

    // 3: use MD5/HMAC to encrypt
    byte[] bytes;
    if (Constants.SIGN_METHOD_HMAC.equals(signMethod)) {
        bytes = encryptHMAC(query.toString(), seccode);
    } else {
        query.append(seccode);
        bytes = encryptMD5(query.toString());
    }

    // 4: convert binary to uppercase hexadecimal
    return byte2hex(bytes);
}

public static byte[] encryptHMAC(String data, String seccode) throws IOException {
    byte[] bytes = null;
    try {
        seccodeKey seccodeKey = new seccodeKeySpec(seccode.getBytes(Constants.CHARSET_UTF8), "HmacMD5");
        Mac mac = Mac.getInstance(seccodeKey.getAlgorithm());
        mac.init(seccodeKey);
        bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}

public static byte[] encryptMD5(String data) throws IOException {
    return encryptMD5(data.getBytes(Constants.CHARSET_UTF8));
}

public static String byte2hex(byte[] bytes) {
    StringBuilder sign = new StringBuilder();
    for (int i = 0; i < bytes.length; i++) {
        String hex = Integer.toHexString(bytes[i] & 0xFF);
        if (hex.length() == 1) {
            sign.append("0");
        }
        sign.append(hex.toUpperCase());
    }
    return sign.toString();
}

アクセストークンの取得

説明

クライアント（販売代理店のサーバー）は、access_token をローカルに保存して使用する必要があります。リクエストのたびにアクセストークンを取得するのではなく、ローカルに保存されたトークンを、有効期限が切れるまでは使い続けてください。

TTSサーバーは、クライアントからのリクエスト頻度が高すぎる場合、アクセスを許可しません。

アクセストークンの有効期間は約2時間（expires_in パラメータの値に依存）です。毎回のリクエストでトークンを取得しないようにしてください。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.oauth.token.get

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

result の中身

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB61EC8791D",
    "account": "ttstest",
    "accessToken": "7da3330ec28e3996b6ef4a7e3390ba71",
    "expiresIn": 60,
    "refreshToken": "7da3330ec28e3996b6ef4a7e3390ba71",
    "time": "2017-06-15 10:00:00"
  }
}

エラー例：

{"code":xxx,"message":"Incorrect user name or password"}

Postmanデモ

user_id = your account.
user_pwd_md5 = md5(your account password).
Sign = md5(<app_secrect>your alphabet ordered parameters keyvalue, without equal-sign, comma and not include sign field<app_secrect>).
Note that sign is a 32-length upper case string.

例：

<app_secrect>app_key9FB345B8693CCD0054E44ADF99139409expires_in7200formatjsonmethodtts.oauth.token.getsign_methodmd5timestamp2017-09-28 01:55:00user_id<account>user_pwd_md5<password_md5>v1.0<app_secrect>

アクセストークンの更新

説明

アクセストークンの有効期限が近づいたときに手動で更新するためのインターフェースです。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.oauth.token.refresh

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンスの例:

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB61EC8791D",
    "account": "ttstest",
    "accessToken": "7da3330ec28e3996b6ef4a7e3390ba71",
    "expiresIn": 60,
    "refreshToken": "7da3330ec28e3996b6ef4a7e3390ba71",
    "time": "2017-06-15 10:00:00"
  }
}

エラー例：

{"code":xxx,"message":"Illegal request，token is invalid"}

サブアカウント一覧取得

説明

指定したアカウントに属するすべてのサブアカウントを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.child.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

Result

正しいレスポンス例

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "account": "123123",
      "name": "test",
      "type": 8,
      "displayFlag": 1,
      "address": null,
      "birth": "2017-04-22 00:00:00",
      "companyName": "",
      "email": "",
      "phone": "",
      "language": "zh",
      "sex": 0,
      "enabledFlag": 1,
      "remark": null
    }
  ]
}

誤ったレスポンス例

{"code":xxx,"message":"The account does not exist"}

サブアカウント作成

説明

指定したアカウントのサブアカウントを新規作成します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.child.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}

誤ったレスポンス例：

{"code":xxx,"message":"The account does not exist"}

サブアカウント削除

説明

指定したアカウントのサブアカウントを削除します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.child.del

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}

誤ったレスポンス例：

{"code":xxx,"message":"no permissions"}

アカウント移動

説明

サブアカウントを別のサブアカウント配下に移動させます。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.child.move

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}

誤ったレスポンス例：

{"code":xxx,"message":"no permissions"}

サブアカウントのデバイス一覧取得

説明

指定されたアカウントに紐づくすべてのデバイスを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.device.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

Result：

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "mcType": "GT300L",
      "mcTypeUseScope": "personal",
      "sim": "415451",
      "expiration": "2037-04-01 23:59:59",
      "activationTime": "2017-04-01 11:02:20",
      "reMark": "test",
      "vehicleName": null,
      "vehicleIcon": "bus",
      "vehicleNumber": "粤B3604",
      "vehicleModels": null,
      "carFrame": "2235",
      "driverName": "driver",
      "driverPhone": "13825036579",
      "enabledFlag": 1,
      "engineNumber": "8565674",
      "deviceGroupId": "b54ab3c430864e31a64e54de44c79a1d",
      "deviceGroup": "default group"
    }
  ]
}

エラーレスポンス例

{"code":xxx,"message":"Account queried doesn’t exist"}

デバイス詳細情報の取得

説明

特定のIMEIに対して、デバイスの詳細情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.track.device.detail

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

Result：

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "imei": "868120145233604",
    "deviceName": "868120145233604",
    "mcType": "GT300L",
    "mcTypeUseScope": "personal",
    "sim": "415451",
    "expiration": "2037-04-01 23:59:59",
    "activationTime": "2017-04-01 11:02:20",
    "reMark": "test",
    "vehicleName": null,
    "vehicleIcon": "bus",
    "vehicleNumber": "粤B3604",
    "vehicleModels": null,
    "carFrame": "2235",
    "driverName": "driver",
    "driverPhone": "13825036579",
    "enabledFlag": 1,
    "engineNumber": "8565674",
    "iccid": "xxxxxxx",
    "imsi": "xxxx",
    "importTime": "2017-04-01 11:02:20",
    "licensePlatNo": "8565674",
    "VIN": "xxxxxxx",
    "vehicleBrand": "xxxx",
    "fuel_100km": "9",
    "status": "8565674",
    "currentMileage": "102.5",
    "deviceGroupId": "b54ab3c430864e31a64e54de44c79a1d",
    "deviceGroup": "default group"
  }
}

エラーレスポンス例

{"code":xxx,"message":"Account queried doesn’t exist"}

アカウント単位でのデバイス位置取得

説明

指定したアカウントに紐づくすべてのデバイスの最新位置情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.device.location.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

Result data:

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "icon": "bus",
      "status": "0",
      "posType": "GPS",
      "lat": 22.577282,
      "lng": 113.916604,
      "hbTime": "2017-04-26 09:14:50",
      "accStatus": "0",
      "speed": "0",
      "gpsTime": "2017-04-26 09:17:46",
      "activationFlag": "1",
      "expireFlag": "1",
      "electQuantity": "60",
      "locDesc": null,
      "powerValue": null,
      "temperature": "86.5",
      "trackerOil": null
    }
  ]
}

誤ったレスポンス例：

{"code":xxx,"message":"The account does not exist"}

複数デバイスの位置情報取得

説明

1台または複数デバイスの最新位置情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.location.get

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "icon": "bus",
      "status": "0",
      "posType": "GPS",
      "lat": 22.577282,
      "lng": 113.916604,
      "hbTime": "2017-04-26 09:14:50",
      "accStatus": "0",
      "speed": "0",
      "gpsNum": "11",
      "gpsTime": "2017-04-26 09:17:46",
      "activationFlag": "1",
      "expireFlag": "1",
      "electQuantity": "60",
      "locDesc": null,
      "powerValue": null,
      "temperature": "86.5",
      "trackerOil": null,
      "currentMileage": "86.5"
    }
  ]
}

誤ったレスポンス例：

{"code":xxx,"message":"Illegal device"}

位置情報共有用URLの取得

説明

デバイスの現在位置を地図上で表示するための共有URLを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.location.URL.share

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果オブジェクト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "URL": "data.16180track.com/api/share?ver=2&method=trackDevice_abr&deviceinfo=7ae7c62385f2067f164002db315854a969a40e3888021cb01dc8f2183ca08dbbd8581f6bb86df4c2e3e1b887cb67c21039b4c0ced18fdf8dd08e0460c5edd13ad87e16dca9702ce6"
  }
}

誤ったレスポンス例：

{"code":xxx,"message":"Illegal device"}

ユーザーの有効期限の更新

説明

デバイスのユーザー有効期限を更新します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.device.expiration.update

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "update_result": "0",
      "update_msg": "update success"
    },
    {
      "imei": "868120145233605",
      "update_result": "1",
      "update_msg": "update failed, reason:xxxxxx"
    }
  ]
}

誤ったレスポンス例：

{"code":xxx,"message":"Illegal device"}

デバイスの走行距離データ取得

説明

指定した期間内のデバイスの走行データ（トリップ情報）を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.track.mileage

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "3505831983422342",
      "startTime": "2017-04-26 00:00:58",
      "endTime": "2017-04-26 00:03:58",
      "startLat": 22.577144898887813,
      "startLng": 113.91674845964586,
      "endLat": 22.677144898887813,
      "endLng": 113.92674845964586,
      "elapsed": 2130,
      "distance": 25000,
      "avgSpeed": 90
    },
    {
      "imei": "3505831983422342",
      "startTime": "2017-04-26 00:00:58",
      "endTime": "2017-04-26 00:03:58",
      "startLat": 22.577144898887813,
      "startLng": 113.91674845964586,
      "endLat": 22.677144898887813,
      "endLng": 113.92674845964586,
      "elapsed": 2130,
      "distance": 25000,
      "avgSpeed": 90
    }
  ],
  "data": [
    {
      "imei": "3505831983422342",
      "totalMileage": 60000
    },
    {
      "imei": "3505831983422342",
      "totalMileage": 60000
    }
  ]
}

デバイスの走行軌跡データ取得

説明

過去3か月以内、最大7日間の範囲で、デバイスの走行軌跡データを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.track.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

result（走行ポイント）の主なフィールド：

data list：

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "lat": 22.577144898887813,
      "lng": 113.91674845964586,
      "gpsTime": "2017-04-26 00:00:58",
      "direction": 0,
      "gpsSpeed": -1,
      "posType": 3,
      "satellite": 0,
      "ignition": "ON",
      "accStatus": "ON"
    },
    {
      "lat": 22.57708,
      "lng": 113.916631,
      "gpsTime": "2017-04-26 00:01:30",
      "direction": 184,
      "gpsSpeed": 0,
      "posType": 1,
      "satellite": 0,
      "ignition": "ON",
      "accStatus": "ON"
    }
  ],
  "data": {
    "mileage": 0
  }
}

エラーレスポンス例

{"code":xxx,"message":"IMEI does not exist{353419031939627}"}
{"code":xxx,"message":"The device has expired{353419031939627}"}

IMEIによる車両情報の更新

説明

IMEIを指定して、車両関連情報を更新します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.update

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}

誤ったレスポンス例：

{"code":xxx,"message":"imei doesn’t exists"}

Vehicle Icon

デバイスの写真または動画URL取得

説明

カメラで撮影された動画または写真のURLを取得します。

備考: このAPIで取得できるのは「リモートコマンドで生成されたメディア」のみです。すべてのメディアを取得するにはAPI 7.38を使用してください。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.media.URL

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "Operation successful",
  "result": [
    {
      "thumb_URL": "Q9GLAFFqfCrYF6YfQAcON4w4Ezs=/lhWse7ie3wtFrjuQZ22dLAk5CSaR",
      "file_URL": "357730090345670_3949477_2019_04_29_12_32_38_01",
      "mime_type": "video/mp4",
      "create_time": "2019-04-29 10:32:43",
      "media_type": 2,
      "camera": 1,
      "file_size": 9949087
    },
    {
      "thumb_URL": "Q9GLAFFqfCrYF6YfQAcON4w4Ezs=/FhCrZEIy3518sR_ylOlqDg7w3Ju-",
      "file_URL": "351609080120911_3949476_2019_04_29_18_32_12",
      "mime_type": "video/3gpp",
      "create_time": "2019-04-29 10:32:42",
      "media_type": 2,
      "camera": 1,
      "file_size": 2411318
    }
  ]
}

誤ったレスポンス例：

{"code":xxx,"message":"imei doesn’t exists"}

デバイスのライブ映像ページURL取得

説明

デバイスのライブストリーミングページのURLと、直近の位置情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.live.page.url

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果オブジェクト

正しいレスポンス例：

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": {
    "lat": 22.577144898887813,
    "lng": 113.91674845964586,
    "gpsTime": "2017-04-26 00:00:58",
    "direction": 0,
    "gpsSpeed": -1,
    "posType": 3,
    "satellite": 11,
    "VIN": "V12345",
    "plateNo": "ABC-12345",
    "UrlCamera": "https://www.domain.com/device/video/35408343202342345"
  }
}

誤ったレスポンス例：

{"code":xxx,"message":"imei doesn’t exists"}

Wi-Fi・基地局による位置測定（LBS）

説明

1アカウントあたり1デバイスにつき1日最大10回まで。サブアカウントも含む。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.lbs.address.get

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "lat": 40.65615416521587,
    "lng": 109.89894039833524,
    "accuracy": 0
  }
}

誤ったレスポンス例：

{"code":xxx,"message":"illegal device"}

IMEIによるジオフェンスの作成

説明

指定されたIMEIに対し、ジオフェンス（仮想境界）を作成します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.fence.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "Successfully create geo-fence.",
  "result": "5"
}

誤ったレスポンス例：

{
  "code": 41003,
  "message": "Device is not online, geo-fence creation failed ",
  "result": null
}

デバイスのジオフェンス削除

説明

指定されたデバイスのジオフェンスを削除します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.fence.delete

HTTPリクエストメソッド

POST

リクエストパラメータ

（1）共通パラメータ

（2）個別パラメータ

レスポンス

正常な戻り値の例

{
  "code": 0,
  "message": "delete the geo-fence successfully",
  "result": null
}

エラー戻り値の例

{
  "code": 41003,
  "message": "デバイスがオンラインではありません and geo-fence can’t be deleted",
  "result": null
}

デバイスが対応するコマンド一覧の取得

説明

指定されたデバイスが対応しているコマンドの一覧を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.instruction.list

HTTPリクエストメソッド

POST

リクエストパラメータ

（1）共通パラメータ

（2）個別パラメータ

レスポンス

Result list

正常な戻り値の例

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "id": 81,
      "orderName": "SOS setting",
      "orderContent": "SOS,A,{0},{1},{2}#",
      "orderExplain": "SOS is used for receive alerts and SOS alerts. SOS number should have 3-20 numbers.",
      "orderMsg": "",
      "isOffLine": "1"
    }
  ]
}

エラー戻り値の例

{
  "code":xxx,
  "message":"Illegal device"
}

デバイスへコマンド送信

説明

指定したデバイスにコマンドを送信します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.instruction.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

inst_param_json description

例：

{"inst_id": "113","inst_template":"RELAY,1#","params":[],"is_cover":"true"}
{"inst_id": "114","inst_template":"RELAY,0#","params":[],"is_cover":"true"}

例：

{"inst_id": "96","inst_template":"{0}","params":["STATUS#"],"is_cover":"true"}

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "command is successfully sent.",
  "result": null
}

エラーレスポンス例

{
  "code": 12005,
  "message": "Fail to send command. Result code：226",
  "result": null
}

コマンド実行結果の取得

説明

送信済みのコマンドに対する実行結果を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.instruction.result

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

Result list：

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "codeId": "99",
      "code": "status#",
      "content": "パラメーターエラー",
      "isExecute": "4",
      "sendTime": "2017-06-19 11:46:00",
      "sender": "ttstest",
      "receiveDevice": "868120111111117",
      "isOffLine": "1",
      "idsource": "User-defined command"
    }
  ]
}

エラーレスポンス例

{"code":xxx,"message":"Illegal device"}

デバイスへRaWコマンド（Raw Command）送信

説明

デバイスに対し、Rawコマンド（16進数文字列）を送信します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.instruction.raw.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

Raw Command 例：

0B02C3A405060708

レスポンス

正しいレスポンス例：

{
  "code": 0,
  "message": "command is successfully sent.",
  "result": null
}

エラーレスポンス例

{
  "code": 12005,
  "message": "Fail to send command. Result code：226",
  "result": null
}

Rawデータの受信通知（Push）

説明

TTSサーバーから第三者プラットフォームに生データ（raw data）をプッシュします。
※受信用URLを手動でTTSへ連絡・登録が必要です。

メッセージ種別一覧

リクエスト構成：

メッセージ内容 ( tts.open.instruction.raw.receive )

プッシュされるアラームは以下の通りです。

例：

Parameter1:
Key = msgType
Value = tts.open.instruction.raw.receive

Parameter2:
Key = data
Value = {
  "imei": "868120145233604",
  "deviceName": "868120145233604",
  "raw_data": "0A0C0F01182E0101"
}

メディア命令（写真・動画）送信

説明

デバイスに写真または動画の撮影命令を送信します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.meida.cmd.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正常な戻り値の例

{
  "code": 0,
  "message": "Operation successful",
  "result": {"code":"255","data":"1.3.3","msg":"通信成功响应","cmdSeqNo":"1"}
}

例外

{
  "code": -1,
  "message": "Operation successful",
  "result": {"code":"228","data":"1.3.3","msg":"设备不在线","cmdSeqNo":"1"}
}

通知（アラームなど）受信

説明

TTSサーバーからアラーム通知を送信します。
※受信用URLを手動でTTSへ連絡・登録が必要です。

メッセージ種別一覧

リクエスト構成

Message content (tts.push.device.alarm)

プッシュされるアラームは以下の通りです。

E.g：

Parameter1:
    Key = msgType
    Value = tts.push.device.alarm

Parameter2:
    Key = data
    Value = {
        "imei": "868120145233604",
        "deviceName": "868120145233604",
        "alarmType": "2",
        "alarmName": "Power off alarm",
        "lat": 40.65615416521587,
        "lng": 109.89894039833524,
        "alarmTime": "2017-05-08 12:00:00"
    }

デバイスアラーム一覧の取得

説明

指定されたデバイスのアラーム履歴を取得します。
※検索期間は最大1か月、最大1000件。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.meida.cmd.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

結果リスト

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "deviceName": "ABC-34352",
      "imei": "343503422910345",
      "model": "GT06N",
      "account": "test1234",
      "alertTypeId": "1002",
      "alarmTypeName": "ACC On",
      "alertTime": "2019-03-14 14:02:03",
      "positioningTime": "2019-03-14 14:02:03",
      "lat": 22.577144898887813,
      "lng": 113.91674845964586,
      "speed": "10",
      "geoid": "se8yg081p0qh5vnniqrakr1nr0tdh6a0"
    }
  ]
}

誤ったレスポンス例：

{"code":xxx,"message":"Illegal device"}

(Deprecated)Send command (for scooter device)

(Deprecated)Get detail information of scooter

履歴ビデオリストの取得

説明

デバイスに対して履歴ビデオファイルリストのアップロードコマンドを送信、またはファイルリストを取得します。 このAPIはJC200およびJC400モデルの旧ファームウェアにのみ対応しています。他のモデルは「7.21 デバイスライブ配信ページURLの取得」を使用してください。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.meida.cmd.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

{"code":"100","data":"1.3.3","msg":"Successful response","cmdSeqNo":"1"}

{" 2018_03_29_16_51_45.mp4,2018_03_29_16_52_46.mp4,"}

type=1
成功例

{
  "code": 0,
  "message": "Operation successful",
  "result": {"code":"255","data":"1.3.3","msg":"Successful response","cmdSeqNo":"1"}
}

例外

{
  "code": -1,
  "message": "Operation successful",
  "result": {"code":"228","data":"1.3.3","msg":"Device is offline","cmdSeqNo":"1"}
}

type=2

{
  "code": 0,
  "message": "Operation successful",
  "result": "2018_03_29_16_51_45.mp4,2018_03_29_16_52_46.mp4,"
}

履歴ビデオアップロード指示の送信

説明

デバイスに履歴ビデオファイルのアップロードを指示します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.history.cmd.send

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

{"code":"100","data":"1.3.3","msg":"Successful response","cmdSeqNo":"1"}

正常な戻り値の例

{
  "code": 0,
  "message": "Operation successful",
  "result": {"code":"255","data":"1.3.3","msg":"Successful response","cmdSeqNo":"1"}
}

例外

{
"code": -1,
"message": "Operation successful",
"result": {"code":"228","data":"1.3.3","msg":"Device is offline","cmdSeqNo":"1"}
}

RTMP形式のビデオURLの取得

説明

デバイスのRTMPビデオURLを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.video.rtmp.url

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

{ "code": 0,"message": "success","result": “rtmp://36.133.0.208:1935/0/353376110035950?uId=openapi8b7914c3e4c188def67edd6b4a743146&vhost=8&user=172&expire_stamp=1595923486798&ext=&channel=0&token=25b422283ff824461b33d8c5059d”}

正常な戻り値の例

{
  "code": 0,
  "message": "Operation successful",
  "result": “rtmp://36.133.0.208:1935/0/353376110035950?uId=openapi8b7914c3e4c188def67edd6b4a743146&vhost=8&user=172&expire_stamp=1595923486798&ext=&channel=0&token=25b422283ff824461b33d8c5059d”
}

例外

{
  "code": 228,
  "message": "デバイスがオンラインではありません",
  "result": “null”
}

デバイスが撮影した写真/ビデオURLの取得

説明

デバイスのカメラで撮影された写真またはビデオのURLを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.tts.media.URL

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

result list:

備考: Unixタイムスタンプ; 例： 1611105520 = 2021-01-20 09:18:40

正常なレスポンス例：

{
  "code": 0,
  "message": "Operation successful",
  "result": 
[
        {
            "thumb_URL": "http://8.210.205.58:8081/normal/get?fileKey=2021_01_20_09_17_49_I_28.jpg",
            "file_URL": "http://8.210.205.58:8081/normal/get?fileKey=357730090564767_29057540_2021_01_20_09_17_49_I_28_128.mp4",
            "create_time": 1611105520,
            "mime_type": "video/mp4",
            "media_type": 2,
            "alarm_time": 1611105469,
            "camera": 0,
            "file_size": "12108649"
        },
        {
            "thumb_URL": "http://8.210.205.58:8081/normal/get?fileKey=2021_01_20_08_06_13_I_56.jpg",
            "file_URL": "http://8.210.205.58:8081/normal/get?fileKey=357730090564767_00000000_2021_01_20_08_06_13_I_56_146.mp4",
            "create_time": 1611101264,
            "mime_type": "video/mp4",
            "media_type": 2,
            "alarm_time": 1611101173,
            "camera": 0,
            "file_size": "48452069"
        }
]
}

誤ったレスポンス例:

{"code":xxx,"message":"imei doesn’t exists"}

ユーザー情報の編集

説明

ユーザー情報の編集：プラットフォーム上のユーザー情報を編集します。編集可能な項目は以下の通りです。
・ユーザーニックネーム・携帯電話番号・メールアドレス・連絡担当者・会社名・権限

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.user.child.update

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータ

レスポンス

正しいレスポンス例：

{
"code": 0,
"message": "Account update success!",
"result": null,
"data": null
}

デバイスの駐車/アイドリングデータを取得

説明

指定された期間内のデバイスの駐車およびアイドリングデータを取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.report.parking

HTTPリクエストメソッド

POST

リクエストパラメータ

レスポンス

data list

rows object

成功例

{ 
"code": 0, 
"message": "success", 
"result": null , 
"data": {
"totalTime":"185641",
"dataTotalRows":"2",
"rows":[
   {
"imei":"869247060001739",
"startTime":"2022-12-10T01:05:33.000Z",
"endTime":"2022-12-10T04:17:48.000Z",
"durSecond":"11535",
"lng":113.943093,
"lat":22.576748,
"addr":"Shigu Road, 松坪村, Xili Sub-district, Nanshan distri...",
"deviceName":"JC450Pro-01739",
"mcType":"JC450Pro",
"acc":"on",
"stopSecond":"11535"
},
   {
"imei":"869247060001739",
"startTime":"2022-12-09T22:13:16.000Z",
"endTime":"2022-12-10T01:04:25.000Z",
"durSecond":"10269",
"lng":113.943002,
"lat":22.57649,
"addr":"Shigu Road, 松坪村, Xili Sub-district, Nanshan distri...",
"deviceName":"JC450Pro-01739",
"mcType":"JC450Pro",
"acc":"on",
"stopSecond":"10269"
      }
   ]
  }
}

誤ったレスポンス例：

{ 
"code": 1100, 
"message": "Business exception ", 
"result": null ,
"data": null ,
}

プラットフォームジオフェンスの作成

説明

プラットフォームジオフェンスを作成します。新たに作成されたジオフェンスはデフォルトグループに属します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": null,
  "data": "c33b80d46d2b41d588a5afbd6f8b6285"
}

誤ったレスポンス例:

{
  "code": 1114,
  "message": "That name already exists",
  "result": null,
  "data": null
}

プラットフォームジオフェンスの編集

説明

プラットフォームジオフェンスの情報を編集します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": null,
  "data": "c33b80d46d2b41d588a5afbd6f8b6285"
}

誤ったレスポンス例:

{
  "code": -1,
  "message": "The system is busy",
  "result": null,
  "data": null
}

プラットフォームジオフェンスの削除

説明

指定されたジオフェンスを削除します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.delete

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": null,
  "data": null
}

誤ったレスポンス例:

{
  "code": -1,
  "message": " The system is busy ",
  "result": null,
  "data": null
}

ジオフェンス関連デバイスのバインド

説明

ジオフェンスに関連するデバイスを設定します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.bind

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": null,
  "data": "3"
}

誤ったレスポンス例:

{
  "code": 1100,
  "message": "Business exception",
  "result": null,
  "data": null
}

アカウントのジオフェンス一覧取得

説明

指定アカウントに属するジオフェンスの一覧を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

result:

Rows list:

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "total": 294,
    "rows": [
      {
        "fence_id": "dfab43ea3e7a40e987056c857cccae7b",
        "fence_name": "test fence",
        "fence_type": "circle",
        "fence_color": "#3b7aff",
        "coordinates": "22.544382,114.004037",
        "radius": "4153",
        "description": "",
        "imeis": "231011234567990,869247060001655,868598060001827,869247060001259",
        "alert_type": "in",
        "stay_time_out": null,
        "stay_time_in": null,
        "account": "hao001"
      }
    ]
  }
}

誤ったレスポンス例:

{
  "code": -1,
  "message": "The system is busy",
  "result": null,
  "data": null
}

デバイスの移動

説明

デバイスをあるサブアカウントから別のサブアカウントに移動します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.move

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 1112,
  "message": "device already exists",
  "result": [
    "202205454545454"
  ],
  "data": null
}

Or:

{
  "code": 0,
  "message": "Transfer/Sell Equipment Successfully",
  "result": null,
  "data": null
}

誤ったレスポンス例:

{
  "code": xxx, "message": "no permissions"
}

RFID報告情報の取得

説明

指定期間内に報告されたRFID情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.rfid.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

data object：

結果リスト

正常なレスポンス例：

{
  "code": 0,
  "message": "success",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "startRow": 1,
    "endRow": 10,
    "totalRecord": 34,
    "totalPage": 4,
    "result": [
      {
        "imei": "890768902346789",
        "cardId": "278907",
        "operationTime": "2024-04-22 09:12:23",
        "photo": ""
      }
    ]
  }
}

誤ったレスポンス例:

{"code":xxx,"message":"no permissions"}

単一ジオフェンス情報の取得

説明

フェンスIDに基づいて単一のジオフェンス情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.detail

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

result:

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": {
    "fence_id": "dfab43ea3e7a40e987056c857cccae7b",
    "fence_name": "test fence",
    "fence_type": "circle",
    "fence_color": "#3b7aff",
    "coordinates": "22.544382,114.004037",
    "radius": "4153",
    "description": "",
    "imeis": "231011234567990,869247060001655,868598060001827,869247060001259",
    "alert_type": "in",
    "stay_time_out": null,
    "stay_time_in": null,
    "account": "hao001"
  }
}

誤ったレスポンス例:

{
  "code": -1,
  "message": "The system is busy",
  "result": null,
  "data": null
}

アプリユーザーのバインド

説明

デバイスをアプリユーザーアカウントにバインドします。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.bind

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success"
}

誤ったレスポンス例:

{
  "code": 1100,
  "message": "The system is busy",
  "result": null,
  "data": null
}

アプリユーザーのバインド解除

説明

デバイスとアプリユーザーアカウントとのバインドを解除します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.device.unbind

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正常なレスポンス例：

{
  "code": 0,
  "message": "success"
}

誤ったレスポンス例:

{
  "code": 1100,
  "message": "The system is busy",
  "result": null,
  "data": null
}

デバイスの走行レポート取得

説明

デバイスの走行履歴レポートを照会します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.report.trips

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

data list：

datDatas list:

datDatas.data:

dayList list：

dayList.tripsData：

dayList.tripsData.dayData:

正しいレスポンス例：

暂缺

誤ったレスポンス例:

{
  "code": 1100,
  "message": "Business exception",
  "result": null,
  "data": null
}

デバイスの入退場フェンスデータ取得

説明

デバイスがジオフェンスに入退場した履歴を照会します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.open.platform.fence.duration

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

data list：

Rows list

正しいレスポンス例：

{
  "code": 0,
  "message": "success",
  "result": null,
  "data": {
    "totalTime": "0",
    "dataTotalRows": "2",
    "rows": [
      {
        "imei": "869247060001739",
        "deviceName": "JC450Pro-01739",
        "fenceName": "geofence1",
        "enterTime": "2022-12-10T01:05:33.000Z",
        "exitTime": "2022-12-10T04:17:48.000Z",
        "duration": "11535"
      },
      {
        "imei": "869247060001739",
        "deviceName": "JC450Pro-01739",
        "fenceName": "geofence1",
        "enterTime": "2022-12-10T01:05:33.000Z"
      }
    ]
  }
}

誤ったレスポンス例：

{
  "code": 1100,
  "message": "Business exception",
  "result": null,
  "data": null
}

デバイスのOBDデータ取得

説明

このAPIは、OBDデバイスによって報告されたCANバス診断データを照会します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.obd.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

data list：

result 配列要素：

正しいレスポンス例：

{
    "code": 0,
    "message": "success",
    "data": {
        "currentPage": 1,
        "pageSize": 2,
        "startRow": 0,
        "endRow": 0,
        "totalRecord": 2684,
        "totalPage": 0,
        "result": [
            {
                "imei": "158511020000028",
                "dataReportTime": "2024-05-09 10:25:00",
                "odometerReading": "2049.6",
                "deviceAccumulatedMileage": "142.9",
                "remainingFuel": null,
                "remainingFuelPercentage": "58",
                "coolantTemperature": "77",
                "vehicleBatterVoltage": "118",
                "currentRPM": "5016",
                "currentSpeed": "88.5",
                "vin": "LC0CG4CF1H0029191"
            },
            {
                "imei": "158511020000028",
                "dataReportTime": "2024-05-09 1:27:23",
                "odometerReading": "2048.6",
                "deviceAccumulatedMileage": "143.9",
                "remainingFuel": null,
                "remainingFuelPercentage": "56",
                "coolantTemperature": "78",
                "vehicleBatterVoltage": "118",
                "currentRPM": "5016",
                "currentSpeed": "95.5",
                "vin": "LC0CG4CF1H0029191"
            }
        ]
    }
}

誤ったレスポンス例：

{
    "code": 1100,
    "message": "Business exception ",
    "result": null,
    "data": null
}

デバイスのOBD故障データ取得

説明

OBDデバイスが報告したCANバス故障コード情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.obd.fault

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

data list：

rows list：

正しいレスポンス例：

{
    "code": 0,
    "message": "success",
    "result": null,
    "data": {
        "currentPage": 1,
        "pageSize": 4,
        "startRow": 0,
        "endRow": 0,
        "totalRecord": 6,
        "totalPage": 0,
        "result": [
            {
                "imei": "202509999999994",
                "deviceName": "VL502_E-99994",
                "faultCode": "P1502",
                "faultDetail": "High speed state of the vehicle - the front axle is faster than the rear axle",
                "eventTime": "2024-07-03 08:16:49"
            },
            {
                "imei": "202509999999994",
                "deviceName": "VL502_E-99994",
                "faultCode": "B0074",
                "faultDetail": "2nd row center seat belt pretensioner - start control (sub-error)",
                "eventTime": "2024-07-03 08:26:49"
            },
            {
                "imei": "202509999999994",
                "deviceName": "VL502_E-99994",
                "faultCode": "P2407",
                "faultDetail": "Fuel evaporative emission system leak detection pump sensing circuit is intermittent/unstable",
                "eventTime": "2024-07-03 08:36:49"
            },
            {
                "imei": "202509999999994",
                "deviceName": "VL502_E-99994",
                "faultCode": "U0464",
                "faultDetail": "Invalid data received from the navigation control module",
                "eventTime": "2024-07-03 08:46:49"
            }
        ]
    }
}

誤ったレスポンス例：

{
    "code": 1100, 
    "message": "Business exception ", 
    "result": null ,
    "data": null ,
}

TAGデバイスの現在位置取得

説明

TAGデバイスの最新位置情報を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.location.getTagMsg

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

結果リスト

正しいレスポンス例：

{
    "code": 0,
    "message": "success",
    "result": [
        {
            "lng": 113.943054,
            "lat": 22.576609,
            "gpsTime": 1734593340,
            "directions": "0",
            "gpsSpeed": -1.0,
            "positionType": "5",
            "gpsNum": 3
        }
    ]
}

誤ったレスポンス例：

{
    "code": 1100,
    "message": "Business exception ",
    "result": null,
    "data": null
}

デバイスグループの作成

説明

デバイスグループを新規作成します。デバイスをグループ分けして管理できます。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.group.create

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

result

正しいレスポンス例：

{
    "code": 0,
    "message": "success",
    "result": {
        "group_id": "534d23f1b28c44319f4f8ba0cda5b7e6",
        "group_name": "device group 1"
    }
}

デバイスグループの編集

説明

既存のデバイスグループ情報を編集します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.group.update

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正しいレスポンス例：

{
    "code": 0,
    "message": "success"
}

デバイスグループの削除

説明

デバイスグループを削除します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.group.delete

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

正しいレスポンス例：

{
    "code": 0,
    "message": "success"
}

アカウントのデバイスグループ一覧取得

説明

指定アカウントのデバイスグループ一覧を取得します。

リクエストURL

ユニークなリクエストURLを参照してください。
メソッド名 tts.device.group.list

HTTPリクエストメソッド

POST

リクエストパラメータ

• （1）共通パラメータ
• （2）個別パラメータは以下の通りです：

レスポンス

rows list：

正しいレスポンス例：

{
    "code": 0,
    "message": "success",
    "result": [
        {
            "group_id": "b2ac10536171474eb0c151c7bb606f3d",
            "group_name": "Default group"
        },
        {
            "group_id": "298b949bacbb4badae597ba1fdb629be",
            "group_name": "22221"
        },
        {
            "group_id": "05cbdd380ca14c2e89b2ab59904f51b7",
            "group_name": "CVCVXCV"
        }
    ]
}

付録

デバイスアラームタイプ（alertTypeId）

デバイスからアクティブに送信されるアラームタイプのIDは数値です。プラットフォーム側のロジック判定により生成されるアラームタイプのIDは英字テキストです。