Account Settings

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
thumbnailAutoGenerated	Thumbnail Auto Generated
previewAutoGenerated	Preview Auto Generated

Overview

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

Authorization

Access to these endpoints requires following authority:

• ADMIN

Endpoints

1. Get All Account Settings

Method: GET

URL: /api/account/settings

Authorization: Required

Description: Fetches all account settings for the authenticated account.

Example cURL Request:

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

Response :

Returns a JSON object containing a list of account settings.

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

2. Get Account Setting by Key

Method: GET

URL: /api/account/settings/key/{key}

Authorization: Required

Description: Retrieves a specific account setting by its key.

Example cURL Request:

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

Response:

Returns the account setting if found.

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

3. Create Account Setting

Method: POST

URL: /api/account/settings

Authorization: Required

Example cURL Request:

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

Response:

Returns the created account setting.

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

4. Update Account Setting

Method: PUT

URL: /api/account/settings

Authorization: Required

Example cURL Request:

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

Response:

Returns the updated 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

• thumbnailAutoGenerated

• previewAutoGenerated

---

VALUE:

The values for each key are:

• cameraModule: Boolean

• noiseCancelling: Boolean

• transcription: Boolean

• playerAutoPlay: Boolean

• logo: String

• audioMuted: Boolean

• fullscreen: Boolean

• downloadable: Boolean

• thumbnailAutoGenerated: Boolean

• previewAutoGenerated: Boolean