Application API

Private API for this project

Authentication

Authentication - Authenticate with Facebook

Authenticates a user using Facebook.

Basic flow:

  • API verifies user identity based on Facebook profile details
  • If user is found and account is already linked to Facebook, return user details.
  • If user is found but it's not linked to Facebook, link accounts and return user details.
  • If user is not found, sign up user, link accounts and return user details.

http://www.domain.com/api/:application_id/authenticate/facebook

Permission: use_api  

curl -i -d id=1234 -d email=email@example.com http://www.domain.com/api/1001/authenticate/facebook

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

Use the string <guest> as the authentication key.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
id String

The id of the Facebook account. This id is unique to each app.

email String

The primary email address listed on the Facebook profile.

first_name optional String

The first name listed on the Facebook profile.

last_name optional String

The last name listed on the Facebook profile.

200 OK Response

Field Type Description
id Int

The user id (either new or existing user).

api_auth_key String

The user authentication key used to authenticate API calls.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 10001,
  "api_auth_key": "abc"
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Authentication - Authenticate with Twitter

Authenticates a user using Twitter.

Basic flow:

  • API verifies user identity based on Twitter Oauth token and token secret
  • If user is found and account is already linked to Twitter, return user details.
  • If user is found but it's not linked to twitter, link accounts and return user details.
  • If user is not found, sign up user, link accounts and return user details.

http://www.domain.com/api/:application_id/authenticate/twitter

Permission: use_api  

curl -i -d oauth_token=abc -d oauth_token_secret=abc123 http://www.domain.com/api/1001/authenticate/twitter

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

Use the string <guest> as the authentication key.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
oauth_token String

The Twitter oauth token.

oauth_token_secret String

The Twitter oauth token secret.

200 OK Response

Field Type Description
id Int

The user id (either new or existing user).

api_auth_key String

The user authentication key used to authenticate API calls.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 100546,
  "api_auth_key": "abc"
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Authentication - Authenticate with username and password

Authenticates a user using username and password.

http://www.domain.com/api/:application_id/authenticate

Permission: use_api  

curl -i -d username=john -d password=abc123 http://www.domain.com/api/1001/authenticate

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

Use the string <guest> as the authentication key.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
username String

The username of the user who wants to access the API.

password String

The MD5 password hash of the user who wants to access the API.

200 OK Response

Field Type Description
id Int

The user id (either new or existing user).

api_auth_key String

The user authentication key used to authenticate API calls.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 100546,
  "api_auth_key": "abc"
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Authentication - Forget authentication key

Invalidates the API authentication key for the current user and any subsequent requests using this key will fail.

http://www.domain.com/api/:application_id/authenticate

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/authenticate

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Broadcasters

Broadcasters - Retrieve all active broadcasters

Retrieves a list of all active broadcasters.

http://www.domain.com/api/:application_id/broadcasters

Permission: use_api  

curl -i http://www.domain.com/api/1001/broadcasters

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional string

How to order the retrived broadcasters. Available options: 'id', 'username', 'firstname', 'lastname'.

Default value: id

direction optional string

How to sort broadcasters. Available options: 'ASC' or 'DESC'.

Default value: ASC

200 OK Response

Field Type Description
broadcasters Object[]

A list of active broadcasters.

  id Int

The broadcaster id.

  username String

The broadcaster username.

  firstname String

The broadcaster first name.

  lastname String

The broadcaster last name.

  url String

The URL to the public profile page for this broadcaster.

  img String

The URLs for the broadcaster profile images.

    large String

The URL for the large broadcaster profile image (960x960).

    medium String

The URL for the medium broadcaster profile image (640x640).

    small String

The URL for the small broadcaster profile image (320x320).

    custom String

