Create a Webcast
Creates a new scheduled Webcast.
Request Body
{
"title": "string",
"description": "string",
"startDate": "2021-04-19T14:39:55.009Z",
"endDate": "2021-04-19T14:39:55.009Z",
"presentationProfileId": "string",
"eventAdminIds": [
"string"
],
"eventAdminEmails": [
"string"
],
"eventAdmins": [
{
"email": "string",
"firstName": "string",
"lastName": "string",
"isPrimary": true
}
],
"automatedWebcast": true,
"closedCaptionsEnabled": true,
"pollsEnabled": true,
"chatEnabled": true,
"questionAndAnswerEnabled": true,
"userIds": [
"string"
],
"groupIds": [
"string"
],
"moderatorIds": [
"string"
],
"moderators": [
{
"email": "string",
"firstName": "string",
"lastName": "string"
}
],
"password": "string",
"accessControl": "string",
"vcSipAddress": "string",
"videoSourceType": "string",
"isSecureRtmp": true,
"webexTeam": {
"roomId": "string",
"name": "string"
},
"zoom": {
"meetingId": "string",
"meetingPassword": "string"
},
"questionOption": "string",
"presentationFileDownloadAllowed": true,
"categories": [
"string"
],
"tags": [
"string"
],
"unlisted": true,
"estimatedAttendees": 0,
"lobbyTimeMinutes": 0,
"preProduction": {
"duration": "string",
"userIds": [
"string"
],
"groupIds": [
"string"
]
},
"shorcutName": "string",
"LinkedVideoId": "string",
"AutoAssociateVod": true,
"RedirectVod": true,
"RegistrationFieldIds": [
"string"
],
"CustomFields": [
{
"id": "string",
"value": "string",
"name": "string"
}
],
"liveSubtitles": {
"sourceLanguage": "string",
"translationLanguages": [
"string"
]
},
"autoplay": true,
"disableAutoRecording": true,
"hideShareUrl": true,
"recordingUploaderUserId": "string",
"recordingUploaderUserEmail": "string"
}
| Parameter | Type | Validations |
|---|---|---|
| title | string, required | Webcast title |
| description | string, optional | Webcast description |
| startDate | string, required | Start date and time. Must match this format: 2017-07-12T13:00:00Z |
| endDate | string, required | End date and time. Must match this format: 2017-07-12T14:00:00Z |
| eventAdminIds [ [string] ] | string, optional | Array of user GUIDs for the Webcast admins. If no Ids are passed, eventAdminEmails are checked. |
| eventAdmins [ [string] ] | string, optional |
Array of users who will be Webex Hosts and Co-hosts (In Vbrick its called event admins).
|
| eventAdminEmails [ [string] ](DEPRECATED) | string, optional | Array of event Admin emails. Note that up to 3 emails can be supported. If eventAdminIds are used, they take preference. If invalid emails are used, a 500 error is thrown. |
| videoSourceType | string, required |
Specifies a video source type. A videoSourceType is required for a WebexLiveStreaming event. For other types of events, Rev can infer the type based on presentationProfileId, rtmp, SipAddress, Zoom, or WebexTeam fields. Values may be the following:
|
| isSecureRtmp | boolean, optional |
Default=true. Specifies if an RTMP-based webcast should use RTMPS or RTMP. True sets to RTMPS and false sets to RTMP. |
| presentationProfileId | string, required* | GUID for the presentation profile. *Only required when Presentation Profile selected as a videoSourceType. |
| SipAddress | string, required* | SIP address if recording a video conference as the source. *Only required if SipAddress is the videoSourceType. |
| zoom [ [string] ] | string, required* | Zoom meeting room Id if recording a Zoom meeting as the video source. *Only required if Zoom is the videoSourceType. Input meetingId (required) and meetingPassword (optional). |
| webexTeam [ [string] ] | string, required* | Webex Team Room Id if recording a Webex Team meeting as the video source. *Only required if WebexTeam is the videoSourceType. Input roomId (required) and name (optional). |
| automatedWebcast | string, optional | true / false |
| accessControl | string, required |
This is an enum and can have the following values: Public/AllUsers/Private/TrustedPublic Note: TrustedPublic is only applicable for Partners. |
| RegistrationFieldIds [ [string] ] | string, optional | If accessControl is set to Public, used to define custom fields to collect more data from public attendees. Value = Ids returned in the Webcast Registration Fields POST endpoint. See: Webcast Registration Fields |
| isPublic | string, optional | true / false Set to false by default. |
| password | string | Optional, but only used with isPublic set to true. |
| closedCaptionsEnabled | boolean, required | true / false |
| pollsEnabled | boolean, optional | true / false |
| chatEnabled | boolean, optional | true / false |
| questionAndAnswerEnabled | boolean, optional | true / false |
| questionOption | string, optional |
|
| presentationFileDownloadAllowed | boolean, optional | true / false. Specifies if an attached presentation may be downloaded from the event. |
| moderatorIds [ [string] ] | string, optional | GUIDs for users that will serve as webcast moderators. |
| moderators [ [string] ] | string, optional |
Array of users who will be moderators. This will be equivalent to panelists in Webex.
Note: For Partners, auto creation of hosts/moderators occurs if user is not in Rev and new fields are used. This is only available for Account Admins. Email and lastName are required for user auto creation. |
| userIds [ [string] ] | string, optional | GUIDs for users on the access control list. Only used with Private events. |
| groupIds [ [string] ] | string, optional | GUID’s for groups on the access control list. Only used with Private events. |
| preProduction [ [string] ] | string, optional | Use if creating a pre-production event to set designated attendees and duration time span. Attendees should be either userIDs or groupIDs while duration is a time span in hours and minutes such as “04:00:00”, “1.06:00:00” . |
| shortcutName | string, optional |
Creates a custom event-friendly URL for a Webcast that makes it easier to remember for attendees. May be reused for multiple events as long as they do not conflict in date and time. Note that this URL is returned in the parameter shortcutNameUrl when the Get Event Details API is utilized. |
| LinkedVideoId | string, optional | Use to set the Id of a video that will be linked/associated to a Webcast that has finished recording. |
| AutoAssociateVod | boolean, optional | true / false. When true, the video in LinkedVideoId will be linked to a Webcast after it has concluded. |
| RedirectVod | boolean, optional | true / false. When true, users that access the Webcast will be automatically redirected to the video set in LinkedVideoId. If false, they will be directed the Event Landing page. |
| unlisted | boolean, optional | true / false. Specifies if the webcast is unlisted. If it is unlisted, prevents it from being displayed to all Media Contributors, Media Viewers, and Event Hosts that did not create the Webcast. Further, any resulting video is not visible or searchable in the Rev UI. |
| estimatedAttendees | numeric, optional | Number between 0 and 1000000. Allows you to estimate the number of people that will attend so technical resources can be adjusted as necessary. |
| lobbyTimeMinutes | numeric, optional | May not exceed 120. Period of time before a Webcast starts when attendees are permitted to join the event. |
| categories [ [string] ] | string, optional |
Category Ids to assign the final video to when the webcast is complete. Can assign to multiple categories. If you use categoryIds and they do not exist/are incorrect, the request will be rejected. The request is also rejected if you do not have contribute rights to a restricted category and you attempt to add/edit or otherwise modify it. |
| tags [ [string] ] | string, optional | Webcast tag name. Can assign to multiple tags. |
| CustomFields [ [uploadCustomFields] ] | string, optional |
Array of custom fields that is attached to the Webcast to provide additional information to attendees if desired. Note that if the custom field does not exist in Rev or if you provide an invalid value, the upload will fail. The uploadCustomFields array may contain the following parameters:
|
| RecordingUploaderUserId | string, optional | Id of the user who will be set as the uploader for the event recording. |
| recordingUploaderUserEmail | string, optional | Used if recordingUploaderUserId is not provided. Email of the user who will be set as the uploader for the event recording. |
| liveSubtitles [ [subtitleObject] ] | string, optional |
Live Subtitles properties of the webcast. Available to use if Rev IQ Transcription and Translation enabled with Rev IQ credits available. Available for all Rev sources outside of 3rd party HLS. Encoder-sourced webcasts also require a Rev IQ-enabled Presentation Profile selected as a video source for encoder-sourced streams.
|
| autoplay | boolean, optional | Determines how a broadcasting Webcast behaves when a viewer joins. Enabled, it plays immediately and is muted. Disabled, there is a button to start the Webcast and it is not muted. |
| disableAutoRecording | boolean, optional | [Future Use] Allows you to disable automatic recording if it has been enabled during event set up. If disableAutoRecording is set to false, you are not able to use the recording APIs to start and stop a webcast. The Webcast Recording system setting must be set to Allow for this parameter to have an effect. |
| hideShareUrl | boolean, optional | When true, the Webcast URL is hidden on the Webcast Landing page and on the Event Details page that is displayed to attendees while it is broadcasting. This option is false by default and the URL is displayed. |