User Tools

Site Tools


api:iptv:flexcareconference:updatecommandandstate

API : IPTV : FlexCare Conference : Update command and meeting state

Introduction

This endpoints delivers commands, meeting state and meeting settings on a device.

Request

URL https://api.telecomx.dk/iptv/flexcareconference/meeting/FLEXCARE_CONFERENCE_ID/devices/DEVICE_ID
Method GET
Access level RESELLER, ADMIN
Params FLEXCARE_CONFERENCE_ID Id of the FlexCare Conference meeting.
DEVICE_ID Id of a device in a meeting.

Query example

https://api.telecomx.dk/iptv/flexcareconference/meeting/1234567890123457890CCCC/devices/1234567890123457890CCCC

Response

JSON object
commands Array List of devices commands
commands[]._id ObjectId Unique id of a command.
commands[].type String Type of command START_MEETING, CAMERA_ON, MICROPHONE_ON, SET_VOLUME, SET_QUALITY, HANGUP.
commands[].value Boolean If type is CAMERA_ON or MICROPHONE_ON then if this is true then camera or microphone is unmuted.
commands[].volume Number If type is SET_VOLUME then this is the volume niveu in %.
commands[].quality String If type is SET_QUALITY then this is the quality value.
state  String  State of meeting.
settings  Object  
settings.medcomUri String Url wich telecomx platform can communicate with medcom platform
settings.cameraOn Boolean If camera is set to on or off
settings.microphoneOn Boolean If microphone is set to on or off
settings.setVolume Boolean If tablet should set volume niveu
settings.addParticipant Boolean Adds a option to add participants to meeting by email or sms, this is done trough Medcom platform
settings.volume Number Sets the tablet volume
settings.quality String Sets the meeting quality

Example

{
    _id: ObjectId('1234567890123457890CCCC'),
    type: 'SET_QUALITY',
    value: true,
    volume: 80,
    quality: 'LOW'
}

Errors

Error code Message Description
404 id ID not found
404 device Device not found
404 meeting Meeting not found
404 device Device not found in meeting
500 internal_error <Unspecified>
api/iptv/flexcareconference/updatecommandandstate.txt · Last modified: 2025/02/19 14:06 by Gudni Sigurdsson

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki