Изменение состояния у устройств

Изменяет текущее состояние устройств пользователя.

Пример ситуации, в которой отправляется текущий запрос: пользователь зашел в приложение Дом с Алисой и хочет поменять состояние устройств.

В ответ на такой запрос провайдеру необходимо изменить состояния запрошенных устройств пользователя.

Формат запроса платформы умного домаФормат запроса платформы умного дома

Платформа умного дома отправляет запрос на Endpoint URL провайдера (https://example.com).

POST https://functions.yandexcloud.net/<function_id>?integration=raw

Формат тела запросаФормат тела запроса

{
  "headers": {
    "request_id": String,
    "authorization": string
  },
  "request_type": String,
  "payload": {
    "devices":[
      {
        "id": String,
        "custom_data": Object,
        "capabilities": [
          "<capability1>": Object,
          "<capability2>": Object,
          ...
        ]
      }
    ]
  },
  "api_version": Float
}

Объект headers

Объект payload

Объект devices

Объект capabilities

Формат ответа провайдераФормат ответа провайдера

Провайдер должен ответить на полученный от платформы умного дома запрос согласно формату.

HTTP/1.1 200 OK

{
    "request_id": String,
    "payload": {
      "devices": [
        {
          "id": String,
          "capabilities": [
            "<capability1>": Object,
            "<capability2>": Object,
            ...
          ],
          "action_result": {
            "status": String,
            "error_code": String,
            "error_message": String
          }
        },
        ...
      ]
    }
}

HTTP/1.1 404 Not Found

ПримерПример

Запрос

Успешный ответ

Ответ с ошибкой

curl -i POST https://functions.yandexcloud.net/<function_id>?integration=raw \
-H 'Content-Type: application/json' \
-d '{
      "headers": {
        "request_id": "1111-aaaa-2222-bbbb",
        "authorization": "Bearer 123qwe456a..."
      },
      "request_type": "action",
      "payload": {
        "devices": [{
          "id": "abc-123",
          "custom_data": {
            "foo": 1,
            "bar": "two",
            "baz": false,
            "qux": [1, "two", false],
            "quux": {
              "quuz": {
                "corge": []
              }
            }
          },
          "capabilities": [{
              "type": "devices.capabilities.color_setting",
              "state": {
                "instance": "hsv",
                "value": {
                  "h": 255,
                  "s": 50,
                  "v": 100
                }
              }
            },
            {
              "type": "devices.capabilities.on_off",
              "state": {
                "instance": "on",
                "value": false
              }
            }
          ]
        },
        {
          "id": "sock-56GF-3",
          "capabilities": [{
            "type": "devices.capabilities.on_off",
            "state": {
              "instance": "on",
              "value": false
            }
          }]
        }]
      },
      "api_version": 1.0
    }'

HTTP/1.1 200 OK

{
  "request_id": "1111-aaaa-2222-bbbb",
  "payload": {
      "devices": [{
          "id": "abc-123",
          "capabilities": [{
              "type": "devices.capabilities.color_setting",
              "state": {
                  "instance": "hsv",
                  "action_result": {
                      "status": "ERROR",
                      "error_code": "INVALID_ACTION",
                      "error_message": "the human readable error message"
                  }
              }
          },
          {
              "type": "devices.capabilities.on_off",
              "state": {
                  "instance": "on",
                  "action_result": {
                      "status": "DONE"
                  }
              }
          }]
     },
     {
        "id": "sock-56GF-3",
        "action_result": {
          "status": "ERROR",
          "error_code": "DEVICE_UNREACHABLE"
        }
     }]
  }
}

HTTP/1.1 404 Not Found

Часто задаваемые вопросыЧасто задаваемые вопросы