このページは機械翻訳を使用して翻訳されました。最新版の英語を参照するには、ここをクリックします。

Execute TalkBack Command

TalkBackキュー内の次のTalkBackコマンドを実行する

このページをすべて展開する

要求

HTTPメソッド

GET or POST

URL

https://api.thingspeak.com/talkbacks/<talkback_id>/commands/execute.<format>

入力引数

名前説明

<talkback_id>

(必須) TalkBack ID。正の整数として指定します。

<format>

HTTP 応答の形式。json または xml として指定されます。

例: https://api.thingspeak.com/talkbacks/12345/commands/execute

Bodyパラメーター

名前説明値のタイプ
api_key

(必須) TalkBackのこの特定のインスタンスの API キー。TalkBackキーは、チャネルおよびユーザー API キーとは異なります。

string

Content-Type

application/x-www-form-urlencoded

応答

成功

HTTPステータスコード

200 OK

Body

応答例は、このサンプルTalkBackキューに基づいています。

応答をテキスト形式で受け取るには、<format> を空白のままにしておきます。

POST https://api.thingspeak.com/talkbacks/12345/commands/execute
     api_key=XXXXXXXXXXXXXXXX

応答

OPENDOOR

実行するコマンドが残っていない場合、応答bodyは空になります。

POST https://api.thingspeak.com/talkbacks/12345/commands/execute.json
     api_key=XXXXXXXXXXXXXXXX

応答

{
  "command_string": "OPENDOOR",
  "created_at": "2018-12-29T17:53:40-05:00",
  "executed_at": "2018-12-30T17:53:40-05:00",
  "id": 2448500,
  "position": null
}

実行するコマンドが残っていない場合、応答は空の JSON オブジェクトになります。

POST https://api.thingspeak.com/talkbacks/12345/commands/execute.xml
     api_key=XXXXXXXXXXXXXXXX

応答

<?xml version="1.0" encoding="UTF-8"?>
<command>
  <id type="integer">2448500</id>
  <command-string>OPENDOOR</command-string>
  <position type="integer" nil="true"/>
  <created-at type="datetime">2018-12-30T16:51:17-05:00</created-at>
  <executed-at type="datetime">2018-12-31T16:51:17-05:00</executed-at>
</command>

実行するコマンドが残っていない場合、応答は空の XML ハッシュになります。例:

<?xml version="1.0" encoding="UTF-8"?>
<hash></hash>

エラー

完全なリストについては、エラーコード を参照してください。

例

すべて展開する

POSTMAN を使用すると、ThingSpeak の RESTful API を使用して HTTP要求を試すことができます。この例では、 POSTMANを使用して既存のキュー内の次のTalkBackコマンドを実行する方法を示します。

TalkBack ID 24507 を使用して、既存のキューでTalkBackコマンドを実行します。

POST https://api.thingspeak.com/talkbacks/24507/commands
     api_key=YOUR_TALKBACK_API_KEY

  1. POSTMANで、HTTP 動詞のドロップダウン リストから POST を選択し、アドレス バーに https://api.thingspeak.com/talkbacks/24507/commands/execute と入力します。24507 をTalkBack ID に変更します。

  2. パラメーターapi_key とTalkBack API キー (Apps > TalkBack> <Your TalkBack Name> にあります) を入力します。

応答は JSON 形式です。サーバー応答値 200 OK に注意してください。これはTalkBackコマンドの実行が成功したことを示します。

最後のコマンドが応答に表示され、 TalkBackキューから削除されます。

参考

関数

トピック