The URL for the custom broadcaster profile image.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "broadcasters": [{
    "id": 6,
    "username": "someusername",
    "firstname": "Some",
    "lastname": "User",
    "url": "http:\/\/www.domain.com\/user\/someusername",
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-960x960-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-640x640-000000.jpg"
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-320x320-000000.jpg"
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-[width]x[height]-000000.jpg"
    }
  }, {
    "id": 11,
    "username": "anotherusername",
    "firstname": "Another",
    "lastname": "User",
    "url": "http:\/\/www.domain.com\/user\/anotherusername",
    "img": {
      "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/11\/11-960x960-000000.jpg",
      "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/11\/11-640x640-000000.jpg",
      "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/11\/11-320x320-000000.jpg",
      "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/11\/11-[width]x[height]-000000.jpg"
    }
  }],
  "order": {
      "field": "id",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Broadcasters - Retrieve data of an broadcaster

Retrieves information about a particular broadcaster.

http://www.domain.com/api/:application_id/broadcasters/:id

Permission: use_api  

curl -i http://www.domain.com/api/1001/broadcasters/100546

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The broadcaster id.

200 OK Response

Field Type Description
broadcaster Object

The object holding broadcaster data.

  id Int

The broadcaster id.

  username String

The broadcaster username.

  description String

The broadcaster description.

  firstname String

The broadcaster first name.

  lastname String

The broadcaster last name.

  url String

The URL to the public profile page for this broadcaster.

  is_favorite Boolean

The broadcaster is in the favourite list of the current user

  img String

The URLs for the broadcaster profile images.

    large String

The URL for the large broadcaster profile image (960x960).

    medium String

The URL for the medium broadcaster profile image (640x640).

    small String

The URL for the small broadcaster profile image (320x320).

    custom String

The URL for the custom broadcaster profile image.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "broadcaster": {
    "id": 6,
    "username": "someusername",
    "firstname": "Some",
    "lastname": "User",
    "created": 1392223832,
    "url": "http:\/\/www.domain.com\/user\/someusername",
    "is_favorite" : true,
    "img": {
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-[width]x[height]-000000.jpg",
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-960x960-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-640x640-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-320x320-000000.jpg"
    }
  }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channel Categories

Channel_Categories - Retrieve all channel categories

Retrieves a list of all available channel categories.

http://www.domain.com/api/:application_id/channel-categories

Permission: use_api  

curl -i http://www.domain.com/api/1001/channel-categories

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
order_by optional string

How to order the retrived channel categories. Available options: 'id', 'name', 'channels'.

Default value: name

direction optional string

How to sort channels. Available options: 'ASC' or 'DESC'.

Default value: ASC

200 OK Response

Field Type Description
categories Object[]

A list of available channel categories.

  id Int

The channel category id.

  name String

The channel category name.

  channels Int

The number of channels available in this category.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

HTTP/1.1 200 OK
{
  "status": 200,
  "categories": [{
    "id": 4,
    "name": "Autos & Vehicles",
    "channels": 31
  }, {
    "id": 7,
    "name": "Entertainment",
    "channels": 21
  }],
  "order": {
    "field": "channels",
    "direction": "DESC"
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channel_Categories - Retrieve channels from a specific channel category

Retrieves a list of all channels from a specific channel category.

http://www.domain.com/api/:application_id/channel-categories/:id/channels

Permission: use_api  

curl -i http://www.domain.com/api/1001/channel-categories/10/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel category id.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional string

How to order the retrived channels. Available options:

  • name - the name of the channel
  • created - the date when the channel was created
  • viewers - the number of users currently watching the channel
  • views - the total number of channel views
  • featured - featured status

Default value: name

direction optional string

How to sort channels. Available options: 'ASC' or 'DESC'.

Default value: ASC

live optional Int

Whether to restrict the list to live channels or not.

Default value: 0

featured optional Int

Whether to restrict the list to featured channels or not.

Default value: 0

mobile_streams_only optional Int

Whether to return only live channels with a source stream which is likely to play on a mobile device (the default) or all channels.

Default value: 1

200 OK Response

Field Type Description
channels Object[]

A list of available channels.

  id Int

The channel id.

  name String

The channel name.

  slug String

The channel slug.

  url String

The URL to the public channel page.

  img String

The URLs for the channel images.

    large String

The URL for the large channel image (960x540).

    medium String

The URL for the medium channel image (640x360).

    small String

The URL for the small channel image (320x180).

    custom String

The URL for the custom channel image.

  user Object

An object holding channel owner data

    id Int

The channel owner id.

    username String

The channel owner username.

    url String

The URL to the public profile page for the channel owner.

    img String

The URLs for the channel owner profile images.

      large String

The URL for the large channel owner profile image (960x960).

      medium String

The URL for the medium channel owner profile image (640x640).

      small String

The URL for the small channel owner profile image (320x320).

      custom String

The URL for the custom channel owner profile image.

  rating Int

The current channel rating.

  ratings Int

The total number of ratings.

  live Boolean

Whether the channel is currently live or not.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "channels": [{
      "id": 77,
      "name": "Restreamer Channel",
      "rating": 3.50,
      "ratings": 1007,
      "live": true,
      "user": {
        "id": 9,
        "username": "broadcaster99",
        "url": "http:\/\/www.domain.com\/user\/broadcaster99",
        "img": {
          "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9-[width]x[height]-000000.jpg",
        }
      },
      "url": "http:\/\/www.domain.com\/show\/restreamer-channel",
      "img": {
        "large": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-[width]x[height]-000000.jpg",
      }
    } , {
      "id": 65,
      "name": "Channel 4",
      "rating": 0,
      "ratings": 0,
      "live": false,
      "user": {
        "id": 8,
        "username": "username21",
        "url": "http:\/\/www.domain.com\/user\/username21",
        "img": {
          "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-[width]x[height]-000000.jpg"
        }
      },
      "url": "http:\/\/www.domain.com\/show\/channel-4",
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-[width]x[height]-000000.jpg"
      }
  }]
  "order": {
      "field": "id",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channel Events

Channel_Events - Retrieve all DVR requests for a particular channel event

Retrieves a list of all DVR requests for a particular channel event.

http://www.domain.com/api/:application_id/channel-events/:id/dvr

Permission: use_api   , admin_manage_videos  

curl -i http://www.domain.com/api/1001/dvr

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 999).

Default value: 30

order_by optional string

How to order the retrived channels. Available options:

  • start - the start time of the channel event being recorded
  • created - The time when the request was created
  • name - the name of the channel event
  • channel - the name of the channel

Default value: start

direction optional string

How to sort results. Available options: 'ASC' or 'DESC'.

Default value: DESC

status optional string

Whether to filter the list by status. Available options: all, pending, failed and finished.

Default value: all

200 OK Response

Field Type Description
results Object[]

A list of DVR requests.

  created Int

The time when this DVR request was created.

  start Int

The time when the channel event starts.

  end Int

The time when the channel events ends.

  status String

The status: pending, recording, failed or finished.

  duration optional Float

The duration of the recorded video, only for finished requests.

  event Object

Channel event details.

    id Int

Channel event ID.

    name String

Channel event name.

    img Object

On abject holding different types of channel event thumbnails.

  user Object

Details about the user who requested the DVR.

    id Int

User ID.

    name String

User username.

  channel Object

Channel event details.

    id Int

Channel event ID.

    name String

Channel event name.

    slug String

Channel event slug.

    url String

Channel public URL.

    img Object

On abject holding different types of channel thumbnails.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "results": [{
    "created": "1425905982",
    "start": "1425907800",
    "end": "1425915000",
    "status": "finished",
    "duration": "7189.17",
    "event": {
      "id": "11920",
      "name": "DVR Test",
      "img": {
        "custom": "http://www.domain.com/templates/white-theme/images/defaults/event-[width]x[height]-000000.jpg",
        "large": "http://www.domain.com/templates/white-theme/images/defaults/event-960x540-000000.jpg",
        "medium": "http://www.domain.com/templates/white-theme/images/defaults/event-640x360-000000.jpg",
        "small": "http://www.domain.com/templates/white-theme/images/defaults/event-320x180-000000.jpg"
      }
    },
    "user": {
      "id": "4",
      "username": "adrianv"
    },
    "channel": {
      "id": "411",
      "name": "SD Trailers 480p",
      "url": "http://www.domain.com/show/sd-trailers-480p",
      "img": {
        "custom": "http://www.domain.com/public/files/shows/0/4/411-[width]x[height]-000000.jpg",
        "large": "http://www.domain.com/public/files/shows/0/4/411-960x540-000000.jpg",
        "medium": "http://www.domain.com/public/files/shows/0/4/411-640x360-000000.jpg",
        "small": "http://www.domain.com/public/files/shows/0/4/411-320x180-000000.jpg"
      }
    }
  }, {
    "created": 1406319501,
    "start": 1406322000,
    "end": 1406329140,
    "status": failed,
    "event": {
      "id": "8451",
      "name": "5 PM Show",
      "img": {
        "custom": "http://www.domain.com/templates/white-theme/images/defaults/event-[width]x[height]-000000.jpg",
        "large": "http://www.domain.com/templates/white-theme/images/defaults/event-960x540-000000.jpg",
        "medium": "http://www.domain.com/templates/white-theme/images/defaults/event-640x360-000000.jpg",
        "small": "http://www.domain.com/templates/white-theme/images/defaults/event-320x180-000000.jpg",
      }
    },
    "user": {
      "id": "274",
      "username": "05dvr"
    },
    "channel": {
      "id": "236",
      "name": "FACH test",
      "url": "http://www.domain.com/show/fach-test",
      "img": {
        "custom": "http://www.domain.com/public/files/shows/0/180/236-[width]x[height]-000000.jpg",
        "large": "http://www.domain.com/public/files/shows/0/180/236-960x540-000000.jpg",
        "medium": "http://www.domain.com/public/files/shows/0/180/236-640x360-000000.jpg",
        "small": "http://www.domain.com/public/files/shows/0/180/236-320x180-000000.jpg",
      }
    }
  }],
  "order": {
      "field": "start",
      "direction": "DESC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channel_Events - Retrieve all available channel events

Retrieves a list of all available channel events for a specified interval, grouped by channel and ordered by event start time.

When you want to synchronise the list of programs for a specific time interval (using the from and to request parameters) it is expensive to retrieve the entire list of programs just to realise that the list has not changed.

To work around this problem, there is a built-in mechanism to check if the data for that specific time interval haven't changed:

  • each time you make a request and you get a 200 OK response, the response includes a signature tag for the returned data in the modified-tag key
  • save the tag and the requested time interval (denoted by the from and to parameters)
  • next time you want to check the data for the same time interval, send the if-modified-tag request parameter with the value saved in the previous step
  • if the data haven't changed, the response will be a 304 Not Modified HTTP response
  • if the data have changed, the response will be a 200 OK response and it will contain the entire new set of data for the requested interval.

If you want to check if the data have changed for a random time interval, for which you do not have previously saved a modified-tag, but for which you have the data, it is possible to calculate the tag: it's the md5 checksum of the following string:

maxLastModified-count-minId-maxId

where:

  • maxLastModified - the maximum value of the last modified field of an event
  • count - the total number of event for the selected interval
  • minId - the minimum event ID for the selected interval
  • maxId - the maximum event ID for the selected interval

http://www.domain.com/api/:application_id/channel-events

Permission: use_api  

curl -i http://www.domain.com/api/1001/channel-events?from=1403265173

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
from optional Int

The start of the interval from which to retrieve the events, as Unix timestamp.

Default value: start_of_current_hour

to optional Int

The end of the interval from which to retrieve the events, as Unix timestamp.

Default value: from_plus_24_hours

order_by optional string

How to order the retrieved channels. Available options:

  • stb_number - The EPG channel number.
  • start - The channel event start time.
  • duration - The channel event duration.
  • name - The channel event name.

Default value: stb_number

direction optional string

How to sort channels. Available options: 'ASC' or 'DESC'.

Default value: ASC

channel_type optional string

Whether to restrict the list to a channel type. Available options: live_channel, master_channel, tveverywhere_channel, sling_channel or all.

Default value: all

include_tveverywhere_channels optional string

Whether to include TV Everywhere channels when requesting all channel types.

Default value: 0

include_sling_channels optional string

Whether to include Sling channels when requesting all channel types.

Default value: 0

social_broadcasts optional Int

Whether to return only channels marked as social broadcasts or all channels (the default).

Default value: 0

if-modified-tag optional Int

A previously generated response tag to be used to determine if a 304 Not Modified response should be generated.

filter_by optional string

Additional filter. Available options: 'premium'. The 'premium' filter will limit the response to the content the current user has access to. By default, all content is returned.

200 OK Response

Field Type Description
channels Object[]

A list of channel with scheduled events for the requested interval.

  id Int

The parent channel id.

  name String

The parent channel name.

  slug String

The parent channel slug.

  is_premium Boolean

Whether the parent channel is premium or not.

  has_access Boolean

Whether the current user has access to the parent channel or not.

  stb_number optional Int

The assigned EPG channel number.

  url String

The URL to the public page for the parent channel.

  img String

The URLs for the parent channel images.

    large String

The URL for the large parent channel image (960x540).

    medium String

The URL for the medium parent channel image (640x360).

    small String

The URL for the small parent channel image (320x180).

    custom String

The URL for the custom parent channel image.

  dvr Bool

Whether DVR for current user is allowed or not.

  events Object[]

A list of channel events.

    id Int

The channel id.

    name String

The channel event name.

    description String

The channel event description.

    start Int

The channel event start time.

    duration Int

The channel event duration.

    modified Int

The date when the event was last updated, as Unix timestamp.

    ppv Bool

Whether the event is PPV or not.

    price Float

The event price, if the event is PPV.

    has_ticket optional Boolean

Whether the user has a ticket for the pay-per-view event.

    purchase_url optional String

The purchase URL, if the event is pay-per-view and the user does not have a ticket.

    img String

The URLs for the channel event images.

      large String

The URL for the large channel event image (960x540).

      medium String

The URL for the medium channel event image (640x360).

      small String

The URL for the small channel event image (320x180).

      custom String

The URL for the custom channel event image.

    dvr optional Object

Details about the DVR status for the program, if the user is logged in and scheduled a recording for this program.

      status optional String

The status of the DVR request: 'pending', 'recording', 'finished' or 'failed'.

modified-tag String

The modified tag, a generated signature tag for the data that can be used to trigger a check if the data is changed.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "channels": [{
    "id": 28,
    "name": "Wirecast demo",
    "url": "http:\/\/www.domain.com\/show\/wirecast-demo",
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-[width]x[height]-000000.jpg"
    },
    "events": [{
      "id": 9,
      "name": "PPV demo event",
      "description": "lorem ipsum",
      "start": 1403265173,
      "duration": 5700,
      "ppv": true,
      "price": 10,
      "has_ticket": true,
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
      }
    }, {
      "id": 10,
      "name": "PPV demo event 2",
      "description": "lorem ipsum second desc",
      "start": 1403270874,
      "duration": 3000,
      "ppv": true,
      "price": 15,
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
      }
    }]
  }, {
    "id": 30,
    "name": "VidBlaster channel",
    "url": "http:\/\/www.domain.com\/show\/vidblaster-channel",
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-[width]x[height]-000000.jpg"
    },
    "events": [{
      "id": 9,
      "name": "Lorem Ipsum 1",
      "description": "lorem ipsum",
      "start": 1403265173,
      "duration": 5700,
      "ppv": false,
      "has_ticket": true,
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
      }
    }, {
      "id": 10,
      "name": "Lorem Ipsum 2",
      "description": "lorem ipsum second desc",
      "start": 1403270874,
      "duration": 3000,
      "ppv": false,
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
      }
    }]
  }]
}

