action.devices.QUERY

Intent ini mengkueri fulfillment Anda untuk status perangkat saat ini, termasuk apakah perangkat sedang online dan dapat dijangkau.

Respons QUERY Anda hanya akan menampilkan informasi status. Pembaruan atribut dan ciri perangkat ditangani oleh Respons SYNC.

Untuk mengetahui detail selengkapnya, lihat Kueri dan jalankan.

Format permintaan

Kolom Jenis Deskripsi
requestId String

Wajib.

ID permintaan.
inputs Array

Wajib.

Daftar input yang cocok dengan permintaan intent.
[item, ...] Objek

Jenis dan payload yang terkait dengan permintaan intent.
intent

Wajib.

(Nilai konstanta: "action.devices.QUERY")

Jenis permintaan intent.
payload Objek

Wajib.

Payload permintaan QUERY.
devices Array

Wajib.

Daftar perangkat target.
[item, ...] Objek

Target perangkat yang akan dikueri.
id String

Wajib.

ID Perangkat, sesuai ID yang diberikan dalam SYNC.
customData Objek

Jika objek customData buram diberikan di SYNC, objek tersebut akan dikirim di sini.
Contoh

Permintaan 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 respons

Kolom Jenis Deskripsi
requestId String

Wajib.

ID permintaan terkait.
payload Objek

Wajib.

Payload respons intent.
errorCode String

Kode error untuk seluruh transaksi untuk kegagalan autentikasi dan ketidaktersediaan sistem developer. Untuk error perangkat individual, gunakan errorCode dalam objek perangkat.
debugString String

{i>Error<i} terperinci yang tidak akan pernah ditampilkan kepada pengguna tetapi mungkin dicatat atau digunakan selama pengembangan.
devices Objek

Wajib.

Peta perangkat. Memetakan ID perangkat developer ke objek properti status.
<string> Objek

Status perangkat.
online Boolean

Wajib.

Menunjukkan apakah perangkat online (dapat dijangkau) atau tidak.
status String

Wajib.

Hasil operasi kueri.

Nilai yang didukung:

SUCCESS
Konfirmasi bahwa kueri berhasil.
OFFLINE
Perangkat target dalam status offline atau tidak dapat dijangkau.
EXCEPTIONS
Ada masalah atau pemberitahuan yang terkait dengan kueri. Kueri dapat berhasil atau gagal. Jenis status ini biasanya disetel saat Anda ingin mengirim informasi tambahan tentang perangkat lain yang terhubung.
ERROR
Tidak dapat mengkueri perangkat target.
errorCode String

Memperluas status ERROR jika diperlukan dari kode error preset, yang akan memetakan ke error yang ditampilkan kepada pengguna.
Contoh

Respons 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
        }
      }
    }
  }
}