User Tools

Site Tools


api:iptv:drm:list

API : IPTV : DRM : List

Introduction

This will list the DRM accounts available for a customers app and web clients. The account contains the credentials and license required by iOS/Android apps and web browser clients.

A customer with IPTVPRIVATE feature, can have 1 account.

A business customer with IPTVBUSINESS feature, can have multiple accounts,

Request

URL https://api.telecomx.dk/iptv/drm
Method GET
Access level VIEWER, MANAGER or OWNER if customer has feature IPTVBUSINESS or IPTVPRIVATE
RESELLER if customer has IPTVPRIVATE
ADMIN
Query offset [optional] Index of the first account to return, default 0.
limit [optional] The number of accounts to return, default 100, min 1, max 500.
filter [optional] To filter the accounts, this can be used. username is searched.
full [optional] If true, complete DRM objects will be returned instead of the condensed version.
customer [optional] Id of the customer to show accounts for. Defaults to the users own customer.

Query examples

https://api.telecomx.dk/iptv/drm
https://api.telecomx.dk/iptv/drm?offset=25&limit=50&filter=5665673625&full=true&customer=12345678901234567890ABCD

Response

JSON object
offset Index of the first account returned.
limit Number of accounts to return. Note that the actual number of accounts returned may be lower.
total Number of accounts that can be returned when offset and limit is not considered. This is to be used for paging through the data.
accounts Array of DRM accounts, see definition below.
DRM account object (JSON)
username String Unique id and username, min 6 chars, e.g. a number or an e-mail address.
password String Password, min 6 chars.
devices Number Number of devices using this account.
created Date Date and time the account was created.
DRM account object if full=true (JSON)
username String Unique id and username, min 6 chars, e.g. a number or an e-mail address.
password String Password, min 6 chars.
devices Array List of devices that are using this login.
devices[].id Id Id of the device.
devices[].type String Type of device: IOS, ANDROID, WEB.
devices[].name String Name of device.
devices[].model String Model of device, if available.
created Date Date and time the account was created.

Note that properties holding no value may be omitted from the object.

Example - normal

{
  offset: 10,
  limit: 10,
  total: 23,
  accounts:
  [
    {
      username: 'donald@duck.com',
      password: 'vgh38gy3uvhebv',
      devices: 2,
      created: '2016-01-01T00:00:00.000Z'
    },
    {
      ...
    }
  ]
}

Example - full=true

{
  offset: 10,
  limit: 10,
  total: 23,
  accounts:
  [
    {
      username: 'donald@duck.com',
      password: 'vgh38gy3uvhebv',
      devices: [
        { id: '12345678901234567890AAAA', type: 'IOS', model: 'iPhone 6', name: 'Donalds mobile' },
        { id: '12345678901234567890BBBB', type: 'WEB', model: 'Chrome', name: '' }
      ],
      created: '2016-01-01T00:00:00.000Z',
    },
    {
      ...
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>
api/iptv/drm/list.txt · Last modified: 2022/09/08 09:49 by Joakim Andersen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki