Sub-Account Setting

SubAccountSettingsController Documentation

Deprication Warning

This document is archived and will be maintained only until September 15. Please refer to the latest documentation here for updated information.

This is the list of settings where the value of ‘JSON Name’ must be sent in the requests

JSON Name	Display Name
cameraModule	Camera Module
noiseCancelling	Noise Cancelling
transcription	Transcription
playerAutoPlay	Player Auto Play
logo	Logo
audioMuted	Audio Muted
fullscreen	Fullscreen
downloadable	Downloadable

Overview

The SubAccountSettingsController provides endpoints for managing sub account settings. It supports creating, retrieving, updating, and deleting sub account settings associated with an sub account.

Base URL

/api/subaccount/settings

Authorization

Access to these endpoints requires following authority:

• ADMIN

Endpoints

1. Get All SubAccount Settings

Method: GET

URL: /api/subaccount/settings

Authorization: Required

Description: Fetches all sub account settings for the authenticated sub account.

Example cURL Request:

curl --location --request GET 'https://sdk-mobile-api.truvideo.com/api/subaccount/settings' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}'

Response:

Returns a JSON object containing a list of sub account settings.

{
    "settings": [
        {
            "key": "downloadable",
            "value": true
        }
    ]
}

2. Get Sub Account Setting by Key

Method: GET

URL: /api/subaccount/settings/key/{KEY}

Authorization: Required

Description: Retrieves a specific sub account setting by its key.

Example cURL Request:

curl --location --request GET 'https://sdk-mobile-api.truvideo.com/api/subaccount/settings/key/{{KEY}}' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}'

Response:

Returns the sub account setting if found.

{
    "key": "noiseCancelling",
    "value": true
}

3. Create Sub Account Setting

Method: POST

URL: /api/subaccount/settings

Authorization: Required

Request Body:

The request body should include a JSON object conforming to the CreateSubsAccountSettingDTO structure.

{
    "key": {{KEY}},
    "value": {{VALUE}}
}

Example cURL Request:

curl --location --request POST 'https://sdk-mobile-api.truvideo.com/api/subaccount/settings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}' \
--data '{
    "key": {{KEY}},
    "value": {{VALUE}}
}'

Response:

Returns the created sub account setting.

{
    "key": "downloadable",
    "value": false
}

1. Update Sub Account Setting

Method: PUT

URL: /api/subaccount/settings

Authorization: Required

Request Body:

The request body should include a JSON object conforming to the UpdateSubAccountSettingDTO structure.

{
    "key": {{KEY}},
    "value": {{VALUE}}
}

Example cURL Request:

curl --location --request PUT 'https://sdk-mobile-api.truvideo.com/api/subaccount/settings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{YOUR-ACCESS-TOKEN}}' \
--data '{
    "key": {{KEY}},
    "value": {{VALUE}}
}'

Response :

Returns the updated sub account setting.

{
    "key": "transcription",
    "value": true
}

Params:

BASE-URL:

• Release Candidate (RC): https://sdk-mobile-api-rc.truvideo.com

• Production: https://sdk-mobile-api.truvideo.com

---

YOUR-ACCESS-TOKEN:

Access token provided by the endpoint mentioned on this documentation: [SDK Mobile] - Generate an API Token

---

KEY:

The key must be one of this json names:

• cameraModule

• noiseCancelling

• transcription

• playerAutoPlay

• logo

• audioMuted

• fullscreen

• downloadable

---

VALUE:

The values for each key are:

• cameraModule: Boolean

• noiseCancelling: Boolean

• transcription: Boolean

• playerAutoPlay: Boolean

• logo: String

• audioMuted: Boolean

• fullscreen: Boolean

• downloadable: Boolean