Gateway state command
The Gateway state command is a request to get the state of the Gateway.
Response: If successful, a Gateway state event, and an Error event in case of errors.
Fields
| Name | Type | Description | Accepted values | Constraints | Required |
|---|---|---|---|---|---|
api_version |
string | The input API schema version number. | 1.0 |
Yes | |
event_type |
string | The message type. | gateway_state! |
Yes | |
event_id |
string | The message identifier. This can be used to reference it. | Any | UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} |
Yes |
time_created |
integer | The time of creation client-side, used to determine the order of incoming messages. Unix time stamp in milliseconds. | Any | 1546300800000 <= value <= 99999999999999 | Yes |
Example
{
"api_version": "1.0",
"event_type": "gateway_state!",
"event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
"time_created": 1546300800000
}