Control a Webcast

This set of APIs allow you to programmatically start and stop a defined Webcast event (scheduled-event), start and pause the broadcast of the event, and start and stop the recording of the Webcast event. This means you can control Rev events via a 3rd party app (such as a touch panel) or from a single interface of your choice.

If the disableAutoRecording parameter is set to false in the Post/Put Webcast APIs, you are not able to use the recording APIs to start and stop a webcast. An error message is generated.

Start Event
End Event
Start Broadcast
Stop Broadcast
Start Recording
Stop Recording

Start an Event

This will start a defined Webcast. You may also start a Pre-Production Webcast.

PUT

/api/v2/scheduled-events/{eventId}/start

Path Parameters

Name	Type	Description
eventId	string	GUID for the webcast

Request Parameters

Name	Type	Description	Required
preProduction	boolean	Default value is false. If set to true, the action will be performed on a Pre-Production Webcast.

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

End an Event

This will end a defined Webcast. You may also end a Pre-Production Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/start

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes
preProduction	boolean	Default value is false. If set to true, the action will be performed on a Pre-Production Webcast.

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Start an Event Broadcast

This will start broadcasting a defined Webcast.

PUT

/api/v2/scheduled-events/{eventId}/broadcast

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

End an Event Broadcast

This will end a broadcasting Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/broadcast

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Start an Event Recording

This will start recording a defined Webcast.

PUT

/api/v2/scheduled-events/{eventId}/record

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Stop an Event Recording

This will end a recording Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/record

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Start Event

Start an Event

This will start a defined Webcast. You may also start a Pre-Production Webcast.

PUT

/api/v2/scheduled-events/{eventId}/start

Path Parameters

Name	Type	Description
eventId	string	GUID for the webcast

Request Parameters

Name	Type	Description	Required
preProduction	boolean	Default value is false. If set to true, the action will be performed on a Pre-Production Webcast.

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

End Event

End an Event

This will end a defined Webcast. You may also end a Pre-Production Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/start

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes
preProduction	boolean	Default value is false. If set to true, the action will be performed on a Pre-Production Webcast.

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Start Broadcast

Start an Event Broadcast

This will start broadcasting a defined Webcast.

PUT

/api/v2/scheduled-events/{eventId}/broadcast

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Stop Broadcast

End an Event Broadcast

This will end a broadcasting Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/broadcast

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Start Recording

Start an Event Recording

This will start recording a defined Webcast.

PUT

/api/v2/scheduled-events/{eventId}/record

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Stop Recording

Stop an Event Recording

This will end a recording Webcast.

DELETE

/api/v2/scheduled-events/{eventId}/record

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the webcast	Yes

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

search check