概要
「View Channel」呼び出しは、特定のチャンネルに関連付けられたメタデータおよび最新のセンサーデータを取得するために使用されます。
ほとんどの場合、各チャンネルは個別のセンサー機器に対応します。
API URL
https://webapi.ubibot.com/channels?parameters
※CHANNEL_ID は対象チャンネルの ID です。
HTTP メソッド
GET
URL パラメータ
| 名前 | 型 | 必須 | 説明 |
| api_key or account_key | String | プライベートチャンネルの場合必須 | プライベートチャンネルの場合必須 チャンネルの API 書き込みキーまたは読み取りキー、もしくは Web コンソール画面から取得した account_key を指定します。 |
レスポンス
データリクエストが正常に処理された場合、HTTP ステータスコード 200 が返されます。
メッセージ本文には、指定されたチャンネルのメタデータを一覧にした JSON オブジェクトが含まれます。
エラー: 詳細については、別途用意されたエラーコード一覧を参照してください。
補足: write_key フィールドの値は、チャンネルフィードの更新に使用できます。
レスポンスパラメータ
| データフィールド | 説明 |
| public_flag | デバイスの公開権限 |
| usage | デバイスの使用済み容量 |
| size_storage | 契約プランの総容量 |
| traffic_in | デバイスのアップロード通信量 |
| traffic_out | デバイスのダウンロード通信量 |
| size_out | 契約プランの通信量上限 |
| last_values | 最新のセンサー値 |
| last_entry_date | 最終同期時刻 |
| last_ip | 最終同期時の IP アドレス |
| name | チャンネル名 |
| channel_id | チャンネル ID |
| field1, field2….field10 | 各フィールド名（センサー名） |
| net | 0: オフライン, 1: オンライン, 2: 不明, -1: 手動アップロード |
| vconfig | 各フィールドの内容（値、単位、その他の情報）。センサー名に対応 |
例
GET https://webapi.ubibot.com/channels?account_key=xxxxx-xxxxx-xxxxx-xxxx
指定されたチャンネルのすべてのメタデータを一覧にした JSON オブジェクトが返されます。例:
{"
result": "success",
"server_time": "2017 - 08 - 20 T10: 01: 54 Z",
"channels": [{"
channel_id": "395″,
"field1″: "\u6e29\ u5ea6″,
"field2″: "\u6e7f\ u5ea6″,
"field3″: "\u5149\ u7167″,
"field4″: "\u7535\ u91cf",
"field5″: "\u4fe1\ u53f7\ u5f3a\ u5ea6″,
"field6″: "\u52a0\ u901f\ u5ea6″,
"field7″: "\u6572\ u51fb",
"field8″: "\u5916\ u63a5\ u6e29\ u5ea6″,
"field9″: "\u95e8\ u78c1″,
"field10″: null,
"latitude": null,
"longitude": null,
"name": "\u8bbe\ u5907 395″,
"public_flag": "false",
"tags": null,
"url": null,
"metadata": "{\"
fn_th\": 60,
\"fn_light\": 60,
\"fn_mag\": 0,
\"fn_mag_int\": 2,
\"fn_acc_tap1\": 0,
\"fn_acc_tap2\": 0,
\"fn_acc_act\": 0,
\"fn_acc_min\": 5,
\"fn_bt\": 0,
\"fn_ext_t\": 300,
\"fn_battery\": 3600,
\"fn_dp\": 600,
\"cg_data_led\": 1
}",
"description": null,
"traffic_out": "0″,
"traffic_in": "0″,
"created_at": "2017 - 07 - 11 T03: 17: 44 Z",
"updated_at": "2017 - 07 - 11 T03: 17: 44 Z",
"usage": "549397″,
"last_entry_id": "15403″,
"last_entry_date": "2017 - 07 - 14 T06: 41: 27 Z",
"product_id": "ubibot - ws1 - cn",
"device_id": "4 b1fca94ad758faab349bbd7a01cf00ea39e8ba4″,
"channel_icon": null,
"last_ip": "175.171 .43 .88″,
"attached_at": "2017 - 07 - 11 T03: 17: 44 Z",
"firmware": null,
"serial": "E57 ** * WS1″,
"size_out": "5368709120″,
"size_storage": "1073741824″,
"plan_code": "ubibot_1g",
"plan_start": "2017 - 07 - 11 T03: 17: 44 Z",
"plan_end": null,
"bill_start": "2017 - 08 - 10 T03: 17: 44 Z",
"bill_end": "2017 - 09 - 09 T03: 17: 44 Z",
"last_values": "{\"
field1\": {\"
value\": 26.220337,
\"created_at\": 1500014464
},
\"field3\": {\"
value\": 0.4,
\"created_at\": 1500014464
},
\"field4\": {\"
value\": 2.901859,
\"created_at\": 1500013142
},
\"field2\": {\"
value\": 57,
\"created_at\": 1500014464
},
\"field5\": {\"
value\": -49,
\"created_at\": 1500014484
},
\"field9\": {\"
value\": 1,
\"created_at\": 1499749687
},
\"field8\": {\"
value\": 25.6875,
\"created_at\": 1500014396
}
}",
"vconfig": "",
"net": "0″,
"c_icon_base": null
}]
}
