Table of Contents

API : Flexcare : Videochat : Get setting

Introduction

This endpoints retrives setting based on id

Request

URL https://api.telecomx.dk/flexcare/videochat/setting/SETTING_ID
Method GET
Access level RESELLER, ADMIN
Params SETTING_ID ObjectId Id of the setting.

Query example

https://api.telecomx.dk/flexcare/videochat/setting/1234567890123457890CCCC

Response

JSON object
settings Array List of settings
settings []._id ObjectId Unique id of a setting.
settings [].name String Name of setting.
settings [].customer ObjectId Id of the customer.
settings [].subject String Medcom, room subject.
settings [].description String Medcom, room description.
settings [].defaultSetting Boolean Default setting for tablets
settings [].maxParticipants Number Limits how many can be in the room at one time.
settings [].endMeetingOnTime Boolean End meeting on on time.
settings [].meetingType String Medcom, enum NORMAL or POOL.
settings [].duration Number How long room is open in minutes.
settings [].guestMicrophone Boolean Medcom, if guest microphone is mutedor not.
settings [].guestPinRequired Boolean Medcom, if guest requires pin.
settings [].projectCode String Medcom, code to identify the room in medcom.
settings [].enableOverlayText Boolean Medcom, weblink for guests.
settings [].tabletSetting Object Setting for talbets.
settings [].tabletSetting.medcomUri String Url wich telecomx platform can communicate with medcom platform
settings [].tabletSetting.camerOn Boolean If camera is set to on or off at the start of each meeting
settings [].tabletSetting.microPhoneOn Boolean If micrphone is set to on or off at the start of each meeting
settings [].tabletSetting.setVolume Boolean If tablet should set volume niveu before each meeting
settings [].tabletSetting.addParticipants Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
settings [].tabletSetting.volume Number Sets the tablet volume before each meeting
settings [].tabletSetting.quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
settings [].sendSMS Boolean If this should send SMS.
settings [].sms ObjectId Id of the sms.
settings [].schedulingTemplateId Number Backgorund for the meeting, Medcom.

Example

{
    settings: 
       {
          _id: ObjectId('1234567890123457890CCCC'),
          name: 'Standard møde',
          customer: ObjectId('1234567890123457890CCCC'),
          defaultSetting: true,
          subject: 'Årlig sundheds check',
          description: 'Gennemgang af patient forløb',
          organizedByEmail: 'system@flexcare.dk',
          maxParticipants: 5,
          endMeetingOnTime: false,
          meetingType: 'POOL',
          duration: 60,
          guestMicrophone: true,
          guestPinRequired: true,
          projectCode: 'Årlig check',
          enableOverlayText: true,
          tabletSetting: {
             medcomUri: 'https://rooms.vconf.dk',
             camerOn: true,
             microPhoneOn: true,
             setVolume: true,
             addParticipants: false,
             volume: 80,
             quality: 'HIGH'
          },
          sendSMS: true,
          sms: ObjectId('1234567890123457890CCCC'),
          schedulingTemplateId: 5
       } 
}

Errors

Error code Message Description
403 token Access denied
404 customer Customer not found
404 setting Setting not found
422 Invalid data Data is not valid in query
500 internal_error <Unspecified>