Table of Contents

API : Flexcare : Videochat : Create setting

Introduction

This endpoints creates setting

Request

URL https://api.telecomx.dk/flexcare/videochat/settings
Method POST
Access level RESELLER, ADMIN
Body _id ObjectId Id of setting
name String Name of the setting
customer ObjectId Id of the customer
defaultSetting Boolean If this is the default setting for tablets
subject String Sets the room subject when created
description String Sets the room description when created
organizedByEmail String Email of the organizer
maxParticipants Number Sets the max participants when room is created
endMeetingOnTime Boolean If room should close when it reaches end time
meetingType String Enum POOL or NORMAL
duration Number Minutes, how long should the room be open
guestMicrophone Boolean Guest, if microphone is on or not when participant enters the room
guestPinRequired Boolean Guest, if pin is required when participant enters the room
projectCode String Medcom, requirement
schedulingTemplateId Number Sets the room background
enableOverlayText Boolean If participants name should be visible or not
tabletSetting String Name of the message
tabletSetting.medcomUri String Url wich telecomx platform can communicate with medcom platform
tabletSetting.cameraOn Boolean If camera is set to on or off at the start of each meeting
tabletSetting.microPhoneOn Boolean If micrphone is set to on or off at the start of each meeting
tabletSetting.setVolume Boolean If tablet should set volume niveu before each meeting
tabletSetting.addParticipant Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
tabletSetting.volume Number Sets the tablet volume before each meeting
tabletSetting.quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
sendSMS Boolean If this should send SMS.
sms ObjectId Id of the sms.

Query example

https://api.telecomx.dk/flexcare/videochat/settings

Response

JSON object
settings Array List of settings
settings[]._id ObjectId Id of setting
settings[].name String Name of the setting
settings[].customer ObjectId Id of the customer
settings[].defaultSetting Boolean If this is the default setting for tablets
settings[].subject String Sets the room subject when created
settings[].description String Sets the room description when created
settings[].organizedByEmail String Email of the organizer
settings[].maxParticipants Number Sets the max participants when room is created
settings[].endMeetingOnTime Boolean If room should close when it reaches end time
settings[].meetingType String Enum POOL or NORMAL
settings[].duration Number Minutes, how long should the room be open
settings[].guestMicrophone Boolean Guest, if microphone is on or not when participant enters the room
settings[].guestPinRequired Boolean Guest, if pin is required when participant enters the room
settings[].projectCode String Medcom, requirement
settings[].schedulingTemplateId Number Sets the room background
settings[].enableOverlayText Boolean If participants name should be visible or not
settings[].tabletSetting String Name of the message
settings[].tabletSetting.medcomUri String Url wich telecomx platform can communicate with medcom platform
settings[].tabletSetting.cameraOn 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.addParticipant 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.

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 sms SMS not found
422 Invalid data Data is not valid in query
500 internal_error <Unspecified>