API : IPTV : Concierge button : Get multiple

Introduction

This will return details for one or more concierge buttons.

Concierge buttons are not stored in their own collection — they are the service-call buttons defined on the pages of IPTV tablet profiles, identified by their MQTT service id. The concierge app uses this endpoint to resolve the buttons it has been configured with into a label, an image and the owning customer.

This is an all-or-nothing lookup of specific ids, not a paged list: every requested button must exist, otherwise the whole request fails and no buttons are returned.

Request

URL	https://api.telecomx.dk/iptv/concierge/button
Method	GET
Access level	VIEWER The caller must also have read access to every customer that owns a matched button, and those customers must have the FLEXCARE feature.
Query	buttons	`[required]` Comma-separated list of button ids (the MQTT service ids). Entries that are not valid ObjectIds are silently ignored.

Query examples

https://api.telecomx.dk/iptv/concierge/button?buttons=1234567890ABCD1234567890
https://api.telecomx.dk/iptv/concierge/button?buttons=1234567890ABCD1234567890,ABCD1234567890ABCD123456

Response

The response is a JSON array of buttons, in the same order as the requested ids.

Button
buttonId	ObjectId	Id of the button (the button's MQTT service id)
label	String	Label of the button
customerId	ObjectId	Id of the customer that owns the tablet profile the button is defined on
image	String	URL of the button image (400×400, includes the caller's own token). Empty string when the button has no image.

Example

[
   {
     buttonId: "1234567890ABCD1234567890",
     label: "Room service",
     customerId: "0987654321DCBA0987654321",
     image: "https://image.powernet.tv/dcba09876543210987654321.png?token=<your token>&width=400&height=400"
   }
]

Errors

Error code	Message	Description
400	buttons	The `buttons` query parameter is missing or empty.
404	id	Returned as “Button not found” when none of the given ids are valid ObjectIds, or when any of the requested buttons does not exist on a tablet profile. No buttons are returned in that case.
403	access_denied	Insufficient access level — minimum VIEWER required — or the caller does not have read access to a customer owning one of the buttons, or that customer does not have the FLEXCARE feature.
500	internal_error	<Unspecified>

WIKI

Table of Contents