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