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

Add TalkBack Command

TalkBackコマンドをTalkBackキューに追加する

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

要求

HTTPメソッド

POST

URL

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

入力引数

名前説明

<talkback_id>

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

<format>

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

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

Bodyパラメーター

名前説明値のタイプ
api_key

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

string

command_string

デバイスに送信されるコマンド。各 command_string は 255 文字に制限されます。

string

position

(オプション) コマンドを表示する位置。この位置以降の以前のコマンドはすべて下へシフトされます。位置を空白のままにすると、コマンドは自動的にキューの末尾の最高位置に追加されます。

整数

Content-Type

application/x-www-form-urlencoded

応答

成功

HTTPステータスコード

200 OK

Body

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

POST https://api.thingspeak.com/talkbacks/TALKBACK_ID/commands
     api_key=YOUR_TALKBACK_API_KEY
     command_string=OPENDOOR
     position=5

応答

2448500
POST https://api.thingspeak.com/talkbacks/TALKBACK_ID/commands.json
     api_key=YOUR_TALKBACK_API_KEY
     command_string=OPENDOOR

応答

{
  "id": 2448500,
  "command_string": "OPENDOOR",
  "position": 5,
  "executed_at": null,
  "created_at": "2016-08-29T15:12:36Z"
}
POST https://api.thingspeak.com/talkbacks/TALKBACK_ID/commands.xml
     api_key=YOUR_TALKBACK_API_KEY
     command_string=OPENDOOR&position=5

応答

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

エラー

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

例

すべて展開する

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

TalkBackコマンド LIGHTON をTalkBack ID 24507 を持つ既存のTalkBackキューに追加します。

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

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

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

  3. 追加のパラメーターと値を入力します。

    • api_key、Value: XXXXXXXXXXXXXXXX

    • command_string、Value: LIGHTON

応答はテキスト形式です。サーバー応答値 200 OK に注意してください。これは、コマンドがTalkBackキューに正常に追加されたことを示します。

新しいコマンドがTalkBackキューで利用できるようになりました。

参考

関数

トピック