Contenu principal

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

Execute TalkBack Command

Exécuter la prochaine commande Talkback dans la file d'attente Talkback

Requête

Méthode HTTP

GET or POST

URL

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

Arguments d'entrée

NomDescription

<talkback_id>

(Obligatoire) ID Talkback , 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/execute

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

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 cet exemple de file d'attente Talkback.

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

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

Réponse

OPENDOOR

S'il ne reste aucune commande à exécuter, le corps de la réponse est vide.

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

Réponse

{
  "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
}

S'il ne reste aucune commande à exécuter, la réponse est un objet JSON vide.

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

Réponse

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

S'il ne reste aucune commande à exécuter, la réponse est un hachage XML vide, par exemple :

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

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 exécuter la prochaine commande Talkback dans une file d'attente existante à l'aide de POSTMAN.

Exécutez la commande TalkBack dans une file d’attente existante avec l’ID TalkBack 24507.

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

  1. Dans POSTMAN, sélectionnez POST dans la liste déroulante des verbes HTTP et entrez https://api.thingspeak.com/talkbacks/24507/commands/execute dans la barre d'adresse. Remplacez 24507 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>.

La réponse est au format JSON. Notez la valeur de réponse du serveur de 200 OK, qui indique une exécution réussie de la commande Talkback.

La dernière commande s'affiche dans la réponse et est supprimée de votre file d'attente Talkback.