Table of Contents

API : IPTV : FlexCare Conference : Create

Introduction

This will create a FlexCare Conference.

Request

URL https://api.telecomx.dk/iptv/flexcareconference/meeting
Method POST
Access level RESELLER, ADMIN
Body customer Id Id of the customer.
employee String Id of the employee.
devices Array List of devices.
devices[]._id Id Unique id of the device.
devices[].name String Name of device.
devices[].serial String Serial number of the device.
devices[].deviceId String Id generated by the device.
devices[].technicalRoomNumber String Room number, location.
devices[].settings Object Settings from customer/reseller.
devices[].commands Array List of commands (Should be empty).

Query example

https://api.telecomx,dk/iptv/flexcareconference/meeting

Response

JSON object
_id ObjecId Unique id of the Conference
customer  ObjectId  Unique id of the customer
employee  ObjectId  Unique id of the employee who created conference in telecomx platform
uri String Uri to identify meeting, created by Medcom
pin String Pin to access conference, created by Medcom
desktopLink String  Link for desktop devices, created by Medcom
clinicalLink  String Link for clinic devices, created by Medcom
mobileLink String  Link for mobile devices, created by Medcom
state String State of conference: CREATED, STARTED, CLOSED
created Date(ISO) Date of when conference is created
devices Array List of IptvDevices added to thie conference
devices[]._id  ObjectId  Unique id of the device
devices[].technicalRoomNumber  String  Room number, location
devices[].serial String Serial number of the device
devices[].name String Name of device
devices[].deviceId String Id generated by the device
settings Object Current readonly data about the device.
devices[].settings.medcomUri String Url wich telecomx platform can communicate with medcom platform
devices[].settings.cameraOn Boolean If camera is set to on or off at the start of each meeting
devices[].settings.microphoneOn Boolean If micrphone is set to on or off at the start of each meeting
devices[].settings.setVolume Boolean If tablet should set volume niveu before each meeting
devices[].settings.addParticipant Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
devices[].settings.volume Number Sets the tablet volume before each meeting
devices[].settings.quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
commands Array List of commands send to device during a meeting
devices[].commands[]._id  ObjectId  Name of product
devices[].commands[].type  String  Type of command: START_MEETING, START_MEETING, CAMERA_ON, MICROPHONE_ON, SET_QUALITY, SET_VOLUME, HANGUP,
devices[].commands[].volume Number Sets the volume niveu
devices[].commands[].value Boolean If type is either MICROPHON_ON or CAMERA_ON, it turns on or off the camera or microphone based on the value
devices[].commands[].quality String Sets the meeting quality to: LOW, MEDIUM, HIGH, VERY_HIGH
devices[].commands[].fetched Boolean Indicates if android device has fetched the command
devices[].commands[].executed Boolean Indicates if android device has executed the command

Example

{
    _id: ObjectId('1234567890123457890CCCC'),
    customer: ObjectId('1234567890123457890CCCC'),
    employee: 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'),
    devices: [
        {
            _id: ObjectId('1234567890123457890CCCC'),
            technicalRoomNumber: '50',
            serial: 'FLXCA1700937',
            name: 'Test',
            deviceId: '1700937',
            settings: {
                 medcomUri: 'https://rooms.dk',
                 cameraOn: false,
                 microphoneOn: true,
                 setVolume: true,
                 addParticipant: false,
                 volume: 80,
                 quality: 'HIGH'
            },
            commands: []
        }
    ]
}

Errors

Error code Message Description
400 meeting Meeting not in body
400 employee Employee is invalid
400 customer Customer is invalid
404 customer Customer not found
409 customer Customer does not have IPTV
500 internal_error <Unspecified>