Update TalkBack Command

Update command in TalkBack queue

Request

HTTP Method

PUT

URL

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

Input Arguments

Name	Description
<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/23456.json

Body Parameters

Name	Description	Value 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
command_string	Command to be sent to your device. Each command_string is limited to 255 characters.	string

Content-Type

application/x-www-form-urlencoded

Response

Success

HTTP Status Code

200 OK

Body

The example responses are based on this change in a sample TalkBack queue.

 Text Example

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

PUT https://api.thingspeak.com/talkbacks/12345/commands/23456 api_key=XXXXXXXXXXXXXXXX command_string=CLOSEDOOR position=2

Response CLOSEDOOR

 JSON Example

PUT https://api.thingspeak.com/talkbacks/12345/commands/23456.json api_key=XXXXXXXXXXXXXXXX command_string=CLOSEDOOR

Response { "command_string": "OPENDOOR", "created_at": "2019-12-29T17:53:40-05:00", "executed_at": null, "id": 23456, "position": 2 }

 XML Example

PUT https://api.thingspeak.com/talkbacks/12345/commands/15200362.xml api_key=XXXXXXXXXXXXXXXX command_string=CLOSEDOOR position=2

Response <?xml version="1.0" encoding="UTF-8"?> <command> <id type="integer">15200362</id> <command-string>CLOSEDOOR</command-string> <position type="integer">3</position> <executed-at type="dateTime" nil="true"/> <created-at type="dateTime">2019-02-20T16:24:04Z</created-at> </command>

Error

For the full list, see Error Codes.

Examples

Use POSTMAN to Update a TalkBack Command

You can use POSTMAN to try out your HTTP requests using the RESTful API for ThingSpeak. This example shows how to add a TalkBack command to an existing queue using POSTMAN.

Change the TalkBack command BUCKLESHOE to an existing TalkBack queue with the TalkBack ID 15200362.

PUT https://api.thingspeak.com/talkbacks/23341/commands/15200362.xml
    api_key=XXXXXXXXXXXXXXXX
    command_string=CLOSEDOOR
    

1. In POSTMAN, select PUT from the drop-down list of HTTP verbs, and enter https://api.thingspeak.com/talkbacks/TALKBACK_ID/commands/ in the address bar. Change TALKBACK_ID to your TalkBack ID.

2. Enter the parameter api_key and your TalkBack API key, which is found in Apps > TalkBack> YOUR TALKBACK NAME.

3. Enter the additional parameters and values:

   • api_key, Value: XXXXXXXXXXXXXXXX

   • command_string, Value: CLOSEDOOR

The response is in XML format. Note the server response value of 200 OK, which indicates successful update of your TalkBack command.

The updated command is now available in your TalkBack queue.