プラットフォームAPI

まずお読みください
  クイックスタートと制限   API レスポンス形式
チャンネル管理
  チャンネルアイコンアップロード   チャンネルアイコンアップロード（ファイル）   チャンネル表示   チャンネル取得
チャンネルフィード管理
  MQTT リアルタイムフィードトピック   自動同期 Google スプレッドシート   HTTP インタラクション   チャンネルフィードデータ転送   CSVからのフィードインポート   チャンネルフィード概要取得   チャンネル表示   チャンネル取得
チャンネルコマンド
  コマンド追加
APIキー管理
  チャンネル読み取り専用キー削除   チャンネル読み取り専用キー生成   チャンネル書き込みキー生成   アカウントキーの生成   チャンネル API キー一覧

デバイス API

  デバイスエラーの種類   シリアル API

認証とコンプライアンス

  温度校正   UbiBot クラウドストレージアーキテクチャ   UbiBot GDPR プライバシー通知   FDA 21 CFR パート11   関連産業規格

コマンド追加

概要

Add Command API 呼び出しは、デバイスに対してコマンドを送信するために使用されます。例えば、スマートプラグ（SP1）のオン/オフやネットワークリレー装置（NR1）の操作などです。

 

API URL

https://webapi.ubibot.com/channels/CHANNEL_ID/commands?parameters

 

HTTP メソッド

POST

 

URL パラメータ

名前 型 必須 説明
account_key String 必須
Web コンソールパネルで取得した account_key を指定します。
command_string
 String 必須
デバイスに送信するコマンド。command_string は 1 回あたり最大 255 文字です。

 

command_string の形式

SP1 デバイスの場合JSON 文字列で以下の形式を使用します

スイッチをオンにする場合：{"action":"command","set_state":1,"s_port":"port1"}
スイッチをオフにする場合：{"action":"command","set_state":0,"s_port":"port1"}

set_state は対象のアクションを示します。SP1 では port1 のみ存在します。

NR1 デバイスの場合JSON 文字列で以下の形式を使用します：

{"action":"command", "control_list":[{"s_port":"port1", "set_state":1}, {"s_port":"port2", "set_state":0}, {"s_port":"port3", "set_state":0}, {"s_port":"port4", "set_state":0}]}

control_list 配列を使用します。set_state は対象のアクションを示します。NR1 では最大 4 ポートまで対応し、それぞれ対応するリレーを表します。

 

レスポンス

データリクエストが成功した場合、HTTP ステータスコード 200 が返されます。メッセージ本文には、指定されたユーザーに関連する全チャンネルのメタデータをリスト化した JSON オブジェクトが含まれます。

エラー: 詳細については、別途提供されているエラーコード一覧をご参照ください。

ブログに戻る