Register new room device

post

https://{nurevaDeviceIP}/api/v1/room/devices

Allows clients to register a new room device configuration. Depending on the connected device type and current capabilities, this can include IP devices, camera switchers, auxiliary devices, CV30 devices, external microphones, subwoofers, and Nureva audio devices.

Minimum role required: general

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

Nureva-Client-Id

string

required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

Nureva-Client-Version

string

required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Body Params

The request body to register a new room device.

Request body for registering a room device. The shape varies by device type.

deviceType

string

enum

required

The type of room device to register.

Allowed:

ipDeviceType

string

enum

The subtype of IP device when deviceType is ip-device.

Allowed:

otherDeviceType

string

Only include this property when ipDeviceType is Other. Use it to provide the custom device type label for that IP device.

manufacturerName

string

Manufacturer name of the IP device being registered.

modelName

string

Model name of the configured IP device.

customName

string

User-defined display name for the room device.

ipAddress

string

IPv4 address for an IP device.

port

integer

Port number used to communicate with an IP device or camera switcher.

ipOrHostname

string

IP address or hostname used to communicate with the camera switcher.

username

string

Username used to generate a camera switcher access token. Must be paired with password.

password

string

Password used to generate a camera switcher access token. Must be paired with username.

accessToken

string

Access token used to communicate with the camera switcher.

enabled

boolean

Indicates whether the camera switcher integration is enabled.

model

string

Camera switcher model name.

channelNumber

integer

HDX-only channel number. For auxiliary inputs, mono channels can use 1 through 4, while stereo channels must start on channel 1 or 3.

channelType

string

enum

HDX-only channel mode for an auxiliary input or auxiliary output.

Allowed:

voiceAmplificationEnabled

boolean

True to enable Adaptive Voice Amplification; false to disable it.

voiceAmplificationLevel

integer

Adaptive Voice Amplification level for an external microphone.

voiceAmplificationAuxInLevel

string

enum

The auxiliary input level used by Adaptive Voice Amplification.

Allowed:

microphoneDuckingEnabled

boolean

True to enable microphone ducking; false to disable it.

voiceAmplificationGateThreshold

number

Gate threshold that determines when the external microphone opens.

voiceAmplificationUsbOutputGainLevel

number

USB output gain level used for external microphone audio sent to conferencing and recording outputs.

auxiliaryOutputState

string

enum

Auxiliary output mode used for an auxiliary output device.

Allowed:

Responses

200Success

400Bad Request. Either one of the required headers are missing

401Unauthorized. Invalid or missing credentials

403Forbidden. The authenticated user does not have sufficient permissions for this endpoint

429Too many requests. Rate limit is exceeded

500Internal Server Error. Unexpected error has occurred.