Get TalkBack Command

Get TalkBack command from TalkBack queue

Request

HTTP Method

GET

URL

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

Input Arguments

NameDescription

<talkback_id>

(Required) TalkBack ID, specified as a positive integer.

<command_id>

(Required) Command ID for the command of interest, specified as a positive integer.

<format>

Format for the HTTP response, specified as json or xml.

Example: https://api.thingspeak.com/talkbacks/12345/commands/112233.json

Query String Parameters

NameDescriptionValue Type
api_key

(Required) API key for this specific instance of TalkBack. The TalkBack key is different from the channel and user API keys.

string

Content-Type

application/x-www-form-urlencoded

Response

Success

HTTP Status Code

200 OK

Body

The example responses are based on this sample TalkBack queue.

Leave <format> blank to receive the response in text format.

GET https://api.thingspeak.com/talkbacks/12345/commands/2448500?api_key=XXXXXXXXXXXXXXXX

Sample Response

OPENDOOR
GET https://api.thingspeak.com/talkbacks/12345/commands/COMMAND_ID.json?api_key=XXXXXXXXXXXXXXXX

Response

{
  "command_string": "OPENDOOR",
  "created_at": "2013-12-29T17:53:40-05:00",
  "executed_at": null,
  "id": 2448500,
  "position": 5
}
GET https://api.thingspeak.com/talkbacks/12345/commands/2448500.xml?api_key=XXXXXXXXXXXXXXXX

Response

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

Error

For the full list, see Error Codes.

See Also

Functions

Topics