Configure room profiles

📘

This feature is supported by HDL300, Dual HDL300, HDL410 and HDX systems.

This tutorial shows how to configure the room profiles of Nureva® devices over the local network.

What are room profiles?

Room profiles allow users to create up to three distinct zone and camera mapping configurations per supported device and switch between them effortlessly. These configurations include:

• For HDL300 and Dual HDL300 devices: the setup of a single active zone on the coverage map, which can vary in size or location across profiles.
• For HDL410 and HDX devices: a list of camera switching zones and their zone-to-camera mappings, which can be uniquely defined for each profile.

This flexibility helps users tailor the room setup to different meeting types without needing to manually reconfigure zones or camera settings each time.

Each room profile has the following properties:

• profileId: A string UUID for the room profile.
• name: A string value representing the name of the room profile. A device cannot have more than one room profile with the same name.
• active: A boolean value representing whether or not the room profile is active. Only one room profile per device can be active at a time.

What can be controlled with the API?

Actions that can be executed using the room profiles endpoints are:

• getting the list of existing room profiles for the device
• creating a new room profile
• updating the name of a room profile
• switching which room profile is active
• deleting a room profile

Get the list of room profiles for the device

Minimum role required: general

The Get room profiles endpoint can be accessed with the general role or any role of a higher level.

Instructions

Use the Get room profiles endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/profiles.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the GET request. The code sample below is a request to retrieve the room profiles for the device with the IP address of 10.0.0.1.

curl --request GET \
     --url https://10.0.0.1/api/v1/room/profiles \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.
7. Parse the response. The example response below indicates that:

• There are three room profiles for the device named "Room Profile 1", "Room Profile 2", and "Room Profile 3".
• The active profile is "Room Profile 2".

{
  "profiles": [
    {
      "profileId": "ae3d90f3-5a1b-44a2-b9d8-d5559466267d",
      "name": "Room Profile 1",
      "active": false
    },
    {
      "profileId": "68413b34-cc80-4140-9ecc-803a6cee035e",
      "name": "Room Profile 2",
      "active": true
    },
    {
      "profileId": "f5be8d1a-2a58-4cf4-8900-d400f5f57c75",
      "name": "Room Profile 3",
      "active": false
    }
  ]
}

Create a new room profile

Validations

• There is a maximum of three profiles per device.

NOTE: The new room profile created will not be activated. To activate it, an additional request must be sent to the Activate room profile endpoint.

Minimum role required: integrator

The Add new profile endpoint can be accessed with the integrator role or any role of a higher level.

Instructions

Use the Add new profile endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/profiles.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Update the headers to include Content-type as key and application/json as value.
6. Update the request body to send a JSON object with "name":"My new profile".
7. Send the POST request. The code sample below is a request to create a new room profile for the device with the IP address of 10.0.0.1.

curl --request POST \
     --url https://10.0.0.1/api/v1/room/profiles \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1' \
     --header 'Content-type: application/json' \
     --data '{"name":"My new profile"}'

8. If the call is successful, an HTTP status code of 200 OK will be returned and the response body will contain the profileId of the created profile. For example,

{
  "profileId": "6eced1db-b730-4f3c-b312-601e60e7598b"
}

Update the name of a profile

Minimum role required: integrator

The Update room profile endpoint can be accessed with the integrator role or any role of a higher level.

Instructions

Use the Update room profile endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/profiles/{profileId} where profileId is the id of the existing profile to update.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Update the headers to include Content-type as key and application/json as value.
6. Update the request body to send a JSON object with "name":"New profile name".
7. Send the PATCH request. The code sample below is a request to update the name of the room profile with id "6eced1db-b730-4f3c-b312-601e60e7598b" for the device with the IP address of 10.0.0.1.

curl --request PATCH \
     --url https://10.0.0.1/api/v1/room/profiles/6eced1db-b730-4f3c-b312-601e60e7598b \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1' \
     --header 'Content-type: application/json' \
     --data '{"name":"New profile name"}'

8. If the call is successful, an HTTP status code of 200 OK will be returned.

Switch the active room profile

Minimum role required: general

The Activate room profile endpoint can be accessed with the general role or any role of a higher level.

Instructions

Use the Activate room profile endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/profiles/{profileId}/active where profileId is the id of the existing profile to activate.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the POST request. The code sample below is a request to activate the room profile with id "6eced1db-b730-4f3c-b312-601e60e7598b" for the device with the IP address of 10.0.0.1.

curl --request POST \
     --url https://10.0.0.1/api/v1/room/profiles/6eced1db-b730-4f3c-b312-601e60e7598b/active \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

8. If the call is successful, an HTTP status code of 200 OK will be returned.

Delete a room profile

Validations

• The active profile cannot be deleted.

Minimum role required: integrator

The Delete room profile endpoint can be accessed with the integrator role or any role of a higher level.

Instructions

Use the Delete room profile endpoint:

1. Set the path with the IP address of the Nureva device followed by /api/v1/room/profiles/{profileId} where profileId is the id of the existing profile to delete.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Send the DELETE request. The code sample below is a request to delete the room profile with id "ae3d90f3-5a1b-44a2-b9d8-d5559466267d" for the device with the IP address of 10.0.0.1.

curl --request DELETE \
     --url https://10.0.0.1/api/v1/room/profiles/ae3d90f3-5a1b-44a2-b9d8-d5559466267d \
     --header 'Authorization: Nureva Z2VuZXJhbDo=' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

8. If the call is successful, an HTTP status code of 200 OK will be returned.

✅

Tutorial complete!

You now know how to configure the room profiles of a Nureva audio device.