action.devices.QUERY

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

Respons QUERY Anda hanya akan menampilkan informasi status. Memperbarui atribut dan karakteristik perangkat ditangani oleh respons SYNC.

Untuk mengetahui detail selengkapnya, lihat Kueri dan eksekusi.

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 untuk menjalankan kueri.
id String

Wajib.

ID Perangkat, sesuai dengan ID yang disediakan di SYNC.
customData Objek

Jika objek customData buram disediakan 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 yang sesuai.
payload Objek

Wajib.

Payload respons intent.
errorCode String

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

Error mendetail yang tidak akan ditampilkan kepada pengguna, tetapi mungkin dicatat atau digunakan selama pengembangan.
devices Objek

Wajib.

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

Status perangkat.
online Boolean

Wajib.

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

Wajib.

Hasil operasi kueri.

Nilai yang didukung:

SUCCESS
Konfirmasi bahwa kueri berhasil.
OFFLINE
Perangkat target dalam keadaan offline atau tidak dapat dijangkau.
EXCEPTIONS
Terjadi masalah atau notifikasi yang terkait dengan kueri. Kueri dapat berhasil atau gagal. Jenis status ini biasanya ditetapkan ketika Anda ingin mengirim informasi tambahan tentang perangkat terhubung lainnya.
ERROR
Tidak dapat membuat kueri perangkat target.
errorCode String

Memperluas status ERROR jika diperlukan dari kode error preset, yang akan dipetakan 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
        }
      }
    }
  }
}