api:iptv:drmprofile:create
Table of Contents
API : IPTV : DRM Profile: Create
Introduction
This request will create a new profile for a DRM account. IPTV Private only.
Request
| URL | https://api.telecomx.dk/iptv/drmprofile | ||
|---|---|---|---|
| Method | POST | ||
| Access level | MANAGER or OWNER if customer has feature IPTVBUSINESS or IPTVPRIVATE RESELLER if customer has IPTVBUSINESS or IPTVPRIVATE ADMIN |
||
| Body | name | String | Profile name |
| drmAccount | String | Username/ID of the DRM account to create the account for. | |
| audioLanguage | String | [optional] Preferred audio language. Defaults to 'dan' |
|
| subtitleLanguage | String | [optional] Preferred subtitle language. Defaults to 'dan' |
|
| useSdhSubtitles | Boolean | [optional] Use subtitles for hearing-impaired when available. Defaults to false |
|
| streamingServices | Array<String> | [optional] List of streaming services enabled for this profile. Allowed values are NETFLIX, VIAPLAY. |
|
| channels | Array<ObjectId> | [optional] List of channels, which are visible for this profile. |
|
Query example
{
name: 'Dad',
drmAccount: 'bob.jackson',
streamingServices: ['NETFLIX', 'VIAPLAY'],
audioLanguage: 'dan',
subtitleLanguage: 'dan',
useSdhSubtitles: false,
channels: [
'1234567890ABCD1234567890',
'8434567890ABCD1234567890'
]
}
Response
The newly created profile.
| JSON object | ||
|---|---|---|
| _id | ObjectId | Unique ID |
| name | String | Profile name |
| drmAccount | String | Unique username/ID of the DRM account it belongs to. |
| customer | Id | Id of customer this DRM profile belongs to |
| audioLanguage | String | Preferred audio language |
| subtitleLanguage | String | Preferred subtitle language |
| useSdhSubtitles | Boolean | Use subtitles for hearing-impaired when available |
| Streaming services | Array | List of streaming services enabled for this profile. (IPTV Private only) |
| streamingServices[]._id | String | ID of streaming service |
| streamingServices[].name | String | Display name of streaming services |
| streamingServices[].logo | String | URL to logo of streaming service |
| Available streaming services | Array | List of the streaming services that have not been selected for this profile. (IPTV Private only) |
| availableStreamingServices[]._id | String | ID of streaming service |
| availableStreamingServices[].name | String | Display name of streaming services |
| availableStreamingServices[].logo | String | URL to logo of streaming service |
| channels | Array<ObjectId> | List of channels, which are visible for this profile. |
Note that properties holding no value may be omitted from the object.
Example
{ _id: '1234567890ABCD1234567890', name: 'Dad', drmAccount: 'bob.jackson', customer: '1234567890ABCD1234567890', streamingServices: ['NETFLIX', 'VIAPLAY'], audioLanguage: 'dan', subtitleLanguage: 'dan', useSdhSubtitles: false, channels: [ '1234567890ABCD1234567890', '8434567890ABCD1234567890' ], availableChannels: [ '3234567890ABCD123456789', '4234567890ABCD123456789', ... ], streamingServices: [ { _id: "AMAZON_PRIME", name: "Amazon Prime", logo: "https://example.image.com/1234567890ABCD1234567890.png" } ], availableStreamingServices: [ { _id: "DR_TV", name: "DR TV", logo: "https://example.image.com/1234567890ABCD1234567890.png" }, { _id: "TV_2_PLAY", name: "TV 2 Play", logo: "https://example.image.com/1234567890ABCD1234567890.png" }, ... ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | DRM profile not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/iptv/drmprofile/create.txt · Last modified: 2022/10/11 11:29 by Joakim Andersen