Cette page a été traduite par traduction automatique. Cliquez ici pour voir la dernière version en anglais.

Update TalkBack Command

Commande de mise à jour dans la file d'attente Talkback

développer tous les éléments de la page

Requête

Méthode HTTP

PUT

URL

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

Arguments d'entrée

NomDescription

<talkback_id>

(Obligatoire) ID Talkback , spécifié sous la forme d'un entier positif.

<command_id>

(Obligatoire) ID de commande pour la commande qui vous intéresse, spécifié sous la forme d'un entier positif.

<format>

Format de la réponse HTTP, spécifié comme json ou xml.

Exemple : https://api.thingspeak.com/talkbacks/12345/commands/23456.json

Paramètres du corps de la requête

NomDescriptionType de valeur
api_key

(Obligatoire) clé d'API pour cette instance spécifique de Talkback. La clé Talkback est différente des clés d'API de canal et d'utilisateur.

chaîne de caractère

command_string

Commande à envoyer à votre appareil. Chaque command_string est limité à 255 caractères.

chaîne de caractère

Type de contenu

application/x-www-form-urlencoded

Réponse

Succès

Code HTTP status

200 OK

Body

Les exemples de réponses sont basés sur cette modification dans un exemple de file d'attente Talkback.

Laissez <format> vide pour recevoir la réponse au format texte.

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

Réponse

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

Réponse

{
  "command_string": "OPENDOOR",
  "created_at": "2019-12-29T17:53:40-05:00",
  "executed_at": null,
  "id": 23456,
  "position": 2
}
PUT https://api.thingspeak.com/talkbacks/12345/commands/15200362.xml
    api_key=XXXXXXXXXXXXXXXX
    command_string=CLOSEDOOR
    position=2

Réponse

<?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>

Erreur

Pour la liste complète, voir Codes d'erreur.

Exemples

développer tout

Vous pouvez utiliser POSTMAN pour tester vos requêtes HTTP à l'aide de l'API RESTful pour ThingSpeak. Cet exemple montre comment ajouter une commande Talkback à une file d'attente existante à l'aide de POSTMAN.

Remplacez la commande TalkBack BUCKLESHOE par une file d'attente TalkBack existante avec l'ID TalkBack 15200362.

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

  1. Dans POSTMAN, sélectionnez PUT dans la liste déroulante des verbes HTTP et entrez https://api.thingspeak.com/talkbacks/TALKBACK_ID/commands/ dans la barre d'adresse. Remplacez TALKBACK_ID par votre identifiant TalkBack.

  2. Saisissez le paramètre api_key et votre clé API TalkBack, qui se trouve dans Apps > TalkBack> YOUR TALKBACK NAME.

  3. Saisissez les paramètres et valeurs supplémentaires :

    • api_key, Value: XXXXXXXXXXXXXXXX

    • command_string, Value: CLOSEDOOR

La réponse est au format XML. Notez la valeur de réponse du serveur de 200 OK, qui indique une mise à jour réussie de votre commande Talkback.

La commande mise à jour est désormais disponible dans votre file d'attente Talkback.

Voir aussi

Fonctions

Rubriques