API : Flexcare : Videochat : Create room

Introduction

This endpoints creates a conference room

Request

URL	https://api.telecomx.dk/flexcare/videochat/meeting
Method	POST
Access level	RESELLER, ADMIN
Body	customer	ObjectId	Id of customer
	devices	Array	List of devices invited to the room
	participants	Array	List of prticipants invited to the room
	setting	Object	Room settings

Query example

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

Response

JSON object
setting	Object	Setting object
setting._id	ObjectId	Unique id of a setting.
setting.customer	ObjectId	Id of the customer.
setting.subject	String	Medcom, room subject.
setting.description	String	Medcom, room description.
setting.organizedByEmail	String	Medcom, Uniq id of a room.
setting.maxParticipants	String	Medcom, Uniq external id of a room.
setting.endMeetingOnTime	Date	Date when room is created in TCX.
setting.meetingType	String	Medcom, Start time and date formatted to meet medcom requirments.
setting.duration	String	Medcom, End time and date formatted to meet medcom requirments.
setting.guestMicrophoneString	Medcom, Link created by medcom for applications they have.
setting.guestPinRequired	String	Medcom, weblink for guests.
setting.projectCode	String	Medcom, weblink for hosts.
setting.enableOverlayText	String	Medcom, weblink for mobile devices.
setting.tabletSetting	Object	Medcom, room link for tablets.
setting.tabletSetting.medcomUri	Medcom, pin to access the room.
setting.tabletSetting.camerOn	String	Medcom, State of room CREATED, STARTED CLOSED, PROVISION_PROBLEMS PROVISIONED_OK, STARTING_TO_DEPROVISION or DEPROVISION_PROBLEMS.
setting.tabletSetting.microPhoneOn	ObjectId	Setting id.
setting.tabletSetting.setVolume	Array	List of participants
setting.tabletSetting.addParticipants	String	Type of invite SMS or EMAIL.
setting.tabletSetting.volume	String	Number to send sms to or email to mail to.
setting.tabletSetting.quality	String	Sms only, reference number of the sms.
setting.sendSMS	String	Status of the sms.
setting.sms	Array	List of tablets.
setting.schedulingTemplateId	ObjectId	Tablet id.
customer	ObjectId	Id of the customer
participants	Array	List of participants
participants[].type	String	Type of invite SMS or EMAIL.
participants[].value	String	Number to send sms to or email to mail to.
participants[].reference	String	Sms only, reference number of the sms.
participants[].smsStatus	String	Status of the sms.
devices	Array	List of devices
devices[]._id	ObjectId	Tablet id.
devices[].name	String	TAblet name.
devices[].serial	String	Tablet serial number.
devices[].deviceId	String	Tablet device id.
meeting	Object	The room object
meeting._id	ObjectId	Unique id of a setting.
meeting.customer	ObjectId	Id of the customer.
meeting.subject	String	Medcom, room subject.
meeting.startTime	Date	Start date and time of room.
meeting.endTime	Date	End date and time of room..
meeting.description	String	Medcom, room description.
meeting.uuid	String	Medcom, Uniq id of a room.
meeting.externalId	String	Medcom, Uniq external id of a room.
meeting.created	Date	Date when room is created in TCX.
meeting.startTimeMedcom	String	Medcom, Start time and date formatted to meet medcom requirments.
meeting.endTimeMedcom	String	Medcom, End time and date formatted to meet medcom requirments.
meeting.clinicalLink	String	Medcom, Link created by medcom for applications they have.
meeting.guestDesktopLink	String	Medcom, weblink for guests.
meeting.hostDesktopLink	String	Medcom, weblink for hosts.
meeting.mobilLink	String	Medcom, weblink for mobile devices.
meeting.uri	String	Medcom, room link for tablets.
meeting.pin	String	Medcom, pin to access the room.
meeting.state	String	Medcom, State of room CREATED, STARTED CLOSED, PROVISION_PROBLEMS PROVISIONED_OK, STARTING_TO_DEPROVISION or DEPROVISION_PROBLEMS.
meeting.meetingSetting	ObjectId	Setting id.
meeting.participants	Array	List of participants
meeting.participants [].type	String	Type of invite SMS or EMAIL.
meeting.participants [].value	String	Number to send sms to or email to mail to.
meeting.participants [].reference	String	Sms only, reference number of the sms.
meeting.participants [].smsStatus	String	Status of the sms.
meeting.devices	Array	List of tablets.
meeting.devices []._id	ObjectId	Tablet id.
meeting.devices [].name	String	Tablet name.
meeting.devices [].serial	String	Tablet serial number.
meeting.devices [].deviceId	String	Tablet device id.

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
    },
    customer: ObjectId('1234567890123457890CCCC'),
    participants: [
          {
             type: 'SMS',
             value: '+4545454545',
             reference: '1234567890123457890CCCC',
             smsStatus: 'Delivered'
          }
    ],
    devices: [
          {
             _id: ObjectId('1234567890123457890CCCC'),
            serial: 'FLXCA1700937',
            name: 'Test',
            deviceId: '1700937',
            settings: {
                 medcomUri: 'https://rooms.dk',
                 cameraOn: false,
                 microphoneOn: true,
                 setVolume: true,
                 addParticipant: false,
                 volume: 80,
                 quality: 'HIGH'
            }
          }
    ],
    meeting: {
       _id: ObjectId('1234567890123457890CCCC'),
       subject: 'Årlig sundheds check',
       description: 'Gennemgang af patient forløb',
       startTime: '2025-11-04T10:40:23.223+00:00',
       endTime: '2025-11-04T11:40:23.223+00:00',
       externalId: '88f73951-70a6-47f6-be21-d0be415db9e0',
       uuid: 'c6c5365a-2b3c-44ec-82d6-69cdaef8fbbc',
       customer: ObjectId('1234567890123457890CCCC'),
       uri: 'test@rooms.dk',
       pin: '1234',
       desktopLink: 'https://s.test.dias.rm.dk/QcT',
       clinicalLink: 'https://rooms.dk/webapp/?conference=test@rooms.dk&pin=1234&name=Patient',
       mobileLink: 'https://s.test.dias.rm.dk/YuP',
       state: 'CREATED',
       created: ISODate('2016-01-01T00:00:00.000Z'),
       startTimeMedcom: '2025-11-04T10:40:23 +00:00',
       endTimeMedcom: '2025-11-04T11:40:23 +00:00',
       guestDesktopLink: 'https://portal.vconf.dk/?url=test@rooms.dkk&pin=1234',
       hostDesktopLink; 'https://portal.vconf.dk/?url=test@rooms.dk&pin=1234',
       clinicalLink: '',
       mobilLink: 'https://m.vconf.dk/bb4418ce6323',
       participants: [
          {
              type: 'SMS',
              value: '+4545454545',
              reference: '1234567890123457890CCCC',
              smsStatus: 'Delivered'
          }
      ],
      devices: [
          {
            _id: ObjectId('1234567890123457890CCCC'),
            serial: 'FLXCA1700937',
            name: 'Test',
            deviceId: '1700937',
            settings: {
                 medcomUri: 'https://rooms.dk',
                 cameraOn: false,
                 microphoneOn: true,
                 setVolume: true,
                 addParticipant: false,
                 volume: 80,
                 quality: 'HIGH'
            }
          }
      ]
    }
}

Errors

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

WIKI

Table of Contents

API : Flexcare : Videochat : Create room

Introduction

Request

Query example

Response

Example

Errors