Devicestates
Method |
Path<br>h5. Parameters are case-sensitive |
Return Model |
Summary |
|---|
GET |
List all ARI controlled device states. |
||
GET |
Retrieve the current state of a device. |
||
PUT |
void |
Change the state of a device controlled by ARI. (Note - implicitly creates the device state). |
|
DELETE |
void |
Destroy a device-state controlled by ARI. |
list: GET /deviceStates
List all ARI controlled device states.
get: GET /deviceStates/{deviceName}
Retrieve the current state of a device.
Path parameters
Parameters are case-sensitive.
- deviceName: string - Name of the device
update: 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: 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