api:iptv:radiochannel:list
Table of Contents
API : IPTV : Radio Channel : List
Introduction
This will list the Radio channels available for a resellers customers (when reseller and customer has feature IPTVPRIVATE), or for a business customer (when the customer has the feature IPTVBUSINESS).
Request
| URL | https://api.telecomx.dk/iptv/radiochannel | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if customer has feature IPTVBUSINESS RESELLER if customer has IPTVPRIVATE ADMIN |
|
| Query | offset | [optional] Index of the first channel to return, default 0. |
| limit | [optional] The number of channels to return, default 100, min 1, max 500. |
|
| filter | [optional] To filter the channels, this can be used. Name is searched. |
|
| customer | [optional] Id of the reseller (IPTVPRIVATE), or customer (IPTVBUSINESS), or an end customer (IPTVPRIVATE) to show channels for. Defaults to the users own customer. |
|
Query examples
https://api.telecomx.dk/iptv/radiochannel https://api.telecomx.dk/iptv/radiochannel?offset=25&limit=50&filter=DR&customer=12345678901234567890ABCD
Response
| JSON object | |
|---|---|
| offset | Index of the first channel returned. |
| limit | Number of channels to return. Note that the actual number of channels returned may be lower. |
| total | Number of channels that can be returned when offset and limit is not considered. This is to be used for paging through the data. |
| channels | Array of channels, see definition below. |
| Channel object (JSON) | ||
|---|---|---|
| _id | Id | Unique id of the TV channel. |
| number | Number | Channel number in the list of channels, ex. for direct selection on STB's. |
| name | String | Name of channel. |
| url | String | URL to stream the radio channel from. |
| logo | Id | Id of channel logo, if available. |
Note that properties holding no value may be omitted from the object.
Example - normal
{ offset: 10, limit: 10, total: 23, channels: [ { _id: '12345678901234567890ABCD', number: 7, baseChannel: 7, name: 'DR P7 mix', url: 'http://media.dr.dk/live/p7.m3u8', logo: null }, { ... } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | customer | Customer does not have IPTV |
| 422 | customer | Customer is not an IPTV reseller |
| 500 | internal_error | <Unspecified> |
api/iptv/radiochannel/list.txt · Last modified: 2017/04/27 05:21 by Per Møller