action.devices.QUERY
Cet intent interroge votre traitement pour connaître les états actuels des appareils, y compris si l'appareil est en ligne et accessible.
Votre réponse QUERY
ne doit renvoyer que des informations sur l'état.
La mise à jour des attributs et des caractéristiques de l'appareil est gérée par la réponse SYNC
.
Pour en savoir plus, consultez Interroger et exécuter.
Format de requête
Champs | Type | Description |
---|---|---|
requestId |
Chaîne |
Obligatoire. ID de la requête. |
inputs |
Array |
Obligatoire. Liste des entrées correspondant à la requête d'intent. |
[item, ...] |
Objet |
Type et charge utile associé à la requête d'intent. |
intent |
Obligatoire. (Valeur constante : Type de requête d'intent. |
|
payload |
Objet |
Obligatoire. Charge utile de la requête QUERY. |
devices |
Array |
Obligatoire. Liste des appareils cibles. |
[item, ...] |
Objet |
Appareils cibles à interroger. |
id |
Chaîne |
Obligatoire. ID de l'appareil, conformément à l'ID fourni dans SYNC. |
customData |
Objet |
Si l'objet "customData" opaque est fourni au format SYNC, il est envoyé ici. |
Exemples
Requête d'intent QUERY
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [ { "intent": "action.devices.QUERY", "payload": { "devices": [ { "id": "123", "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" } }, { "id": "456", "customData": { "fooValue": 12, "barValue": false, "bazValue": "bar" } } ] } } ] }
Format de réponse
Champs | Type | Description |
---|---|---|
requestId |
Chaîne |
Obligatoire. ID de la requête correspondante. |
payload |
Objet |
Obligatoire. Charge utile de la réponse d'intent. |
errorCode |
Chaîne |
Code d'erreur de l'ensemble de la transaction pour les échecs d'authentification et l'indisponibilité du système de développement. Pour les erreurs d'appareil individuelles, utilisez le code d'erreur dans l'objet appareil. |
debugString |
Chaîne |
Erreur détaillée qui ne sera jamais présentée aux utilisateurs, mais qui peut être consignée ou utilisée lors du développement. |
devices |
Objet |
Obligatoire. Carte des appareils. Mappe l'ID d'appareil du développeur avec l'objet des propriétés d'état. |
<string> |
Objet |
État de l'appareil. |
online |
Booléen |
Obligatoire. Indique si l'appareil est en ligne (c'est-à-dire accessible) ou non. |
status |
Chaîne |
Obligatoire. Résultat de l'opération de requête. Valeurs acceptées :
|
errorCode |
Chaîne |
Développer l'état ERROR si nécessaire à partir des codes d'erreur prédéfinis, qui seront mis en correspondance avec les erreurs présentées aux utilisateurs |
Exemples
Réponse d'intent QUERY
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "devices": { "123": { "on": true, "online": true, "status": "SUCCESS" }, "456": { "on": true, "online": true, "status": "SUCCESS", "brightness": 80, "color": { "spectrumRgb": 16711935 } } } } }