API : IPTV : Concierge : Create device

Introduction

This will register a device to receive concierge push notifications.

The push token is the device's OneSignal subscription id. The device is always registered under the caller's own customer — when a concierge button owned by that customer is pressed, every device registered under the customer receives a “New service call” push notification. Push tokens that OneSignal rejects as invalid are automatically removed from the registry.

Registration is idempotent on the push token: if the token is already registered, the existing registration is returned unchanged and no new registration is created. Note that this also applies when the token was registered under a different customer — the registration is not moved to the caller's customer.

Request

URL	https://api.telecomx.dk/iptv/concierge/device
Method	POST
Access level	VIEWER
Body	pushToken	`[required]` The device's OneSignal subscription id.

Any other body fields are ignored — the id is generated by the server and the customer is always taken from the caller's token.

Request body

{
   pushToken: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response

Push device
_id	ObjectId	Unique id of the registration
customerId	ObjectId	Id of the customer the device is registered under
pushToken	String	The device's OneSignal subscription id

Example

{
   _id: "1234567890ABCD1234567890",
   customerId: "0987654321DCBA0987654321",
   pushToken: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Errors

Error code	Message	Description
404	pushToken	`pushToken` is required. Returned as “Property is missing.” when omitted or not a string.
400	pushToken	`pushToken` must not be an empty string. Returned as “Push token is required”.
403	access_denied	Insufficient access level — minimum VIEWER required.
500	internal_error	<Unspecified>

WIKI

Table of Contents