API : IPTV : Device : Group Action

Introduction

This request will perform an action on a group of device. Actions can only be performed on devices of type STB.

An action will be carried out within 1-60 seconds depending on the type.

If the requested action has already been scheduled for an STB but not yet carried out, it will be skipped for that STB.

Request

URL	https://api.telecomx.dk/iptv/device/action
Method	GET
Access level	MANAGER or OWNER if customer has feature IPTVBUSINESS RESELLER if customer has IPTVBUSINESS or IPTVPRIVATE ADMIN
Query	group	Id	Id of the device group to perform the action on, or ALL or WORLD.
	reseller	Id	If group is ALL, and user is ADMIN, this is the reseller/customer that the devices belongs to. Ignored in all other cases.
	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.
			PLAYCHANNEL	ALL	Switch to the specified TV channel.
			SWITCH_OFF	ALL	Turn the STB off.
			CHANNELS	ALL	Update the channels list.
			UI	ALL	Reload the user-interface.
			REBOOT	ALL	Reboot the STB.
			DVB	ALL	Update DVB channel configuration.
			SCREENSHOT	RESELLER, ADMIN	Take a screenshot of the user-interface.
			SPEEDTEST	RESELLER, ADMIN	Perform a speed test, to check the performance of the STB's internet connection.
			MANAGEMENT	ADMIN	Setup remote management on the STB.
			SCRIPT	ADMIN	Download and run configuration script pointed to by the URL.
			JS	ADMIN	Run javascript command in the UI.
			FIRMWARE	RESELLER, ADMIN	Initiate an automatic firmware upgrade.
			PLAYRADIOCHANNEL	ALL	Play the specified radio channel.
			UIDEBUG	ADMIN	Enable the UI debug service.
			VOLUME	ALL	Set the volume to the specified level.
			EMULATEKEYS	ALL	Emulate pressing keys on the remote control.
	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).
	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.
	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/action?group=12345678901234567890AAAA&type=MESSAGE&message=Lunch%20is%20ready.
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=VIDEO&message=Watch%20this%20video&video=https%3A%2F%2Fsome.host.dom%2Fpath%2Fvideo.mp4
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=PLAYCHANNEL&channel=1234578901234567890ABCD
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=SWITCH_OFF
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=CHANNELS
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=UI
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=REBOOT
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=DVB
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=SCREENSHOT
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=SPEEDTEST
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=MANAGEMENT&port=1024
https://api.telecomx.dk/iptv/device/action?group=12345678901234567890AAAA&type=SCRIPT&script=https%3A%2F%2Fsome.host.dom%2Fpath%2Fscript

Response

JSON object
success	Boolean	True on success.
devices	Number	Number of devices the action has been scheduled for.
skipped	Number	Number of devices the action was skipped for.

Example

{
  success: true,
  devices: 23,
  skipped: 2
}

Errors

Error code	Message	Description
404	group	Not found
422	type	Type is invalid
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