User Tools

Site Tools


api:iptv:appwhitelist:list

API : IPTV : App whitelist : List

Introduction

This will list all the apps which an IPTVBUSINESS customer has access to.

This whitelist is used to determine which apps can be assigned to a tablet profile.

Request

URL https://api.telecomx.dk/iptv/appwhitelist
Method GET
Access level VIEWER, MANAGER or OWNER if customer has feature IPTVBUSINESS or IPTVPRIVATE
RESELLER if customer has IPTVPRIVATE or IPTVBUSINESS
ADMIN
Query offset [optional] Index of the first tablet profile to return, default 0.
limit [optional] The number of tablet profiles to return, default 100, min 1, max 500.
filter [optional] To filter the tablet profile on name.
all [optional] If true, all customers for all resellers will be returned (ADMIN only).
customer [optional] Id of the customer to show tablet profiles for. Defaults to the users own customer.

Query examples

https://api.telecomx.dk/iptv/appwhitelist
https://api.telecomx.dk/iptv/appwhitelist?offset=25&limit=50&customer=12345678901234567890ABCD&filter=chess
https://api.telecomx.dk/iptv/appwhitelist?all=true&filter=chess

Response

JSON object
offset Index of the first device returned.
limit Number of devices to return. Note that the actual number of devices returned may be lower.
total Number of devices that can be returned when offset and limit is not considered. This is to be used for paging through the data.
apps Array of apps, see definition below.
App
_id String Unique Android package name for the app
name String App name
icon ObjectId Id of the image
androidTV Boolean? Whether application is an androidTV application
iconUrl String Default icon url, used for having a default icon for tablet profile
minimumVersion Number Minimum build version wanted
apks Array List of APKs for different versions of this app
apks[].url String URL to download Android package.
apks[]._id ObjectId Unique object ID
apks[].version String App version
apks[].default String True if this is chosen as the default version of the app.
apks[].file ObjectId File ID
customerWhitelist Array Array of customer IDs (ObjectIDs). If the list is empty, then the app is allowed to be added to all tablet profiles. If it's not empty, then the customers added to this list are the only ones allowed to use this app. Note that if a reseller is added to this list, then all of their customers are also allowed to access this app.

Example

{
   offset: 0,
   limit: 100,
   total: 1,
   apps: [
     {
       _id: "com.fitnessapps.marafun",
       name: "MaraFUN",
       icon: "1234567890ABCD1234567890",
       iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
       minimumVersion: 123456,
       androidTV: false,
       apks: [
         {
           _id: '1234567890ABCD1234567890',
           url: 'https://doc.telecomx.dk/1234567890ABCD1234567890',
           version: '1.0',
           default: true
         }
       ],
       customerWhitelist: []
     }
}

Errors

Error code Message Description
403 access_denied Insufficient access level
403 customer Customer does not have required feature
404 customer Customer not found
500 internal_error <Unspecified>
api/iptv/appwhitelist/list.txt · Last modified: 2025/10/31 08:07 by Mikkel Frederiksen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki