Get Webcast Details

Here you can retrieve Webcasts in your Rev account individually by event, for a given time range, or search by custom field and/or date range. You can also check the status of a Webcast and retrieve webcast URLs.

Individual Webcasts
Webcast Status
Get Webcast URLs
Time Range
Search By Custom Field/Date Range

Individual Webcast Details

This will retrieve all the various settings and metadata for a specific webcast.

GET

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

Path Parameters

Name	Type	Description	Required
Id	path	GUID for the webcast	Yes

Example Response

 
{
  "eventId": "string",
  "title": "string",
  "description": "string",
  "startDate": "2021-04-19T15:39:18.676Z",
  "endDate": "2021-04-19T15:39:18.676Z",
  "presentationProfileId": "string",
  "eventAdminIds": [
    "string"
  ],
  "automatedWebcast": true,
  "closedCaptionsEnabled": true,
  "pollsEnabled": true,
  "chatEnabled": true,
  "questionOption": "string",
  "questionAndAnswerEnabled": true,
  "userIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "moderatorIds": [
    "string"
  ],
  "password": "string",
  "accessControl": "string",
  "eventUrl": "string",
  "icsFileUrl": "string",
  "vcSipAddress": "string",
  "videoSourceType": "string",
  "rtmp": {
    "url": "string",
    "key": "string"
  },
  "webexTeam": {
    "roomId": "string",
    "name": "string"
  },
  "zoom": {
    "meetingId": "string",
    "meetingPassword": "string"
  },
  "backgroundImages": [
    {
      "url": "string",
      "scaleSize": "Original"
    }
  ],
  "categories": [
    {
      "categoryId": "string",
      "name": "string",
      "fullpath": "string",
      "restricted": true
    }
  ],
  "tags": [
    "string"
  ],
  "unlisted": true,
  "estimatedAttendees": 0,
  "lobbyTimeMinutes": 0,
  "preProduction": {
    "duration": "string",
    "userIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ]
  },
  "shortcutName": "string",
  "shortcutNameUrl": "string",
  "LinkedVideoId": "string",
  "AutoAssociateVod": true,
  "RedirectVod": true,
  "RecordingUploaderUserId": "string",
  "PresentationFileDownloadAllowed": true,
  "RegistrationFields": [
    {
      "Id": "string",
      "Name": "string",
      "FieldType": "string",
      "Required": true,
      "Options": [
        "string"
      ],
      "IncludeInAllWebcasts": true
    }
  ],
  "CustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true,
      "displayedToUsers": true,
      "fieldType": "string"
    }
  ],
  "liveSubtitles": {
    "sourceLanguage": "string",
    "translationLanguages": [
      "string"
    ]
  },
  "autoplay": true,
  "disableAutoRecording": true,
  "shareUrl": true,
  "enableCustomBranding": true,
  "brandingSettings": {
    "headerColor": "string",
    "headerFontColor": "string",
    "primaryFontColor": "string",
    "accentColor": "string",
    "accentFontColor": "string",
    "primaryColor": "string",
    "logos": [
      {
        "url": "string",
        "scaleSize": "Original"
      }
    ]
  }
}

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Get Webcast Status

GET

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

Returns the status of a Webcast. Possible status states include:

Scheduled = Before Event
Starting = During Event
InProgress = During Event
Broadcasting = During Event
Recording = During Event
RecordingStarting = During Event
RecordingStopping = During Event
VideoSourceStarting = During Event
Completed = Event Over
Deleted = Event Deleted

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the selected webcast.

Example Response

 
{
  "eventTitle": "string",
  "startDate": "2020-08-11T12:47:45.911Z",
  "endDate": "2020-08-11T12:47:45.911Z",
  "eventStatus": "Scheduled",
  "slideUrl": "string",
  "isPreProduction": true,
  "reason": "string"
}

Response Codes

Code	Description
401	Unauthorized error
500	Internal server error

Get Webcast URLs

