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

Add TalkBack Command

Ajouter la commande Talkback à la file d'attente Talkback

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

Requête

Méthode HTTP

POST

URL

https://api.thingspeak.com/talkbacks/<talkback_id>/commands.<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

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

position

(Facultatif) La position dans laquelle vous souhaitez que la commande apparaisse. Toutes les commandes précédentes à ou après cette position sont décalées vers le bas. Si la position est laissée vide, la commande est automatiquement ajoutée à la fin de la file d'attente avec la position la plus élevée.

entier

Type de contenu

application/x-www-form-urlencoded

Réponse

Succès

Code HTTP status

200 OK

Body

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

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

Réponse

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

Réponse

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

Réponse

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

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.

Ajoutez la commande TalkBack LIGHTON à une file d'attente TalkBack existante avec l'ID TalkBack 24507.

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

  1. Dans POSTMAN, sélectionnez POST 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: LIGHTON

La réponse est au format texte. Notez la valeur de réponse du serveur de 200 OK, qui indique l'ajout réussi de la commande à votre file d'attente Talkback.

La nouvelle commande est maintenant disponible dans votre file d'attente Talkback.

Voir aussi

Fonctions

Rubriques