API : IPTV : Concierge event : Create

Introduction

This will report a concierge button press to the platform and trigger push notifications.

The event carries the MQTT topic on which the button press was published. The last segment of the topic is the service id of the pressed button, and the second-to-last segment is the client id of the device that pressed it. The button is resolved to the customer owning the tablet profile it is defined on, and every concierge push device registered under that customer receives a “New service call” notification with the client id and the button's label.

A successful response does not guarantee that any notification was delivered — success is also returned when the customer has no registered push devices.

Request

URL	https://api.telecomx.dk/iptv/concierge/event
Method	POST
Access level	RESELLER The caller must also have read access to the customer owning the pressed button, and that customer must have the FLEXCARE feature.
Body	topic	`[required]` The MQTT topic of the button press. Must contain at least two segments: `…/<clientId>/<serviceId>` — empty segments are ignored.
Body	payloadString	`[optional]` The MQTT payload of the button press. Currently unused.

Request body

{
   topic: "acme/room-101/1234567890ABCD1234567890",
   payloadString: "pressed"
}

Response

JSON object
success	Always true. Also returned when no push devices are registered under the customer owning the button.

Example

{
   success: true
}

Errors

Error code	Message	Description
404	topic	`topic` is required. Returned as “Property is missing.” when omitted or not a string.
404	clientId	Returned as “Client id not found” when the topic contains fewer than two segments.
404	id	Returned as “Button not found” when no button with the given service id exists.
403	access_denied	Insufficient access level — minimum RESELLER required — or the caller does not have read access to the customer owning the button, or that customer does not have the FLEXCARE feature.
500	internal_error	<Unspecified>

WIKI

Table of Contents