304 Not Modified Response

Name Type Description
status 304

The Not Modified HTTP response code.

reason String

The reason for receiving this response code.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 304 Not Modified
{
  "status": 304,
  "reason": "Not Modified"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channel_Events - Retrieve data of a channel event

Retrieves information about a particular channel event.

http://www.domain.com/api/:application_id/channel-events/:id

Permission: use_api  

curl -i http://www.domain.com/api/1001/channel-events/3651

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel event id.

200 OK Response

Field Type Description
event Object

The object holding channel event data.

  id Int

The channel event id.

  channel_id Int

The parent channel id.

  name String

The channel event name.

  description String

The channel event description.

  start Int

The channel event start time.

  duration Int

The channel event duration.

  ppv Bool

Whether the event is PPV or not.

  price Float

The event price, if the event is PPV.

  has_ticket optional Boolean

Whether the user has a ticket for the pay-per-view event.

  purchase_url optional String

The purchase URL, if the event is pay-per-view and the user does not have a ticket.

  img String

The URLs for the channel event images.

    large String

The URL for the large channel event image (960x540).

    medium String

The URL for the medium channel event image (640x360).

    small String

The URL for the small channel event image (320x180).

    custom String

The URL for the custom channel event image.

  dvr optional Object

Details about the DVR status for this program, if the user is logged in and scheduled a recording.

    status optional String

The status of the DVR request: 'pending', 'recording', 'finished' or 'failed'.

  channel_dvr Boolean

Whether DVR for parent channel is allowed or not.

status 200

The HTTP response code.

 HTTP/1.1 200 OK
 {
   "status": 200,
   "event": {
     "id": 1389,
     "channel_id": 130,
     "name": "ppv event again",
     "description": "lorem ipsum foo qux",
     "start": 1403281200,
     "duration": 2400,
     "ppv": true,
     "price": 15,
     "has_ticket": true,
     "img": {
       "large": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-960x540-000000.jpg",
       "medium": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-640x360-000000.jpg",
       "small": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-32x180-000000.jpg",
       "custom": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-[width]x[height]-000000.jpg"
     }
   }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels

Channels - Add a new channel comment

Adds a new channel comment to the system.

http://www.domain.com/api/:application_id/channels/:id/comments

Permission: use_api   , comment_on_public_channel_pages  

curl -i -d body="lorem ipsum" http://www.domain.com/api/1001/channels/155/comments

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Request body parameters

Field Type Description
body String

The channel comment body.

200 OK Response

Field Type Description
id Int

The generated channel comment id of the new comment.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 100546
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  body optional String[]

Error messages related to the body field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some user details are not correct",
  "errors": {
    "body": [
        "The comment body cannot be empty."
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Add a new channel rating

Adds a new channel rating into the system.

http://www.domain.com/api/:application_id/channels/:id/rating

Permission: use_api  

curl -i -d rating=3.5 http://www.domain.com/api/1001/channels/155/rating

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Request body parameters

Field Type Description
rating Int

The channel rating.

200 OK Response

Field Type Description
rating Float

The current rating.

ratings Int

The number of ratings.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "rating": 3.5,
  "ratings": 1503
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some user details are not correct",
  "errors": {
    "body": [
        "The comment body cannot be empty."
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Add a new embed whitelisted domain for a live channel

Adds a new embed whitelisted domain for a live channel

http://www.domain.com/api/:application_id/channels/:id/embedwhitelisteddomains

Permission: use_api   , manage_video_channels  

curl -i -d domain="domain.com" http://www.domain.com/api/1001/channels/155/embedwhitelisteddomains

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Request body parameters

Field Type Description
domain String

The channel embed whitelisted domain.

200 OK Response

Field Type Description
id Int

The generated channel embed whitelisted domain id of the new entry.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 100546
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  body optional String[]

Error messages related to the body field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some user details are not correct",
  "errors": {
    "domain": [
        "The domain has to be a string."
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Add a new live channel

Add a new channel in the system

http://www.domain.com/api/:application_id/channels

Permission: use_api   , manage_video_channels   , admin_manage_channels   , html5_live_stream_fallback  

curl -i -d name="Channel name" -d description="Channel description" -d category_id=33  -d web_available=1 -d password="my password" http://www.domain.com/api/1001/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

Request body parameters

Field Type Description
name String

A unique channel name.

category_id Int

The channel category ID.

description optional String

Description of the channel.

web_available optional Int

Channel will be available on web. Available options: 1 or 0.

Default value: 0

stb_available optional Int

Channel will be available on STB device. Available options: 1 or 0.

Default value: 0

roku_available optional Int

Channel will be available on Roku device. Available options: 1 or0.

Default value: 0

html5_available optional Int

Channel will have HTML5 live stream fallback enable. Available options: 1 or0.Option available only with the permission:html5_live_stream_fallback enable.

Default value: 1

password optional String

The channel password if it's restricted.

200 OK Response

Field Type Description
id Int

The generated id of the new channel.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 123
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the channel name field.

  description optional String[]

Error messages related to the description field.

  category_id optional String[]

Error messages related to the category id field.

  password optional String[]

Error messages related to the password field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some channel details are not correct",
  "errors": {
    "name": [
        "The channel name already exist"
    ],
    "category_id": [
        "This category doesn't exist!"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Delete an existing embed whitelisted domain for a live channel

Delete an existing embed whitelisted domain for a live channel

http://www.domain.com/api/:application_id/channels/:id/embedwhitelisteddomains/:sub_id

Permission: use_api   , manage_video_channels  

curl -i -X DELETE http://www.domain.com/api/1001/channels/2/embedwhitelisteddomains/1

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
id Int

The channel id.

sub_id Int

The channel assigned domain embed whitelisted sub_id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  sub_id optional String[]

Error messages related to the sub_id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad Request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Delete an existing live channel

Delete an existing channel

http://www.domain.com/api/:application_id/channels/:id

Permission: use_api   , delete_own_channel   , admin_manage_channels  

curl -i -X DELETE http://www.domain.com/api/1001/channels/233

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
id Int

The channel id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad Request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Monitor current channel status

To obtain details about the status of a current channel, you can connect to a Socket.IO application and you will receive notifications each time the status of the channel changes.

You can obtain the connect URL for the Socket.IO server from the Settings API call. The same API call also gives you the URL for the Javascript client library that you can use to connect to the server.

When connecting to the socket.IO URL you obtained from the Settings API call you have to provide a series of request parameters which are described below.

The authentication token is calculated as a HMAC SHA256 hex digest, generated by signing the following string with the application API Key:

[channel ID]:[user auth key], where:

  • user auth key - the user authentication key, obtained by calling /authenticate.

http://www.domain.com/api/:application_id/socket.io-connect-URL-obtained-calling-Settings-API

Query string parameters

Field Type Description
c Int

The channel ID.

a Int

The API application ID.

u Int

The user ID.

h String

The authentication key.

Socket.IO events

Field Type Description
connect Event

Received when the client successfully connected to the server.

disconnect Event

Received when the client disconnected from the server.

error Event

Received when there is an error with the communication channel.

ready Event

Received when the server successfully authenticated the user connecting to the server.

allow Event

Received when the server successfully authorized the user and the user is granted access to the channel.

status Event

Received when the channel status changes.

deny Event

Received when the user is denied access to the channel, because the channel status does not allow connections.

ppv-event Event

Received when a new PPV event started and the user is not allowed to access it.

Payload for the 'ready' event

Field Type Description
id String

The Socket.IO socket ID.

user Object

Details of the connected user, as seen by the server after authentication.

  id Int

The user ID.

  name String

The user username.

  type String

The user type: channel owner, authenticated user or guest.

  image String

The user thumb URL.

Payload for the 'status' event

Field Type Description
status String

The channel status: onair or offair.

Payload for the 'deny' event

Field Type Description
reason String

The reason for denying access to the channel.

Possible reasons for the 'deny' event

Field Type Description
invalid-id String

The requested channeld ID is invalid.

not-found String

The requested channel could not be found.

disabled String

The requested channel was disabled by an administrator.

banned String

The IP address of the user trying to connect has been banned.

bandwidth-limit String

The bandwidth limit for the channel has been reached.

viewers-limit String

The maximum number of simultaneous viewers has been reached.

Payload for the 'ppv event' event

Field Type Description
id Int

The ID of the channel event.

name String

The name of the channel event.

desc String

The description of the channel event.

price Float

The price of the pay-per-view channel event.

url String

The purchase URL.

thumb String

The channel event thumb URL.


 
   
   
   
   Channel Status Demo
   
 
loading, please wait ...

Channels - Report inappropriate content

Report inappropriate content

http://www.domain.com/api/:application_id/channels/:id/report

Permission: use_api  

curl -i -d reason_id=3 http://www.domain.com/api/1001/channels/155/report

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Request body parameters

Field Type Description
reason_id Int

The reason ID, retrieved from Settings API call.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  reason_id optional String[]

Error messages related to the reason field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some user details are not correct",
  "errors": {
    "reason_id": [
        "Invalid reason ID."
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve Google Play subscription upgrade options for a channel.

Retrieves a list of Google Play subscription upgrade options for a channel. Users can gain access to this channels by purchasing any of the upgrade options.

http://www.domain.com/api/:application_id/channels/:id/upgrade-options-google-play

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/1436/upgrade-options-google-play

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channels id.

200 OK Response

Field Type Description
options Object[]

List with the upgrade options.

  id Int

The id of the Google Play subscription plan.

  name String

The name of the Google Play subscription plan.

  sku String

The Google Play product ID of the Google Play subscription plan.

  audio_channels Int

The number of audio channels included with the iOS subscription plan.

  live_channels Int

The number of live channels included with the iOS subscription plan.

  catchup_channels Int

The number of free catchup channels included with the iOS subscription plan.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "options": [{
      "id": 1,
      "name": "Basic Package",
      "sku": "channel_group_monthly_1",
      "audio_channels": 1,
      "live_channels": 1,
      "catchup_channels": 1
    }],
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve all available channels

Retrieves a list of all available channels.

http://www.domain.com/api/:application_id/channels

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 1000).

Default value: 30

order_by[] optional Array

How to order the retrieved channels. Available options:

  • name - the name of the channel
  • category_name - the name of the channel's category
  • created - the date when the channel was created
  • viewers - the number of users currently watching the channel
  • views - the total number of channel views
  • featured - featured status
  • stb_number - the EPG channel number

Default value: name

direction optional string

How to sort channels. Available options: 'ASC' or 'DESC'.

Default value: ASC

live optional Int

Whether to restrict the list to live channels or not.

Default value: 0

featured optional Int

Whether to restrict the list to featured channels or not.

Default value: 0

catchup_tv optional Int

Whether to get channels that are CatchUp or not. Available options: '0' or '1'. Default: all channels are returned.

channel_type optional string

Whether to restrict the list to a channel type. Available options: live_channel, external_channel, master_channel, tveverywhere_channel, sling_channel, all.

Default value: all

include_tveverywhere_channels optional string

Whether to include TV Everywhere channels when requesting all channel types.

Default value: 0

include_sling_channels optional string

Whether to include Sling channels when requesting all channel types.

Default value: 0

mobile_streams_only optional Int

Whether to return only live channels with a source stream which is likely to play on a mobile device (the default) or all channels.

Default value: 1

stb_available optional Int

Whether to return only channels marked as available on STB devices or all channels (the default).

Default value: 0

roku_available optional Int

Whether to return only channels marked as available on Roku devices or all channels (the default). *

Default value: 0

social_broadcasts optional Int

Whether to return only channels marked as social broadcasts or all channels (the default).

Default value: 0

filter_by optional string

Additional filter. Available options: 'premium'. The 'premium' filter will limit the response to the content the current user has access to. By default, all content is returned.

embed_width optional Int

The iframe embed width.

Default value: 100%

embed_height optional Int

The iframe embed height.

Default value: 100%

show_chat optional Int

If embed code should have the chat displayed or not.

Default value: 1

auto_play optional Int

If embed code should have the autoplay option set.

Default value: 1

ids optional string

Comma delimited ids of channels you want to get.

Default value: 0

200 OK Response

Field Type Description
channels Object[]

A list of available channels.

  id Int

The channel id.

  name String

The channel name.

  slug String

The channel slug.

  rating Int

The current channel rating.

  ratings Int

The total number of ratings.

  live Boolean

Whether the channel is currently live or not.

  featured Boolean

Whether the channel is a featured channel or not.

  channel_type String

The channel type (live, external, tveverywhere or sling).

  viewers Int

The number of viewers currently watching the channel.

  views Int

The total number of channel views.

  web_available Boolean

Whether the channel is available on web.

  stb_available Boolean

Whether the channel is available on STB devices or not.

  roku_available Boolean

Whether the channel is available on Roku devices or not.

  html5_available Boolean

Whether the channel is available on for html5.

  social_broadcast Boolean

Whether the channel is marked as a social broadcast.

  allow_embed Boolean

Whether the channel allows embed or not.

  is_hd Boolean

Whether the channel is HD or not.

  is_adult Boolean

Whether the channel is adult or not.

  is_ott Boolean

Whether the channel is ott or not.

  is_catchup_tv Boolean

Whether the channel is CatchUp TV or not.

  is_kodi Boolean

Whether the channel is Kodi or not.

  is_premium Boolean

Whether the channel is premium or not.

  has_access Boolean

Whether the current user has access to the channel or not.

  stb_number optional Int

The assigned EPG channel number.

  url String

The URL to the public channel page.

  img String

The URLs for the channel images.

    large String

The URL for the large channel image (960x540).

    medium String

The URL for the medium channel image (640x360).

    small String

The URL for the small channel image (320x180).

    custom String

The URL for the custom channel image.

  user Object

An object holding channel owner data

    id Int

The channel owner id.

    username String

The channel owner username.

    url String

The URL to the public profile page for the channel owner.

    img String

The URLs for the channel owner profile images.

      large String

The URL for the large channel owner profile image (960x960).

      medium String

The URL for the medium channel owner profile image (640x640).

      small String

The URL for the small channel owner profile image (320x320).

      custom String

The URL for the custom channel owner profile image.

  category Object

An object holding category data.

    id Int

The channel category id.

    name String

The channel category name.

  embedCode String

The embed code of the channel.

  dvr Boolean

Whether DVR is allowed for current user for this channel or not.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "channels": [{
      "id": 77,
      "name": "Channel 2",
      "rating": 3.50,
      "ratings": 1007,
      "live": true,
      "featured": true,
      "channel_type": "live_channel",
      "viewers": 105,
      "views": 10075,
      "user": {
        "id": 9,
        "username": "broadcaster99",
        "url": "http:\/\/www.domain.com\/user\/broadcaster99",
        "img": {
          "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_[width]x[height]-000000.jpg"
        }
      },
      "category": {
        "id": 3,
        "name": "Movies"
      },
      "url": "http:\/\/www.domain.com\/show\/restreamer-channel",
      "embedCode": "http:\/\/www.domain.com\/show\/restreamer-channel",
      "web_available": true,
      "stb_available": true,
      "roku_available": true,
      "html5_available": true,
      "social_broadcast": true,
      "allow_embed": "yes",
      "is_hd": false,
      "is_adult": true,
      "is_catchup_tv": false,
      "is_kodi": false,
      "is_ott": false,
      "stb_number": 105,
      "img": {
        "large": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/public\/files\/shows\/0\/9\/77-[width]x[height]-000000.jpg"
      }
    } , {
      "id": 65,
      "name": "Channel 4",
      "rating": 0,
      "ratings": 0,
      "live": false,
      "featured": false,     *
      "channel_type": "live_channel",
      "viewers": 12,
      "views": 1076,
      "user": {
        "id": 8,
        "username": "username21",
        "url": "http:\/\/www.domain.com\/user\/username21",
        "img": {
          "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user_960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user_640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user_320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user_[width]x[height]-000000.jpg"
        }
      },
      "category": {
        "id": 14,
        "name": "Music"
      },
      "url": "http:\/\/www.domain.com\/show\/channel-4",
      "web_available": true,
      "stb_available": true,
      "roku_available": true,
      "html5_available": true,
      "social_broadcast": false,
      "allow_embed": "yes",
      "is_hd": false,
      "is_adult": true,
      "is_catchup_tv": false,
      "is_kobi": false,
      "is_ott": false,
      "stb_number": 105,
      "img": {
        "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-960x540-000000.jpg",
        "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-640x360-000000.jpg",
        "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-320x180-000000.jpg",
        "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-[width]x[height]-000000.jpg"
      },
      "embedCode" : ""
  }],
  "order": {
      "field": "name",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve channel comments

Retrieves a list of all channel comments.

http://www.domain.com/api/:application_id/channels/:id/comments

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/100546/comments

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional string

How to order the retrived comments. Available options: 'created'.

Default value: created

direction optional string

How to sort comments. Available options: 'ASC' or 'DESC'.

Default value: DESC

200 OK Response

Field Type Description
comments Object[]

A list of channel comments.

  id Int

The channel comment id.

  body String

The channel comment body.

  created Int

The channel comment creation time, as Unix timestamp.

  user Object

An object holding channel owner data

    id Int

The comment owner id.

    username String

The comment owner username.

    url String

The URL to the public profile page for the comment owner.

    img String

The URLs for the comment owner profile images.

      large String

The URL for the large comment owner profile image (960x960).

      medium String

The URL for the medium comment owner profile image (640x640).

      small String

The URL for the small comment owner profile image (320x320).

      custom String

The URL for the custom comment owner profile image.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "comments": [{
    "id": 7,
    "body": "Ut eget adipiscing massa. Nam quis metus cursus, pretium mauris nec, feugiat neque.
             Maecenas at tortor mauris. Proin vitae sapien rhoncus, pharetra ipsum ac, dapibus dolor.
             Vivamus sem tellus, iaculis in risus a, condimentum mattis neque.
             Aliquam molestie sapien vel convallis placerat.",
    "created": 1403097225,
    "user": {
        "id": 4,
        "username": "adrianv",
        "url": "http:\/\/www.domain.com\/user\/adrianv",
        "img": {
          "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/4\/4-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/4\/4-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/4\/4-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/4\/4-[width]x[height]-000000.jpg"
        }
    }
  }, {
    "id": 6,
    "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.
             Donec luctus tellus tortor, non iaculis nisl iaculis a.
             Vivamus auctor cursus urna, nec elementum lectus iaculis sed. Nulla facilisi.
             Fusce viverra dolor lobortis tortor laoreet, quis mollis metus imperdiet.",
    "created": 1403097207,
    "user": {
        "id": 6,
        "username": "adrianv",
        "url": "http:\/\/www.domain.com\/user\/anotheruser",
        "img": {
          "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/6\/6-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/6\/6-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/6\/6-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/6\/6-[width]x[height]-000000.jpg"
        }
    }
  }],
  "order": {
      "field": "id",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve channel embed whitelisted domains

Retrieve embed whitelisted domains for a channel.

http://www.domain.com/api/:application_id/channels/:id/embedwhitelisteddomains

Permission: use_api   , manage_video_channels  

curl -i http://www.domain.com/api/1001/channels/100546/embedwhitelisteddomains

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

200 OK Response

Field Type Description
domains Object[]

A list of channel embed whitelisted domains.

  id Int

The embed whitelist domain id.

  domain String

The embed whitelist domain.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "domains": [{
    "id": 6,
    "domain": "domain.com",
  }, {
    "id": 7,
    "domain": "domain.co.uk",
  }]
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve channel events for a specific channel

Retrieve channel events for a specific channel and a specified interval.

http://www.domain.com/api/:application_id/channels/:id/events

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/10001/events?from=1403265173

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Query string parameters

Field Type Description
from optional Int

The start of the interval from which to retrieve the events, as Unix timestamp.

Default value: start_of_current_hour

to optional Int

The end of the interval from which to retrieve the events, as Unix timestamp.

Default value: from_plus_24_hours

offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional String

How to order the retrived channel events. Available options: 'start', 'duration', 'name'.

Default value: start

direction optional String

How to sort channels. Available options: 'ASC' or 'DESC'.

Default value: ASC

200 OK Response

Field Type Description
events Object[]

A list of channel events.

  id Int

The channel id.

  name String

The channel event name.

  description String

The channel event description.

  start Int

The channel event start time.

  duration Int

The channel event duration.

  ppv Bool

Whether the event is PPV or not.

  price Float

The event price, if the event is pay-per-view.

  has_ticket optional Boolean

Whether the user has a ticket for the pay-per-view event.

  purchase_url optional String

The purchase URL, if the event is pay-per-view and the user does not have a ticket.

  img String

The URLs for the channel event images.

    large String

The URL for the large channel event image (960x540).

    medium String

The URL for the medium channel event image (640x360).

    small String

The URL for the small channel event image (320x180).

    custom String

The URL for the custom channel event image.

  dvr optional Object

Details about the DVR status for the program, if the user is logged in and scheduled a recording.

    status optional String

The status of the DVR request: 'pending', 'recording', 'finished' or 'failed'.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "events": [{
    "id": 9,
    "name": "PPV demo event",
    "description": "lorem ipsum",
    "start": 1403265173,
    "duration": 5700,
    "ppv": true,
    "price": 10,
    "has_ticket": true,
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
    }
  }, {
    "id": 10,
    "name": "PPV demo event 2",
    "description": "lorem ipsum second desc",
    "start": 14032692314,
    "duration": 3000,
    "ppv": true,
    "price": 15,
    "has_ticket": true,
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/event-[width]x[height]-000000.jpg"
    }
  }]
  "order": {
      "field": "id",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve channel videos

Retrieves a list of all channel videos. (See also 'Videos: Retrieve all available videos' attached to a channel filter, for an advanced list)

http://www.domain.com/api/:application_id/channels/:id/videos

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/100546/videos

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional string

How to order the retrived videos. Available options:

  • name - the name of the video
  • created - the date when the video was created

Default value: created

direction optional string

How to sort videos. Available options: 'ASC' or 'DESC'.

Default value: DESC

filter_by optional string

Additional filter. Available options: 'premium'. The 'premium' filter will limit the response to the content the current user has access to. By default, all content is returned.

200 OK Response

Field Type Description
videos Object[]

A list of available videos.

  id Int

The video id.

  name String

The video name.

  url String

The URL to the public video page.

  img String

The URLs for the video images.

    large String

The URL for the video image (960x540).

    medium String

The URL for the video image (640x360).

    small String

The URL for the video image (320x180).

    custom String

The URL for the video image.

  featured Boolean

Whether the video is a featured video or not.

  views Int

The total number of video views.

  user Object

An object holding video owner data

    id Int

The video owner id.

    username String

The video owner username.

    url String

The URL to the public profile page for the video owner.

    img String

The URLs for the video owner profile images.

      large String

The URL for the large video owner profile image (960x960).

      medium String

The URL for the medium video owner profile image (640x640).

      small String

The URL for the small video owner profile image (320x320).

      custom String

The URL for the custom video owner profile image.

  category Object

An object holding category data.

    id Int

The video category id.

    name String

The video category name.

  embedCode String

The embed code of the video.

  rating Int

The current video rating.

  ratings Int

The total number of ratings.

  is_premium Boolean

Whether the video is premium or not.

  has_access Boolean

Whether the current user has access to the video or not.

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "videos": [{
    "id": 84,
    "name": "Ice Age Dawn of the Dinosaurs (2009).mkv",
    "rating": 3.5,
    "ratings": 105,
    "url": "http:\/\/www.domain.com\/video\/84",
    "img": {
      "large": "http:\/\/www.domain.com\/public\/files\/videos\/0\/84\/84-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/public\/files\/videos\/0\/84\/84-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/public\/files\/videos\/0\/84\/84-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/public\/files\/videos\/0\/84\/84-[width]x[height]-000000.jpg"
    }
    "featured": false,
    "views": 155,
    "user": {
        "id": 7,
        "username": "ciprian",
        "url": "http:\/\/www.domain.com\/user\/ciprian",
        "img": {
          "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-[width]x[height]-000000.jpg"
        }
    },
    "category": {
        "id": 4,
        "name": "Trailers"
    }
  }, {
    "id": 85,
    "name": "Inglourious.basterds.Trailer.1080p.mkv",
    "rating": 4.5,
    "ratings": 99,
    "featured": true,
    "views": 15,
    "url": "http:\/\/www.domain.com\/video\/85",
    "img": {
      "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/video-960x540-000000.jpg",
      "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/video-640x360-000000.jpg",
      "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/video-320x180-000000.jpg",
      "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/video-[width]x[height]-000000.jpg"
    }
    "user": {
        "id": 7,
        "username": "ciprian",
        "url": "http:\/\/www.domain.com\/user\/ciprian",
        "img": {
          "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-960x960-000000.jpg",
          "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-640x640-000000.jpg",
          "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-320x320-000000.jpg",
          "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/user-[width]x[height]-000000.jpg"
        }
    },
    "category": {
        "id": 3,
        "name": "Movies"
    },
    "embedCode" : ""
  }],
  "order": {
      "field": "name",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve data of an channel

Retrieves information about a particular channel.

http://www.domain.com/api/:application_id/channels/:id

Permission: use_api   , view_public_channel_pages

curl -i http://www.domain.com/api/1001/channels/100546

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Query string parameters

Field Type Description
embed_width optional Int

The iframe embed width.

Default value: 100%

embed_height optional Int

The iframe embed height.

Default value: 100%

show_chat optional Int

If embed code should have the chat displayed or not.

Default value: 1

auto_play optional Int

If embed code should have the autoplay option set.

Default value: 1

200 OK Response

Field Type Description
channel Object

The object holding channel data.

  id Int

The channel id.

  name String

The channel name.

  slug String

The channel slug.

  description String

The channel description.

  rating Int

The current channel rating.

  ratings Int

The total number of ratings.

  live Boolean

Whether the channel is currently live or not.

  views Int

The total number of views.

  viewers Int

The number of online viewers.

  channel_type Int

The channel type (live_channel or external channel or master_channel).

  web_available Boolean

Whether the channel is available on web.

  stb_available Boolean

Whether the channel is available on STB devices or not.

  roku_available Boolean

Whether the channel is available on Roku devices or not.

  html5_available Boolean

Whether the channel is available for html5.

  stb_number Boolean

The assigned EPG channel number.

  stretching Boolean

How to resize video to fit the display. Available options: 'uniform', 'exactfit', 'fill' and 'none'.

  url String

The URL to the public channel page.

  img String

The URLs for the channel images.

    large String

The URL for the large channel image (960x540).

    medium String

The URL for the medium channel image (640x360).

    small String

The URL for the small channel image (320x180).

    custom String

The URL for the custom channel image.

  created Int

The channel creation date, as Unix timestamp.

  premium Boolean

Whether this is a premium channel, requiring a paid subscription.

  has_subscription Boolean

Whether the user has a valid subscription to the premium channel.

  purchase_url String

The purchase ULR, if the channel is premium and the user does not have a valid subscription.

  is_favorite Boolean

The channel is in the favourite list of the current user

  user Object

An object holding channel owner data

    id Int

The channel owner id.

    username String

The channel owner username.

    url String

The URL to the public profile page for the channel owner.

    img String

The URLs for the channel owner profile images.

      large String

The URL for the large channel owner profile image (960x960).

      medium String

The URL for the medium channel owner profile image (640x640).

      small String

The URL for the small channel owner profile image (320x320).

      custom String

The URL for the custom channel owner profile image.

  category Object

An object holding category data.

    id Int

The channel category id.

    name String

The channel category name.

  sources optional Object

A collection of channel source URLs (only present if the user is allowed to watch the channel - see the premium section).

    rtmp String

The RTMP source stream.

    hls optional String

The HLS source stream, if such source exists.

    rtsp optional String

The RTSP source stream, if such source exists.

  external_sources optional Object

A collection of channel external source URLs (only present if the channel is an external channel).

    verimatrix String

The Verimatrix source stream, if such source exists.

  dvr Boolean

Whether DVR is allowed for current user or not.

  is_premium Boolean

Whether the channel is premium or not.

  has_access Boolean

Whether the current user has access to the channel or not.

  embedCode String

The embed code of the channel.

status 200

The HTTP response code.

 HTTP/1.1 200 OK
 {
   "status": 200,
   "channel": {
     "id": 65,
     "name": "Channel 4",
     "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.
                     Phasellus vel nibh purus. Quisque vulputate pulvinar leo, nec sollicitudin mi egestas ut.
                     Duis viverra enim elit, a sodales turpis pharetra ut. Proin porttitor semper metus eget eleifend.
                     Donec odio massa, tempor sed tincidunt in, facilisis ut purus.",
     "created": 1392976774,
     "rating": 3.50,
     "ratings": 1007,
     "live": true,
     "views": 10,
     "viewers": 2,
     "channel_type": "live_channel",
     "web_available": false,
     "stb_available": true,
     "roku_available": false,
     "html5_available": false,
     "stb_number": 101,
     "stretching": "uniform",
     "url": "http:\/\/www.domain.com\/show\/channel-4",
     "img": {
       "large": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-960x540-000000.jpg",
       "medium": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-640x360-000000.jpg",
       "small": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-320x180-000000.jpg",
       "custom": "http:\/\/www.domain.com\/templates\/white-theme\/images\/defaults\/show-[width]x[height]-000000.jpg"
     },
     "premium": false,
     "category": {
       "id": 3,
       "name": "Movies"
     },
     "is_favorite": true,
     "user": {
       "id": 9,
       "username": "ciprian21",
       "url": "http:\/\/www.domain.com\/user\/ciprian21",
       "img": {
         "large": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_960x960-000000.jpg",
         "medium": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_640x640-000000.jpg",
         "small": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_320x320-000000.jpg",
         "custom": "http:\/\/www.domain.com\/public\/files\/users\/0\/9\/9_[width]x[height]-000000.jpg"
       }
     },
     "sources": {
         "hls": "http:\/\/wms.domain.com:1935\/unrestricted_wmsprfx\/65\/VkZb3RB3n1LM\/playlist.m3u8",
         "rtmp": "rtmp:\/\/wms-edge1.domain.com:1935\/unrestricted_wmsprfx\/65\/VkZb3RB3n1LM",
         "rtsp": "rtsp:\/\/wms-rtsp.domain.com:1935\/unrestricted_wmsprfx\/65\/VkZb3RB3n1LM"
     },
     "embedCode" : ""
   }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve iOS subscription upgrade options for a channel.

Retrieves a list of iOS subscription upgrade options for a channel. Users can gain access to this channels by purchasing any of the upgrade options.

http://www.domain.com/api/:application_id/channels/:id/upgrade-options-ios

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/1436/upgrade-options-ios

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channels id.

200 OK Response

Field Type Description
options Object[]

List with the upgrade options.

  id Int

The id of the iOS subscription plan.

  name String

The name of the iOS subscription plan.

  product_id String

The iTunes product Id of the iOS subscription plan.

  channel_group_id Int

The channel group id corresponding to the iOS subscription plan.

  audio_channels Int

The number of audio channels included with the iOS subscription plan.

  live_channels Int

The number of live channels included with the iOS subscription plan.

  catchup_channels Int

The number of free catchup channels included with the iOS subscription plan.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "options": [{
      "id": 1,
      "name": "Basic Package",
      "product_id": "com.tikilive.tiki6.plans.basic.1month",
      "channel_group_id": 1,
      "audio_channels": 1,
      "live_channels": 1,
      "catchup_channels": 1
    }],
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve subscription upgrade options for a channel (non iOS).

Retrieves a list of subscription upgrade options for a channel (non iOS). Users can gain access to this channel by purchasing any of the upgrade options.

http://www.domain.com/api/:application_id/channels/:id/upgrade-options

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/1436/upgrade-options

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

200 OK Response

Field Type Description
options Object[]

List with the upgrade options.

  id Int

The id of the channel group.

  name String

The name of the channel group.

  price String

The price of the channel group.

  audio_channels Int

The number of audio channels included with the channel group.

  live_channels Int

The number of live channels included with the channel group.

  catchup_channels Int

The number of free catchup channels included with the channel group.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "options": [{
      "id": 8,
      "price": "1.99",
      "audio_channels": 1,
      "live_channels": 1,
      "catchup_channels": 1
    }],
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Retrieve the current event for a specific channel

Retrieve current channel event for a specific channel.

http://www.domain.com/api/:application_id/channels/:id/current-event

Permission: use_api  

curl -i http://www.domain.com/api/1001/channels/10001/current-event

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

200 OK Response

Field Type Description
event Object

The object holding channel event data.

  id Int

The channel event id.

  name String

The channel event name.

  description String

The channel event description.

  img String

The URLs for the channel event images.

    large String

The URL for the large channel event image (960x540).

    medium String

The URL for the medium channel event image (640x360).

    small String

The URL for the small channel event image (320x180).

    custom String

The URL for the custom channel event image.

  start Int

The channel event start time.

  duration Int

The channel event duration.

  ppv Bool

Whether the event is PPV or not.

  price Float

The event price, if the event is PPV.

  has_ticket optional Boolean

Whether the user has a ticket for the pay-per-view event.

  purchase_url optional String

The purchase URL, if the event is pay-per-view and the user does not have a ticket.

status 200

The HTTP response code.

 HTTP/1.1 200 OK
 {
   "status": 200,
   "event": {
     "id": 1389,
     "name": "ppv event again",
     "description": "lorem ipsum foo qux",
     "start": 1403281200,
     "duration": 2400,
     "ppv": true,
     "price": 15,
     "has_ticket": true,
     "img": {
       "large": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-960x540-000000.jpg"
       "medium": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-640x360-000000.jpg"
       "small": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-320x180-000000.jpg"
       "custom": "http:\/\/www.domain.com\/public\/files\/events\/0\/130\/8541d7fe27ce99b23874b630f45ff8d6-[width]x[height]-000000.jpg"
     }
   }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Channels - Update an existing live channel

Update an existing channel

http://www.domain.com/api/:application_id/channels/:id

Permission: use_api   , manage_video_channels   , admin_manage_channels   , html5_live_stream_fallback  

curl -i -X PUT -d name="Channel updated" -d description="Channel description" -d category_id=33 -d web_available=1 -d password="my password" http://www.domain.com/api/1001/channels/232

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Request body parameters

Field Type Description
name optional String

A unique channel name.

category_id optional Int

The video category ID.

description optional String

Description of the channel.

web_available optional Int

Channel will be available on web. Available options:1 or 0.

Default value: 0

stb_available optional Int

Channel will be available on STB device. Available options:1 or 0.

Default value: 0

roku_available optional Int

Channel will be available on Roku device. Available options: 1 or 0.

Default value: 0

html5_available optional Int

Channel will have HTML5 live stream fallback enable. Available options: 1 or0. Option available only with the permission:html5_live_stream_fallback enable.

Default value: 1

password optional String

The channel password.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the channel name field.

  description optional String[]

Error messages related to the description field.

  category_id optional String[]

Error messages related to the category id field.

  password optional String[]

Error messages related to the password field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some channel details are not correct",
  "errors": {
    "name": [
        "The channel name already exist!"
    ],
    "category_id": [
        "This category ID doesn't exist!"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current User

Current_User - Add a new channel event

Add a new channel event

http://www.domain.com/api/:application_id/me/events

Permission: use_api  

curl -i -d name="Program name" -d description="Program description" -d channel_id=31 -d playlist_id=83 -d start=1431336256 -d ppv=1 -d price=10 -d repeat_enabled=1 -d repeat_pattern="daily" -d repeat_period=2 -d repeat_end="end_after" -d repeat_end_after=2 -d overwrite=1 http://www.domain.com/api/1001/me/events

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

Request body parameters

Field Type Description
name String

A unique program name.

channel_id Int

The channel ID.

playlist_id Int

The playlist ID.

Default value: 0

description String

Description of the program.

ppv Int

The PPV flag.

price Float

The program PPV price.

start Int

The start timestamp.

end optional Int

The end timestamp (should be supplied in the absence of a playlist).

Default value: 0

repeat_enabled optional Int

Whether the program has any recurring occurrences or not (values: 0, 1).

Default value: 0

repeat_pattern optional String

The recurrence pattern for the program(values: daily, weekly, monthly, yearly).

repeat_period optional Int

The program recurrence period (values: 1 to 30).

repeat_day optional Array

The program recurrence days (values: sunday, monday, tuesday, wednesday, thursday, friday, saturday).

repeat_end optional String

The program recurrence end rule (values: no_end, end_by, end_after).

repeat_end_after optional Int

The program recurrence ends after period (values: 1 to 30).

repeat_end_on optional Int

The program recurrence ends on timestamp.

overwrite optional Int

The overwrite conflicting program occurrences flag (values: 0, 1).

Default value: 0

200 OK Response

Field Type Description
id Int

The generated id of the new program.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 123
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the program name field.

  description optional String[]

Error messages related to the program description field.

  channel_id optional String[]

Error messages related to the channel id field.

  playlist_id optional String[]

Error messages related to the playlist id field.

  ppv optional String[]

Error messages related to the ppv field.

  price optional String[]

Error messages related to the price field.

  start optional String[]

Error messages related to the start field.

  end optional String[]

Error messages related to the end timestamp based on the start timestamp and duration.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some provided details are not correct",
  "errors": {
    "end": [
        "End time \"Tue, 26 May 2015 11:47:28 +0200\" is in the past"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new favorite broadcaster

Adds a new broadcaster to the user's favorite broadcasters list.

http://www.domain.com/api/:application_id/me/favorite/broadcasters

Permission: use_api  

curl -i -d broadcaster_id=113 http://www.domain.com/api/1001/me/favorite/broadcasters

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
broadcaster_id Int

The broadcaster ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Broadcaster does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new favorite channel

Adds a new channel to the user's favorite channels list.

http://www.domain.com/api/:application_id/me/favorite/channels

Permission: use_api  

curl -i -d channel_id=113 http://www.domain.com/api/1001/me/favorite/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
channel_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new favorite event

Adds a new event to the user's favorite events list.

http://www.domain.com/api/:application_id/me/favorite/events

Permission: use_api  

curl -i -d event_id=113 http://www.domain.com/api/1001/me/favorite/events

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
event_id Int

The event ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Event does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new favorite radio channel

Adds a new radio channel to the user's favorite radio channels list.

http://www.domain.com/api/:application_id/me/favorite/radios

Permission: use_api  

curl -i -d radio_id=113 http://www.domain.com/api/1001/me/favorite/radios

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
radio_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Radio channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new favorite video

Adds a new video to the user's favorite videos list.

http://www.domain.com/api/:application_id/me/favorite/videos

Permission: use_api  

curl -i -d video_id=113 http://www.domain.com/api/1001/me/favorite/videos

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
video_id Int

The video ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Video does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Add a new radio channel event

Add a new radio channel event

http://www.domain.com/api/:application_id/me/radio-events

Permission: use_api  

curl -i -d name="Program name" -d description="Program description" -d channel_id=31 -d playlist_id=83 -d start=1431336256 -d repeat_enabled=1 -d repeat_pattern="daily" -d repeat_period=2 -d repeat_end="end_after" -d repeat_end_after=2 -d overwrite=1 http://www.domain.com/api/1001/me/radio-events

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

Request body parameters

Field Type Description
name String

A unique program name.

channel_id Int

The channel ID.

playlist_id Int

The playlist ID.

Default value: 0

description String

Description of the program.

start Int

The start timestamp.

end optional Int

The end timestamp (should be supplied in the absence of a playlist).

Default value: 0

repeat_enabled optional Int

Whether the program has any recurring occurrences or not (values: 0, 1).

Default value: 0

repeat_pattern optional String

The recurrence pattern for the program(values: daily, weekly, monthly, yearly).

repeat_period optional Int

The program recurrence period (values: 1 to 30).

repeat_day optional Array

The program recurrence days (values: sunday, monday, tuesday, wednesday, thursday, friday, saturday).

repeat_end optional String

The program recurrence end rule (values: no_end, end_by, end_after).

repeat_end_after optional Int

The program recurrence ends after period (values: 1 to 30).

repeat_end_on optional Int

The program recurrence ends on timestamp.

overwrite optional Int

The overwrite conflicting program occurrences flag (values: 0, 1).

Default value: 0

200 OK Response

Field Type Description
id Int

The generated id of the new program.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": 123
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the program name field.

  description optional String[]

Error messages related to the program description field.

  channel_id optional String[]

Error messages related to the channel id field.

  playlist_id optional String[]

Error messages related to the playlist id field.

  start optional String[]

Error messages related to the start field.

  end optional String[]

Error messages related to the end timestamp based on the start timestamp and duration.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some provided details are not correct",
  "errors": {
    "start": [
        "Start time is in the past"
    ],
    "end": [
        "End time is in the past"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Change the password for the current user

Change the password for the current user.

http://www.domain.com/api/:application_id/me/password

Permission: use_api  

curl -i -d password="123456" -d new_password="654321" http://www.domain.com/api/1001/me/password

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
password String

The current password of the user.

new_password String

The new password of the user.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "The current password is not correct.",
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a DVR request for a specific channel event

Delete a DVR request for a specific channel event

http://www.domain.com/api/:application_id/me/dvr/:event_id

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/dvr/1001

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

event_id Int

The channel event id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  event_id optional String[]

Error messages related to the channel event id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "event_id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a channel event poster

Delete a channel event poster

http://www.domain.com/api/:application_id/me/events/:id/poster

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/events/23/poster

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a channel event

Delete a channel event

http://www.domain.com/api/:application_id/me/events/:id

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/events/150492

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
id Int

The program id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad Request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a channel from followed list

Deletes a followed channel from the user's followed channels list.

http://www.domain.com/api/:application_id/me/followed/channels

Permission: use_api  

curl -i -X DELETE -d channel_id=113 http://www.domain.com/api/1001/me/followed/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
channel_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a favorite broadcaster

Deletes a favorite broadcaster from the user's favorite broadcasters list.

http://www.domain.com/api/:application_id/me/favorite/broadcasters

Permission: use_api  

curl -i -X DELETE -d broadcaster_id=113 http://www.domain.com/api/1001/me/favorite/broadcasters

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
broadcaster_id Int

The broadcaster ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Broadcaster does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a favorite channel

Deletes a favorite channel from the user's favorite channels list.

http://www.domain.com/api/:application_id/me/favorite/channels

Permission: use_api  

curl -i -X DELETE -d channel_id=113 http://www.domain.com/api/1001/me/favorite/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
channel_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a favorite event

Deletes a favorite event from the user's favorite events list.

http://www.domain.com/api/:application_id/me/favorite/events

Permission: use_api  

curl -i -X DELETE -d event_id=113 http://www.domain.com/api/1001/me/favorite/events

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
event_id Int

The event ID to remove.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Event does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a favorite radio channel

Deletes a favorite radio channel from the user's favorite radio channels list.

http://www.domain.com/api/:application_id/me/favorite/radios

Permission: use_api  

curl -i -X DELETE -d radio_id=113 http://www.domain.com/api/1001/me/favorite/radios

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
radio_id Int

The radio channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Radio channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a favorite video

Deletes a favorite video from the user's favorite videos list.

http://www.domain.com/api/:application_id/me/favorite/videos

Permission: use_api  

curl -i -X DELETE -d video_id=113 http://www.domain.com/api/1001/me/favorite/videos

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
video_id Int

The video ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Video does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a radio channel event poster

Delete a radio channel event poster

http://www.domain.com/api/:application_id/me/radio-events/:id/poster

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/radio-events/23/poster

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a radio channel event

Delete a radio channel event

http://www.domain.com/api/:application_id/me/radio-events/:id

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/radio-events/150492

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
id Int

The program id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad Request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a radio channel from followed list

Deletes a followed radio channel from the user's followed radio channels list.

http://www.domain.com/api/:application_id/me/followed/radios

Permission: use_api  

curl -i -X DELETE -d radio_id=113 http://www.domain.com/api/1001/me/followed/radios

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
radio_id Int

The radio channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Radio channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete a video

Delete a video

http://www.domain.com/api/:application_id/me/videos/:id

Permission: use_api   , delete_own_video access_admin_interface

curl -i -X DELETE http://www.domain.com/api/1001/me/videos/150492

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
id Int

The video id.

Query string parameters

Field Type Description
force optional String

The action force delete. Available options: no or yes. Can be used to pass some not critical checks (eg. playlists).

Default value: no

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "Video cannot be deleted as it is part of a playlist.",
  "title": "Forbidden"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Delete the current user profile image

Delete the profile image for the current user.

http://www.domain.com/api/:application_id/me/profile-image

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/profile-image

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Deletes an existing device

Delete an device.

http://www.domain.com/api/:application_id/me/devices/:id

Permission: use_api  

curl -i -X DELETE http://www.domain.com/api/1001/me/devices/AhW6DtH25Drtf

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The device id.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Follow a new channel

Adds a new channel to the user's followed channels list.

http://www.domain.com/api/:application_id/me/followed/channels

Permission: use_api  

curl -i -d channel_id=113 http://www.domain.com/api/1001/me/followed/channels

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
channel_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Follow a new radio channel

Adds a new radio channel to the user's followed radio channels list.

http://www.domain.com/api/:application_id/me/followed/radios

Permission: use_api  

curl -i -d radio_id=113 http://www.domain.com/api/1001/me/followed/radios

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
radio_id Int

The channel ID to add.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  rating optional String[]

Error messages related to the rating field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Radio channel does not exist"
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Register a new Google Play subscription.

Register a new Google Play subscription.

http://www.domain.com/api/:application_id/me/subscriptions/google-play

Permission: use_api  

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Request body parameters

Field Type Description
id Int

The Google Play subscription plan ID.

sku String

The correspondent Google Play product SKU.

package_name String

The Android application package name.

token String

The Google Play In-app Billing transaction token.

order_id String

The Google Play In-app Billing order ID.

signature String

The Google Play In-app Billing transaction signature.

purchase_time Int

The purchase time.

200 OK Response

Field Type Description
status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
}

400

Name Type Description
status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided subscription ID is not valid"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Register a new device or updates an existing one

Registers a new device or updates an existing one to be used by the current user .

http://www.domain.com/api/:application_id/me/devices/notify

Permission: use_api  

curl -i -d id="AhW6DtH25Drtf" -d name="Nexus Player" -d mac="2a:6f:34:ae:9d:e1" http://www.domain.com/api/1001/me/devices/notify

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id String

The API Application ID.

Request body parameters

Field Type Description
id String

A unique device ID (up to 64 characters).

name String

A name for the device (up to 128 characters).

mac String

The device MAC address (use the human-friendly form is six groups of two hexadecimal digits, separated by colons (:)).

playback optional String

The playback time delta (in seconds).

200 OK Response

Field Type Description
id String

The unique device id of the device.

playback Object

Details about the playback time.

  used Int

The total used playback time of this device.

  allowed Int

The total allowed playback time for this device.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": "AhW6DtH25Drtf",
  "playback": {
    "used": 118219,
    "allowed": 360000
  }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the name field.

  mac optional String[]

Error messages related to the MAC address field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some details are not correct",
  "errors": {
    "mac": [
        "The device MAC address cannot be empty"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Register a new device

Registers a new device to be used by the current user.

http://www.domain.com/api/:application_id/me/devices

Permission: use_api  

curl -i -d id="AhW6DtH25Drtf" -d name="Nexus Player" -d mac="2a:6f:34:ae:9d:e1" http://www.domain.com/api/1001/me/devices

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id String

The API Application ID.

Request body parameters

Field Type Description
id String

A unique device ID (up to 64 characters).

name String

A name for the device (up to 128 characters).

mac String

The device MAC address (use the human-friendly form is six groups of two hexadecimal digits, separated by colons (:)).

200 OK Response

Field Type Description
id Int

The unique device id of the device.

status 200

The HTTP response code.

HTTP/1.1 200 OK
{
  "status": 200,
  "id": "AhW6DtH25Drtf"
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  name optional String[]

Error messages related to the name field.

  mac optional String[]

Error messages related to the MAC address field.

  user_id optional String[]

Error messages related to the user_id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Some details are not correct",
  "errors": {
    "mac": [
        "The device MAC address cannot be empty"
    ],
    "user_id": [
        "The requested user ID does not exist"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Retrieve videos of my channel

Retrieve my channel videos

http://www.domain.com/api/:application_id/me/channel/:id/videos

Permission: use_api  

curl -i http://www.domain.com/api/1001/me/channel/32132/videos

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

id Int

The channel id.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 100).

Default value: 30

order_by optional string

How to order the retrived videos. Available options:

  • name - the name of the video
  • created - the date when the video was created
  • views - the total number of video views
  • featured - featured status

Default value: name

direction optional string

How to sort videos. Available options: 'ASC' or 'DESC'.

Default value: ASC

200 OK Response

Field Type Description
videos Object[]

A list of available videos.

  id Int

The video id.

  name String

The video name.

  type String

Type of the video. Available options: 'encoded','recorded' or 'uploaded'.

  featured Boolean

Whether the video is a featured video or not.

  views Int

The total number of video views.

  category Object

An object holding category data.

    id Int

The video category id.

    name String

The video category name.

  description String

The video description details.

  url String

The URL to the public video page.

  img String

The URLs for the video images.

    large String

The URL for the video image (960x540).

    medium String

The URL for the video image (640x360).

    small String

The URL for the video image (320x180).

    custom String

The URL for the video image.

  rating Int

The current video rating.

  ratings Int

The total number of ratings.

  files Object

The available video file formats.

    id String

The video file id (Eg.: 1425).

    type String

The video type. Available options: 'primary','additional'.

    extension String

The video file format type (Eg.: mp4).

    title String

The video file format title.

    download_link String

The video file download link.

    metadata Object

The metadata for this video file format (width, height, bitrate, size).

status 200

The HTTP response code.

order Object

An object holding response items ordering fields.

  field String

The order_by parameter.

  direction String

The direction parameter.

pager Object

An object holding pager related fields.

  offset Int

The offset of the first row.

  limit Int

The number of results requested (actual returned results might be lower).

  total Int

The total number of results available.

HTTP/1.1 200 OK
{
  "status": 200,
  "videos": [{
    "id": 694,
    "name": "EkJotIntr3.mp4",
    "rating": 0,
    "ratings": 0,
    "type": "encoded",
    "featured": false,
    "views": 0,
    "duration": 19.87,
    "category": {
        "id": 0,
        "name": null
    },
    "description": "",
    "url": "http:\/\/tiki.devel.com\/video\/694",
    "img": {
        "custom": "http:\/\/tiki.devel.com\/templates\/one-more-test\/images\/defaults\/video-[width]x[height]-000000.jpg",
        "large": "http:\/\/tiki.devel.com\/templates\/one-more-test\/images\/defaults\/video-960x540-000000.jpg",
        "medium": "http:\/\/tiki.devel.com\/templates\/one-more-test\/images\/defaults\/video-640x360-000000.jpg",
        "small": "http:\/\/tiki.devel.com\/templates\/one-more-test\/images\/defaults\/video-320x180-000000.jpg"
    },
    "files": [
        {
            "id": "1425",
            "type": "primary",
            "extension": "mp4",
            "title": "SD 480p",
            "download_link": "http:\/\/tiki.devel.com\/\/services\/download.php?video_id=694&file_id=1389&code=E2A62C2C118F6D65",
            "metadata": {
                "width": "848",
                "height": "480",
                "bitrate": "1027992",
                "size": "2475642"
            }
        }
    ]
  }],
  "order": {
      "field": "name",
      "direction": "ASC"
  },
  "pager": {
    "offset": 0,
    "limit": 30,
    "total": 2
  }
}

400

Name Type Description
errors optional Object

A collection of field related error messages.

  id optional String[]

Error messages related to the id field.

status 400

The Bad Request HTTP response code.

reason String

The error description.

401 Unauthorized Response

Name Type Description
status 401

The Unauthorized HTTP response code.

reason String

The error description.

403 Forbidden Response

Name Type Description
status 403

The Forbidden HTTP response code.

reason String

The error description.

404 Not Found Response

Name Type Description
status 404

The Not Found HTTP response code.

reason String

The error description.

500 Internal Server Error

Name Type Description
status 500

The Internal Server Error HTTP response code.

reason String

The error description.

Other Error Responses

Name Type Description
status Int

The HTTP response code.

reason String

A generic error description.

HTTP/1.1 400 Bad Request
{
  "status": 400,
  "reason": "Bad request",
  "errors": {
    "id": [
        "The provided ID is not a valid integer"
    ]
  }
}
HTTP/1.1 401 Unauthorized
{
  "status": 401,
  "reason": "Missing authentication credentials or invalid api authentication key or token."
}
HTTP/1.1 403 Forbidden
{
  "status": 403,
  "reason": "You are not authorized to perform this action."
}
HTTP/1.1 404 Not Found
{
  "status": 404,
  "reason": "The requested entity could not be found."
}
HTTP/1.1 500 Internal Server Error
{
  "status": 500,
  "reason": "An error occurred while trying to process your request."
}

Current_User - Retrieve DVR requests

Retrieves a list of all DVR requests for the current user

http://www.domain.com/api/:application_id/me/dvr

Permission: use_api  

curl -i http://www.domain.com/api/1001/dvr

HTTP Basic authentication

Field Type Description
Authorization String

The Authorization header, constructed using credentials explained below.

HTTP Basic authentication credentials

Field Type Description
user String

The authentication key of the user accessing the resource.

password String

The generated authentication token for this request.

URL parameters

Field Type Description
application_id Int

The API Application ID.

Query string parameters

Field Type Description
offset optional Int

The offset of the first row.

Default value: 0

limit optional Int

The number of results to return (maximum 999).

Default value: 30

order_by optional string

How to order the retrived channels. Available options:

  • start - the start time of the channel event being recorded
  • created - The time when the request was created
  • name - the name of the channel event
  • channel - the name of the channel

Default value: start

direction optional string

How to sort results. Available options: 'ASC' or 'DESC'.

Default value: DESC

status optional string

Whether to filter the list by status. Available options: all, pending, failed and finished.

Default value: all

shrinked optional string

Whether to return a shrinked response or not (default, no).

Default value: 0

200 OK Response

Field Type Description
results Object[]

A list of DVR requests.

  created Int

The time when this DVR request was created.

  start Int

The time when the channel event starts.

  end Int

The time when the channel events ends.

  status String

The status: pending, recording, failed or finished.

  duration optional Float

The duration of the recorded video, only for finished requests.

  event Object

Channel event details.

    id Int

Channel event ID.

    name String