Skip to main content

End live

POST 

/bv/cms/v1/lives/:id:end

Concludes the live stream. If VOD (Video On Demand) is enabled, the system will initiate encoding and make the VOD available to the audience. If not, the live stream will be closed and archived.


Prerequisites: This API can be invoked only when the live status is LIVE_STATUS_LIVE.


  • Return a 400/BadRequest error with ERROR_REASON_ACTION_NOT_ALLOWED if the live status is in an impermissible state for termination.
  • Return 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...