跳到主要内容

Cancel live

POST 

/bv/cms/v1/lives/:id:cancel

Terminates the live stream. Once canceled, the live stream will be archived.


Prerequisites: This API can be invoked when the live status is one of the following:

  • LIVE_STATUS_SCHEDULED
  • LIVE_STATUS_WAIT_FOR_PREVIEW
  • LIVE_STATUS_PREVIEW
  • LIVE_STATUS_LIVE
  • LIVE_STATUS_VOD_READY
  • LIVE_STATUS_VOD

  • Returns a 400/BadRequest error if the live status is in an impermissible state for cancellation.
  • Returns a 404/NotFound error if the requested live stream is not found.

Request

Path Parameters

    id stringrequired

    Required. The unique id of the live.

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

    object

Responses

A successful response.

Schema

    object

Loading...