action.devices.QUERY

Ý định này truy vấn khả năng thực hiện trạng thái của các thiết bị hiện tại, bao gồm cả việc thiết bị có kết nối mạng hay không.

Phản hồi QUERY chỉ trả về thông tin trạng thái. Việc phản hồi SYNC sẽ xử lý việc cập nhật các thuộc tính và đặc điểm của thiết bị.

Để biết thêm thông tin chi tiết, hãy xem Truy vấn và thực thi.

Định dạng yêu cầu

Các trường Loại Mô tả
requestId Chuỗi

Bắt buộc.

Mã nhận dạng của yêu cầu.

inputs Mảng

Bắt buộc.

Danh sách dữ liệu đầu vào khớp với yêu cầu ý định.

[item, ...] Đối tượng

Nhập và trọng tải liên quan đến yêu cầu ý định.

intent

Bắt buộc.

(Giá trị không đổi: "action.devices.QUERY")

Loại yêu cầu ý định.

payload Đối tượng

Bắt buộc.

Tải trọng yêu cầu QUERY.

devices Mảng

Bắt buộc.

Danh sách các thiết bị mục tiêu.

[item, ...] Đối tượng

Mục tiêu thiết bị để truy vấn.

id Chuỗi

Bắt buộc.

Mã thiết bị theo mã nhận dạng được cung cấp trong SYNC.

customData Đối tượng

Nếu đối tượng customData mờ được cung cấp trong SYNC, đối tượng này sẽ được gửi tại đây.

Ví dụ

Yêu cầu ý định 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"
            }
          }
        ]
      }
    }
  ]
}

Định dạng phản hồi

Các trường Loại Mô tả
requestId Chuỗi

Bắt buộc.

Mã của yêu cầu tương ứng.

payload Đối tượng

Bắt buộc.

Dung lượng phản hồi của ý định.

errorCode Chuỗi

Mã lỗi cho toàn bộ giao dịch đối với các lỗi xác thực và lỗi không có sẵn hệ thống dành cho nhà phát triển. Đối với các lỗi riêng lẻ trên thiết bị, hãy sử dụng mã lỗi trong đối tượng thiết bị.

debugString Chuỗi

Lỗi chi tiết sẽ không bao giờ được trình bày cho người dùng nhưng có thể được ghi lại hoặc sử dụng trong quá trình phát triển.

devices Đối tượng

Bắt buộc.

Bản đồ thiết bị. Mã thiết bị của nhà phát triển trên Maps với đối tượng của các thuộc tính trạng thái.

<string> Đối tượng

Trạng thái thiết bị.

online Boolean

Bắt buộc.

Cho biết thiết bị có đang kết nối mạng hay không (nghĩa là có thể kết nối được) hay không.

status Chuỗi

Bắt buộc.

Kết quả của thao tác truy vấn.

Giá trị được hỗ trợ:

SUCCESS
Xác nhận rằng truy vấn đã thành công.
OFFLINE
Thiết bị mục tiêu đang ở trạng thái ngoại tuyến hoặc không thể truy cập.
EXCEPTIONS
Có vấn đề hoặc cảnh báo liên quan đến cụm từ tìm kiếm. Truy vấn có thể thành công hoặc không thành công. Loại trạng thái này thường được đặt khi bạn muốn gửi thêm thông tin về một thiết bị khác được kết nối.
ERROR
Không thể truy vấn thiết bị đích.
errorCode Chuỗi

Mở rộng trạng thái ERROR nếu cần từ những mã lỗi được thiết lập sẵn. Các lỗi này sẽ ánh xạ tới các lỗi hiển thị cho người dùng.

Ví dụ

Phản hồi ý định 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
        }
      }
    }
  }
}