API : IPTV : Device : Action

Introduction

This request will queue an action to be performed on a device. Actions can only be performed on device of type STB or Android tablets.

An action will be carried out when it is scheduled (using when) or immediately if not scheduled, within a timeframe of +/- 1 minute.

Request

URL	https://api.telecomx.dk/iptv/device/DEVICE_ID/action
Method	GET
Access level	MANAGER or OWNER if customer has feature IPTVBUSINESS RESELLER if customer has IPTVBUSINESS or IPTVPRIVATE ADMIN
Params	DEVICE_ID	Id of the device to perform the action on.
Query	type	String	Type of action to perform.
			Type	Access	Description
			MESSAGE	ALL	Display a text message. May contain simple HTML.
			VIDEO	ALL	Show the video as specified in the URL. (STB only)
			PLAYCHANNEL	ALL	Switch to the specified TV channel. (STB only)
			SWITCH_OFF	ALL	Turn the STB off. (STB only)
			CHANNELS	ALL	Update the channels list. (STB only)
			UI	ALL	Reload the user-interface.
			REBOOT	ALL	Reboot the STB.
			DVB	ALL	Update DVB channel configuration. (STB only)
			SCREENSHOT	RESELLER, ADMIN	Take a screenshot of the user-interface. (STB only)
			SPEEDTEST	RESELLER, ADMIN	Perform a speed test, to check the performance of the STB's internet connection. (STB only)
			MANAGEMENT	ADMIN	Setup remote management on the STB. (STB only)
			SCRIPT	ADMIN	Download and run configuration script pointed to by the URL. (STB only)
			JS	ADMIN	Run javascript command in the UI. (STB only)
			FIRMWARE	RESELLER, ADMIN	Initiate an automatic firmware upgrade. (STB only)
			PLAYRADIOCHANNEL	ALL	Play the specified radio channel. (STB only)
			UIDEBUG	ADMIN	Enable the UI debug service. (STB only)
			VOLUME	ALL	Set the volume to the specified level. (STB only)
			EMULATEKEYS	ALL	Emulate pressing keys on the remote control. (STB only)
			START_APP	RESELLER	Opens a given app (ANDROID only).
			UPDATE_APP	RESELLER	Updates a given app (ANDROID only).
			LOCK	RESELLER	Locks the tablet (ANDROID only).
			UNLOCK	RESELLER	Unlocks the tablet (ANDROID only).
	message	String	Message to display (type MESSAGE or VIDEO only).
	video	String	URL of video to play (type VIDEO only).
	channel	String	Id of the TV channel to show (type PLAYCHANNEL only).
	script	String	URL of script to load and run (type SCRIPT only).
	port	Number	Management port to connect to (type MANAGEMENT only).
	js	String	Javascript code to run. (type JS only).
	firmware	String	Override for the default firmware URL (type FIRMWARE only, ADMIN only).
	radiochannel	String	Id of the radio channel to play (type PLAYRADIOCHANNEL only).
	volume	Number	Volume level to set, 0-100 (type VOLUME only).
	debugserver	String	Host and port of the UI debug server, blank for defaults (type UIDEBUG only).
	keys	Array	List of remote control key pressed to emulate. Choose from: NOOP, POWER, MUTE, MIC, CLOCK, NUM1, NUM2, NUM3, NUM4, NUM5, NUM6, NUM7, NUM8, NUM9, NUM0, MENU, BACK, CHANNEL_PREV, CHANNEL_NEXT, EXIT, REFRESH, DELETE, UP, DOWN, LEFT, RIGHT, OK, PAGE_NEXT, PAGE_PREV, NEXT, PREV, VOL_UP, VOL_DOWN, RED, GREEN, YELLOW, BLUE, SERVICES, TV, PHONE, EPG, WEB, APP, REW, FFWD, PLAY, PAUSE, CONTINUE, STOP, REC, INFO, FRAME, AUDIO, NULL, KEYBOARD.
	when	Date	Date and time to deliver the request. Null if as soon as possible.
	duration	Number	How long a message should be shown (type MESSAGE only)
	app	String	Name of the package to open/update (type START_APP or UPDATE_APP only)
	version	String	Version of the package to open/update (type START_APP or UPDATE_APP only)
	notify	String (enum)	(Only on type=message)Possible values: SOUND, READ; when set the device will either read message or play sound
	repeat	Boolean	(Only applicable when notify is set) When true “notify” will be repeated until duration is out

Query examples

https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=MESSAGE&message=Lunch%20is%20ready.
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=VIDEO&message=Watch%20this%20video&video=https%3A%2F%2Fsome.host.dom%2Fpath%2Fvideo.mp4
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=PLAYCHANNEL&channel=1234578901234567890ABCD
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=SWITCH_OFF
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=CHANNELS
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=UI
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=REBOOT
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=DVB
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=SCREENSHOT
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=SPEEDTEST
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=MANAGEMENT&port=1024
https://api.telecomx.dk/iptv/device/12345678901234567890AAAA/action?type=SCRIPT&script=https%3A%2F%2Fsome.host.dom%2Fpath%2Fscript

Response

JSON object
success	Boolean	True on success.
id	Id	Id of the request.

Example

{
  success: true,
  id: '12345678901234567890ABCD'
}

Errors

Error code	Message	Description
404	id	Not found
422	type	Type is invalid
409	type	The type of action has already been scheduled for the STB, but not yet carried out
422	message	Message is missing
422	video	Video is missing or URL is invalid
422	channel	Channel is invalid
422	script	Script is missing or URL is invalid
422	port	Port is invalid
422	js	Javascript code is missing
422	firmware	URL is invalid
422	radiochannel	Channel is invalid
422	volume	Volume is invalid
422	debugserver	Invalid server
422	keys	Invalid key detected
422	keys	No keys specified
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents