User Tools

Site Tools


api:flexcare:videochat:updatetabletsetting

API : Flexcare : Videochat : Update tablet settings

Introduction

This endpoints updates tablet setting

Request

URL https://api.telecomx.dk/flexcare/videochat/settings/tablet/ADMIN_SETTING_ID
Method POST
Access level RESELLER, ADMIN
Params ADMIN_SETTING_ID Id of the setting
Body _id ObjectId Id of the setting.
customer ObjectId Id of the customer.
tablet Object Setting for tablet
tablet.medcomUri String Url wich telecomx platform can communicate with medcom platform
tablet.cameraOn Boolean If camera is set to on or off at the start of each meeting
tablet.microPhoneOn Boolean If micrphone is set to on or off at the start of each meeting
tablet.setVolume Boolean If tablet should set volume niveu before each meeting
tablet.addParticipant Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
tablet.volume Number Sets the tablet volume before each meeting
tablet.quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
admin Object Admin setting for tablet
admin.flexcare Boolean Use flexcare medcom solution
admin.webView Boolean Uses a webview
admin.webViewUrl String Url to load inside the webview
admin.changeKeyboard Boolean If webview should change the keyboard to numeric
admin.changeKeyboardUrl Boolean The url where keyboard should be changed
admin.changeKeyboardInputId String The id of the input field to change
admin.parameters Object Parameters to check for intercept when loading the room created in the webview
admin.parameters.conference String Conference parameter
admin.parameters.pin String Pin parameter
admin.parameters.name String Name parameter
admin.overrideUrls Array List of urls to intercept and return false

Query example

https://api.telecomx.dk/flexcare/videochat/settings/tablet/1234567890123457890CCCC

Response

JSON object
tablet Object Setting for tablet
tablet.medcomUri String Url wich telecomx platform can communicate with medcom platform
tablet.cameraOn Boolean If camera is set to on or off at the start of each meeting
tablet.microPhoneOn Boolean If micrphone is set to on or off at the start of each meeting
tablet.setVolume Boolean If tablet should set volume niveu before each meeting
tablet.addParticipant Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
tablet.volume Number Sets the tablet volume before each meeting
tablet.quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
admin Object Admin setting for tablet
admin.flexcare Boolean Use flexcare medcom solution
admin.webView Boolean Uses a webview
admin.webViewUrl String Url to load inside the webview
admin.changeKeyboard Boolean If webview should change the keyboard to numeric
admin.changeKeyboardUrl Boolean The url where keyboard should be changed
admin.changeKeyboardInputId String The id of the input field to change
admin.parameters Object Parameters to check for intercept when loading the room created in the webview
admin.parameters.conference String Conference parameter
admin.parameters.pin String Pin parameter
admin.parameters.name String Name parameter
admin.overrideUrls Array List of urls to intercept and return false

Example

{
    tabletSetting: {
       _id: ObjectId('1234567890123457890CCCC'),
       customer: ObjectId('1234567890123457890CCCC'),
       tablet: {
          medcomUri: 'https://rooms.vconf.dk',
          cameraOn: false,
          microPhoneOn: false,
          setVolume: false,
          addParticipant: false,
          volume: 80,
          quality: 'HIGH'
       },
       admin: {
          flexcare: true,
          webView: false,
          webViewUrl: 'https://rooms.vconf.dk',
          changeKeyboard: false,
          changeKeyboardUrl: 'https://rooms.vconf.dk',
          changeKeyboardInputId: 'add-participant',
          parameters: {
             conference: 'room',
             pin:'pin',
             name: 'name'
          },
          overrideUrls: ['https://rooms.vconf.dk']
       }
    }
}

Errors

Error code Message Description
403 token Access denied
404 customer Customer not found
404 tabletSetting Tablet setting not found
422 Invalid data Data is not valid in query
500 internal_error <Unspecified>
api/flexcare/videochat/updatetabletsetting.txt · Last modified: 2025/11/11 09:53 by Gudni Sigurdsson

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki