Returns device information for the connected Nureva® audio conferencing system, including the model and firmware version.
Request
{
"request": "v1/devices/info",
"requestId": string,
"clientId": string
}
Response
{
"request": "v1/devices/info",
"requestId": string,
"clientId": string,
"body": {
"model": string,
"firmwareVersion": string
}
}
| model | The model of the default device. Possible values:
|
| firmwareVersion | The firmware version of the default device. Format: x.y.z |
Errors
| Status code | Description |
|---|---|
| 10000 – Bad request | Request does not conform to the specification. The message field will include detailed information about which part of the request is incorrect. |
| 11000 – Unsupported device | Connected hardware device does not support audio location streaming. |
| 11001 – Device not connected | No audio device is connected. |
Sample requests
1. Valid request/response
Request
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test"
}
Response
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test",
"body": {
"firmwareVersion": "3.1.9",
"model": "hdl300"
}
}
2. Invalid request - no requestId or clientId
Request
{
"request": "v1/devices/info",
"requestId": "",
"clientId": ""
}
Response
{
"request": "v1/devices/info",
"requestId": "",
"clientId": "",
"errors": [
{
"statusCode": 10000,
"message": "clientId: String can't be empty or whitespace"
},
{
"statusCode": 10000,
"message": "requestId: String can't be empty or whitespace"
}
]
}
3. clientId parameter is too long
Request
{
"request": "v1/devices/info",
"requestId": "",
"clientId": "This_id_is_longer_than_fifty_characters_and_is_too_long! "
}
Response
{
"request": "v1/devices/info",
"requestId": "",
"clientId": "",
"errors": [
{
"statusCode": 10000,
"message": "clientId: Storing must contain at most 50 character(s)"
},
{
"statusCode": 10000,
"message": "requestId: String can't be empty or whitespace"
}
]
}
4. No device connected
This is a valid request, but returns an error because no audio device is connected.
Request
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test"
}
Response
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test",
"errors": [
{
"statusCode": 11001,
"message": "Device not connected"
}
]
}
5. Unsupported device
This is a valid request, but returns an error because an unsupported audio device is connected.
Request
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test"
}
Response
{
"request": "v1/devices/info",
"requestId": "3abe203s-42b7-4b0b-9awaf-5c381793a192",
"clientId": "test",
"errors": [
{
"statusCode": 11000,
"message": "Unsupported device"
}
]
}