BRbrightcovelearning
Media Sharing

Get Channel Details

Changed on

Gets settings for a sharing channel (currently there is only one default channel) - this is a Master account operation

get/v1/accounts/{{account_id}}/channels{channel_name}}

Request

  • Base URL
    https://cms.api.brightcove.com
  • URL
    https://cms.api.brightcove.com/v1/accounts/{{account_id}}/channels{channel_name}}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://oauth.brightcove.com/v4/access_token scopes: video-cloud/sharing-relationships/read

Path parameters

account_idstring required

Video Cloud account ID.

channel_namestring required

The name of the channel - usually default

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Response

200

account_idstring

master account id

account_namestring

master account name

created_atstring

when the channel was created

enforce_custom_fieldsboolean

if true, will allow sharing only if the affiliate account has all custom fields that have values for the video to be shared

enforce_geoboolean

if true, and master account is enabled for geo-filtering

namestring

channel name

updated_atstring

when the channel was last updated

Changes