action.devices.QUERY

این هدف در مورد وضعیت فعلی دستگاه‌ها، از جمله اینکه آیا دستگاه آنلاین و قابل دسترسی است، سؤال می‌کند.

پاسخ QUERY شما باید فقط اطلاعات وضعیت را برگرداند. به روز رسانی ویژگی ها و ویژگی های دستگاه توسط پاسخ SYNC انجام می شود.

برای جزئیات بیشتر، Query and execute را ببینید. فرمت درخواست

فیلدها تایپ کنید توضیحات
requestId رشته

مورد نیاز.

شناسه درخواست

inputs آرایه

مورد نیاز.

فهرست ورودی های مطابق با درخواست قصد.

[ item, ... ] شیء

نوع و بار مرتبط با درخواست قصد.

intent

مورد نیاز.

(مقدار ثابت: "action.devices.QUERY" )

نوع درخواست قصد

payload شیء

مورد نیاز.

QUERY درخواست بار.

devices آرایه

مورد نیاز.

لیست دستگاه های مورد نظر

[ item, ... ] شیء

دستگاه پرس و جو را هدف قرار می دهد.

id رشته

مورد نیاز.

شناسه دستگاه، مطابق شناسه ارائه شده در SYNC.

customData شیء

اگر شی customData مات در SYNC ارائه شده باشد، به اینجا ارسال می شود.

نمونه ها

درخواست قصد 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"
            }
          }
        ]
      }
    }
  ]
}
 فرمت پاسخ
فیلدها تایپ کنید توضیحات
requestId رشته

مورد نیاز.

شناسه درخواست مربوطه

payload شیء

مورد نیاز.

بار پاسخ قصد.

errorCode رشته

یک کد خطا برای کل تراکنش برای خرابی های احراز هویت و در دسترس نبودن سیستم توسعه دهنده. برای خطاهای دستگاه جداگانه از errorCode در شیء دستگاه استفاده کنید.

debugString رشته

خطای مفصلی که هرگز به کاربران ارائه نخواهد شد اما ممکن است در حین توسعه ثبت شود یا استفاده شود.

devices شیء

مورد نیاز.

نقشه دستگاه ها شناسه دستگاه توسعه‌دهنده نقشه به شیء ویژگی‌های حالت.

<string> شیء

وضعیت دستگاه

online بولی

مورد نیاز.

نشان می دهد که آیا دستگاه آنلاین است (یعنی قابل دسترسی) یا خیر.

status رشته

مورد نیاز.

نتیجه عملیات پرس و جو

مقادیر پشتیبانی شده:

SUCCESS
تأیید کنید که پرس و جو با موفقیت انجام شد.
OFFLINE
دستگاه هدف در حالت آفلاین یا غیرقابل دسترسی است.
EXCEPTIONS
یک مشکل یا هشدار مرتبط با یک پرس و جو وجود دارد. پرس و جو ممکن است با موفقیت یا شکست مواجه شود. این نوع وضعیت معمولاً زمانی تنظیم می شود که می خواهید اطلاعات اضافی درباره دستگاه متصل دیگری ارسال کنید.
ERROR
امکان پرس و جو از دستگاه مورد نظر وجود ندارد.
errorCode رشته

گسترش حالت ERROR در صورت نیاز از کدهای خطای از پیش تعیین شده، که به خطاهای ارائه شده به کاربران نشان داده می شود.

نمونه ها

پاسخ هدف 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
        }
      }
    }
  }
}