This API retrieves list of all playback URLs to provided GUID from the system.

GET

/api/v2/scheduled-events/{eventId}/playback-url

Request Parameters

Name	Type	Description	Required
eventId	string	GUID corresponding to referred event.	Yes
user-agent	string	user agent of the user’s device. Example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0	Yes
ip	string	IP Address of the user/client. Provide the IP addresses of user/client with comma separated values (127.0.0.0,127.0.0.1)	Yes

Example Response

 
[

{
"label": "-"
"qValue": 80000
"player": "Native"
"url": "rtmp://10.10.5.206:1935/live/QADME04"
"zoneId": "071aaef2-1866-4435-88ba-a8e4942f1893"
"slideDelaySeconds": 0
"videoFormat": "H264"
"videoInstanceId": null
"deviceId": "9b6ef0b3-17a7-4408-82f0-81e01173784f"
}
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Find Webcasts During a Specified Time Period

GET

/api/v2/scheduled-events/?after={after-date}&before={before-date}

Example: /api/v2/events/?after=2015-02-12T12%3A00-05%3A30%0A%0A%0A%0A%0A%0A%0A%0A&before=2016-01-29T12%3A00-05%3A30

Request Parameters

Name	Type	Description	Required
after	string	Events with an end date after the specified date will be included in the response. If not included, this will be set to either 12 months prior to the BEFORE parameter, or the current date and time if BEFORE is not set.	Yes
before	string	Events with a start date on or before the specified date will be included in the response. If not included, this be set to either 12 months after the AFTER parameter, or 12 months from the current date and time if AFTER is not set.	Yes
sortField	query	If provided, the query results will be sorted based on field value. Values can be set to startDate or title. Default is set to startDate.
sortDirection	query	If provided, the query results will be sorted on ascending or descending order (asc, desc).

Example Response

 
[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "startDate": "2019-05-06T17:02:48.058Z",
    "endDate": "2019-05-06T17:02:48.058Z",
    "listingType": "string",
    "eventUrl": "string",
    "backgroundImages": [
      {
        "backgroundImageUrl": "string",
        "scaleSize": "Original"
      }
    ],
    "categories": [
      {
        "categoryId": "string",
        "name": "string",
        "fullpath": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "unlisted": true,
    "estimatedAttendees": 0,
    "lobbyTimeMinutes": 0,
    "preProduction": {
      "duration": "string",
      "userIds": [
        "string"
      ],
      "groupIds": [
        "string"
      ]
    },
    "shorcutName": "string"
  }
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Search Webcasts By Custom Fields/Date Range

This endpoint searches a webcast by custom fields and/or a given date range. At least one query parameter should be passed (startDate, endDate, customFields) or a Bad Request error is returned.

POST

/api/v2/search/scheduled-events

Request Parameters

Name	Type	Description	Required
scrollId	string	Search request tracking id in support of pagination functionality. Value is provided for the initial call and should be included in the succeeding calls. When a valid scrollId (as tracking Id) is passed to the request, only Size is modifiable i.e. one can increase/decrease the number of matching events in the response.
startDate	string	Search parameter to use to match those events that are set to start on or after the date specified. startDate should always be less than or equal to the endDate or a Bad Request is returned. If StartDate is not specified but EndDate is, StartDate assumes a value of EndDate – 365.	Yes, if endDate and/or customFields not used
endDate	string	Search parameter to use to match those events that are set to start on or before the date specified. The maximum date range that can be set is 365 days. If StartDate is specified but EndDate is not, EndDate assumes a value of TODAY. If StartDate and EndDate are not specified, EndDate assumes a value of TODAY, StartDate = EndDate – 365	Yes, if startDate and/or customFields not used
sortField	string	Sort field request. Default as ‘Title’ and case-sensitive. Naming convention used for the value is Pascal.
sortDirection	string	Sort order request. Default as ‘asc’ and is case-insensitive. Possible values: asc, desc
size	string	Size to the request. Default is 100, min is 50, max is 500.
customFields	[array(of customFields)]	Collection of custom fields to use when searching for events. All of the fields provided are concatenated as AND in the query by Rev. The value to the property ‘Value’ is required. id (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system. value (string) cannot be NULL and should always exist in the request. Rev returns a Bad Request if value is NULL or not part of the request. Value is case-insensitive. name (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system.	Yes, if startDate and/or endDate not used

Example Request

{ 
  "scrollId": "string", 
  "startDate": "2021-01-01T20:26:05.804Z", 
  "endDate": "2021-01-31T20:26:05.804Z", 
  "sortField": "string", 
  "sortDirection": "string", 
  "size": 100, 
  "customFields": [ 
    { 
      "name": "string", 
      "value": "string" 
    } 
  ] 
}

Example Response

 
[ 
  { 
    "scrollId": "string", 
    "total": 0, 
    "events": [ 
      { 
        "id": "string", 
        "title": "string", 
        "description": "string", 
        "startDate": "2021-02-01T20:26:05.809Z", 
        "endDate": "2021-02-01T20:26:05.809Z", 
        "listingType": "string", 
        "eventUrl": "string", 
        "backgroundImages": [ 
          { 
            "backgroundImageUrl": "string", 
            "scaleSize": "Original" 
          } 
        ], 
        "categories": [ 
          { 
            "categoryId": "string", 
            "name": "string", 
            "fullpath": "string", 
            "restricted": true 
          } 
        ], 
        "tags": [ 
          "string" 
        ], 
        "unlisted": true, 
        "estimatedAttendees": 0, 
        "lobbyTimeMinutes": 0, 
        "preProduction": { 
          "duration": "string", 
          "userIds": [ 
            "string" 
          ], 
          "groupIds": [ 
            "string" 
          ] 
        }, 
        "shorcutName": "string", 
        "shortcutNameUrl": "string", 
        "linkedVideoId": "string", 
        "autoAssociateVod": true, 
        "redirectVod": true 
      } 
    ] 
  } 
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Individual Webcasts

Individual Webcast Details

This will retrieve all the various settings and metadata for a specific webcast.

GET

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

Path Parameters

Name	Type	Description	Required
Id	path	GUID for the webcast	Yes

Example Response

 
{
  "eventId": "string",
  "title": "string",
  "description": "string",
  "startDate": "2021-04-19T15:39:18.676Z",
  "endDate": "2021-04-19T15:39:18.676Z",
  "presentationProfileId": "string",
  "eventAdminIds": [
    "string"
  ],
  "automatedWebcast": true,
  "closedCaptionsEnabled": true,
  "pollsEnabled": true,
  "chatEnabled": true,
  "questionOption": "string",
  "questionAndAnswerEnabled": true,
  "userIds": [
    "string"
  ],
  "groupIds": [
    "string"
  ],
  "moderatorIds": [
    "string"
  ],
  "password": "string",
  "accessControl": "string",
  "eventUrl": "string",
  "icsFileUrl": "string",
  "vcSipAddress": "string",
  "videoSourceType": "string",
  "rtmp": {
    "url": "string",
    "key": "string"
  },
  "webexTeam": {
    "roomId": "string",
    "name": "string"
  },
  "zoom": {
    "meetingId": "string",
    "meetingPassword": "string"
  },
  "backgroundImages": [
    {
      "url": "string",
      "scaleSize": "Original"
    }
  ],
  "categories": [
    {
      "categoryId": "string",
      "name": "string",
      "fullpath": "string",
      "restricted": true
    }
  ],
  "tags": [
    "string"
  ],
  "unlisted": true,
  "estimatedAttendees": 0,
  "lobbyTimeMinutes": 0,
  "preProduction": {
    "duration": "string",
    "userIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ]
  },
  "shortcutName": "string",
  "shortcutNameUrl": "string",
  "LinkedVideoId": "string",
  "AutoAssociateVod": true,
  "RedirectVod": true,
  "RecordingUploaderUserId": "string",
  "PresentationFileDownloadAllowed": true,
  "RegistrationFields": [
    {
      "Id": "string",
      "Name": "string",
      "FieldType": "string",
      "Required": true,
      "Options": [
        "string"
      ],
      "IncludeInAllWebcasts": true
    }
  ],
  "CustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "required": true,
      "displayedToUsers": true,
      "fieldType": "string"
    }
  ],
  "liveSubtitles": {
    "sourceLanguage": "string",
    "translationLanguages": [
      "string"
    ]
  },
  "autoplay": true,
  "disableAutoRecording": true,
  "shareUrl": true,
  "enableCustomBranding": true,
  "brandingSettings": {
    "headerColor": "string",
    "headerFontColor": "string",
    "primaryFontColor": "string",
    "accentColor": "string",
    "accentFontColor": "string",
    "primaryColor": "string",
    "logos": [
      {
        "url": "string",
        "scaleSize": "Original"
      }
    ]
  }
}

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Webcast Status

Get Webcast Status

GET

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

Returns the status of a Webcast. Possible status states include:

Scheduled = Before Event
Starting = During Event
InProgress = During Event
Broadcasting = During Event
Recording = During Event
RecordingStarting = During Event
RecordingStopping = During Event
VideoSourceStarting = During Event
Completed = Event Over
Deleted = Event Deleted

Request Parameters

Name	Type	Description	Required
eventId	string	GUID for the selected webcast.

Example Response

 
{
  "eventTitle": "string",
  "startDate": "2020-08-11T12:47:45.911Z",
  "endDate": "2020-08-11T12:47:45.911Z",
  "eventStatus": "Scheduled",
  "slideUrl": "string",
  "isPreProduction": true,
  "reason": "string"
}

Response Codes

Code	Description
401	Unauthorized error
500	Internal server error

Get Webcast URLs

Get Webcast URLs

This API retrieves list of all playback URLs to provided GUID from the system.

GET

/api/v2/scheduled-events/{eventId}/playback-url

Request Parameters

Name	Type	Description	Required
eventId	string	GUID corresponding to referred event.	Yes
user-agent	string	user agent of the user’s device. Example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0	Yes
ip	string	IP Address of the user/client. Provide the IP addresses of user/client with comma separated values (127.0.0.0,127.0.0.1)	Yes

Example Response

 
[

{
"label": "-"
"qValue": 80000
"player": "Native"
"url": "rtmp://10.10.5.206:1935/live/QADME04"
"zoneId": "071aaef2-1866-4435-88ba-a8e4942f1893"
"slideDelaySeconds": 0
"videoFormat": "H264"
"videoInstanceId": null
"deviceId": "9b6ef0b3-17a7-4408-82f0-81e01173784f"
}
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Time Range

Find Webcasts During a Specified Time Period

GET

/api/v2/scheduled-events/?after={after-date}&before={before-date}

Example: /api/v2/events/?after=2015-02-12T12%3A00-05%3A30%0A%0A%0A%0A%0A%0A%0A%0A&before=2016-01-29T12%3A00-05%3A30

Request Parameters

Name	Type	Description	Required
after	string	Events with an end date after the specified date will be included in the response. If not included, this will be set to either 12 months prior to the BEFORE parameter, or the current date and time if BEFORE is not set.	Yes
before	string	Events with a start date on or before the specified date will be included in the response. If not included, this be set to either 12 months after the AFTER parameter, or 12 months from the current date and time if AFTER is not set.	Yes
sortField	query	If provided, the query results will be sorted based on field value. Values can be set to startDate or title. Default is set to startDate.
sortDirection	query	If provided, the query results will be sorted on ascending or descending order (asc, desc).

Example Response

 
[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "startDate": "2019-05-06T17:02:48.058Z",
    "endDate": "2019-05-06T17:02:48.058Z",
    "listingType": "string",
    "eventUrl": "string",
    "backgroundImages": [
      {
        "backgroundImageUrl": "string",
        "scaleSize": "Original"
      }
    ],
    "categories": [
      {
        "categoryId": "string",
        "name": "string",
        "fullpath": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "unlisted": true,
    "estimatedAttendees": 0,
    "lobbyTimeMinutes": 0,
    "preProduction": {
      "duration": "string",
      "userIds": [
        "string"
      ],
      "groupIds": [
        "string"
      ]
    },
    "shorcutName": "string"
  }
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

Search By Custom Field/Date Range

Search Webcasts By Custom Fields/Date Range

POST

/api/v2/search/scheduled-events

Request Parameters

Name	Type	Description	Required
scrollId	string	Search request tracking id in support of pagination functionality. Value is provided for the initial call and should be included in the succeeding calls. When a valid scrollId (as tracking Id) is passed to the request, only Size is modifiable i.e. one can increase/decrease the number of matching events in the response.
startDate	string	Search parameter to use to match those events that are set to start on or after the date specified. startDate should always be less than or equal to the endDate or a Bad Request is returned. If StartDate is not specified but EndDate is, StartDate assumes a value of EndDate – 365.	Yes, if endDate and/or customFields not used
endDate	string	Search parameter to use to match those events that are set to start on or before the date specified. The maximum date range that can be set is 365 days. If StartDate is specified but EndDate is not, EndDate assumes a value of TODAY. If StartDate and EndDate are not specified, EndDate assumes a value of TODAY, StartDate = EndDate – 365	Yes, if startDate and/or customFields not used
sortField	string	Sort field request. Default as ‘Title’ and case-sensitive. Naming convention used for the value is Pascal.
sortDirection	string	Sort order request. Default as ‘asc’ and is case-insensitive. Possible values: asc, desc
size	string	Size to the request. Default is 100, min is 50, max is 500.
customFields	[array(of customFields)]	Collection of custom fields to use when searching for events. All of the fields provided are concatenated as AND in the query by Rev. The value to the property ‘Value’ is required. id (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system. value (string) cannot be NULL and should always exist in the request. Rev returns a Bad Request if value is NULL or not part of the request. Value is case-insensitive. name (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system.	Yes, if startDate and/or endDate not used

Example Request

{ 
  "scrollId": "string", 
  "startDate": "2021-01-01T20:26:05.804Z", 
  "endDate": "2021-01-31T20:26:05.804Z", 
  "sortField": "string", 
  "sortDirection": "string", 
  "size": 100, 
  "customFields": [ 
    { 
      "name": "string", 
      "value": "string" 
    } 
  ] 
}

Example Response

 
[ 
  { 
    "scrollId": "string", 
    "total": 0, 
    "events": [ 
      { 
        "id": "string", 
        "title": "string", 
        "description": "string", 
        "startDate": "2021-02-01T20:26:05.809Z", 
        "endDate": "2021-02-01T20:26:05.809Z", 
        "listingType": "string", 
        "eventUrl": "string", 
        "backgroundImages": [ 
          { 
            "backgroundImageUrl": "string", 
            "scaleSize": "Original" 
          } 
        ], 
        "categories": [ 
          { 
            "categoryId": "string", 
            "name": "string", 
            "fullpath": "string", 
            "restricted": true 
          } 
        ], 
        "tags": [ 
          "string" 
        ], 
        "unlisted": true, 
        "estimatedAttendees": 0, 
        "lobbyTimeMinutes": 0, 
        "preProduction": { 
          "duration": "string", 
          "userIds": [ 
            "string" 
          ], 
          "groupIds": [ 
            "string" 
          ] 
        }, 
        "shorcutName": "string", 
        "shortcutNameUrl": "string", 
        "linkedVideoId": "string", 
        "autoAssociateVod": true, 
        "redirectVod": true 
      } 
    ] 
  } 
]

Response Codes

Code	Description
200	ok
401	Unauthorized error
500	Internal server error

search check