Skip to main content

Create resource token

POST 

/bv/cms/v1/resources/tokens

Creates an access token that can be embedded in the showroom iframe to access a live or VOD.


  • Returns a 404/NotFound error if the requested resource is not found.

Request

Header Parameters

    x-bv-org-id stringrequired

    To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Body

required
    resource_id stringrequired

    Required. The unique id of live or VOD.

    resource_type Required. Indicates the resource type is live or VOD. Available values: `RESOURCE_TYPE_LIVE_EVENT`, `RESOURCE_TYPE_VOD_EVENT` (string)required

    Possible values: [RESOURCE_TYPE_LIVE, RESOURCE_TYPE_VOD, RESOURCE_TYPE_LIVE_EVENT, RESOURCE_TYPE_LIVE_EVENT_RECORDING, RESOURCE_TYPE_VOD_EVENT, RESOURCE_TYPE_AUDIO_EVENT, RESOURCE_TYPE_VOD_ENCODING]

    customer_id string

    Optional. Required if the resource's security privacy is SECURITY_PRIVACY_TYPE_TOKEN. The customer ID for identifying who is playing the resource.

    customer_name string

    Optional. The customer name.

    expired_at date-time

    Optional. If provided, the token will expire at the specified UTC time. This field cannot be used in conjunction with the expires_in field. If neither field is set, the token will never expire.

    expires_in string

    Optional. If provided, the token will expire after the specified duration. This field cannot be used in conjunction with the expired_at field. If neither field is set, the token will never expire.

Responses

A successful response.

Schema
    token string

    Output only. The access token for live or VOD.

    expired_at date-time

    Optional. The UTC time at which the token will expire. If nil, the token will never expire.

Loading...