跳到主要内容

Archive live

POST 

/bv/cms/v1/lives/:id:archive

Archives the live stream, rendering it inaccessible for future use.


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

  • LIVE_STATUS_WAIT_FOR_PREVIEW
  • LIVE_STATUS_PREVIEW
  • LIVE_STATUS_LIVE
  • LIVE_STATUS_CLOSED
  • LIVE_STATUS_FAIL_TO_CREATE
  • LIVE_STATUS_FAIL_TO_PREVIEW
  • LIVE_STATUS_FAIL_TO_END
  • LIVE_STATUS_FAIL_TO_VOD
  • LIVE_STATUS_FAIL_TO_CANCEL
  • LIVE_STATUS_FAIL_TO_ARCHIVE

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