Table of Contents

API : IPTV : FlexCare Conference : Get commands

Introduction

This endpoints delivers commands and is used by an app installed on a tablet.

Request

URL https://api.telecomx.dk/iptv/flexcareconference/meeting/:FLEXCARE_CONFERENCE_ID/commands
Method POST
Access level RESELLER, ADMIN
Params FLEXCARE_CONFERENCE_ID Id of the FlexCare Conference meeting.
Body token String Session token for authentication.

Query example

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

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.

Example

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

Errors

Error code Message Description
403 token Access denied
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>