Devicestates¶
Since: 12.0.0¶
| Method | Path (Parameters are case-sensitive) | Return Model | Summary | Since |
|---|---|---|---|---|
| GET | /deviceStates | List[DeviceState] | List all ARI controlled device states. | 12.0.0 |
| GET | /deviceStates/{deviceName} | DeviceState | Retrieve the current state of a device. | 12.0.0 |
| PUT | /deviceStates/{deviceName} | void | Change the state of a device controlled by ARI. (Note - implicitly creates the device state). | 12.0.0 |
| DELETE | /deviceStates/{deviceName} | void | Destroy a device-state controlled by ARI. | 12.0.0 |
list¶
Since: 12.0.0¶
GET /deviceStates¶
List all ARI controlled device states.
get¶
Since: 12.0.0¶
GET /deviceStates/{deviceName}¶
Retrieve the current state of a device.
Path parameters¶
Parameters are case-sensitive. * deviceName: string - Name of the device
update¶
Since: 12.0.0¶
PUT /deviceStates/{deviceName}¶
Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
Path parameters¶
Parameters are case-sensitive. * deviceName: string - Name of the device
Query parameters¶
- deviceState: string - (required) Device state value
- Allowed values: NOT_INUSE, INUSE, BUSY, INVALID, UNAVAILABLE, RINGING, RINGINUSE, ONHOLD
Error Responses¶
- 404 - Device name is missing
- 409 - Uncontrolled device specified
delete¶
Since: 12.0.0¶
DELETE /deviceStates/{deviceName}¶
Destroy a device-state controlled by ARI.
Path parameters¶
Parameters are case-sensitive. * deviceName: string - Name of the device
Error Responses¶
- 404 - Device name is missing
- 409 - Uncontrolled device specified