Individual Webcast Details

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

NOTE: As of Rev v7.12, iCSFileUrl is available as a response parameter.
NOTE: As of Rev v7.23, this API lists all background image URLs used along with scale size.

GET
/api/v1/scheduled-events/{Id}

Request Parameters

Name Type Description Required
Id path GUID for the webcast Yes

Example Response

 
{
    "eventId": "9a8e4577-a9q9-410b-4323-7f7a03ebc2f2",
    "title": "CEO Townhall",
    "htmlDescription": "<p>Company Update</p>\n\n<p>Join us for a live company update.</p>",
    "description": "Company Update. Join us for a live company update.",
    "startDate": "2017-09-12T16:00:00",
    "endDate": "2017-09-12T16:30:00",
    "presentationProfileId": null,
    "eventAdminId": "asq908af-4878-b285-90asdfklsda09",
    "automatedWebcast": false,
    "pollsEnabled": true,
    "chatEnabled": false,
    "forceAnonymousQuestions": "IDENTIFIED",
    "questionAndAnswerEnabled": true,
    "closedCaptionsEnabled": false,
    "userIds": [
      "726b9364-fe7b-4091-baaf-ddc11649487d"
    ],
    "groupIds": [
      "c1bad2c7-9138-4cb7-840a-7d82eb036500"
    ],
    "moderatorIds": [
      "606a0aef-862e-4ed0-8019-8d2611db037b"
    ],
    "password": null,
    "accessControl": "Public",
    "eventUrl": "https://RevUrl/#/events/9a8e4577-a9q9-410b-4323-7f7a03ebc2f2",
    "iCSFileUrl": "https://RevUrl/scheduled-events/1a8e4577-e19b-410b-8698-7f7a03ebc2f9/icalendar"
    "backgroundImages": [
        {
          "backgroundImageUrl": "string",
          "scaleSize": "Original"
        }
     ]
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Find Webcasts During a Specified Time Period

NOTE: As of Rev v7.23, this API lists all background image URLs used along with scale size.

GET
/api/v1/events/?after={after-date}&before={before-date}

Example: /api/v1/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 path Events with a start date on or 12 months after the specified date will be included in the response. Url encoded dates in ISO 8601 format.
before path Events with a end date on or 12 months before the specified date will be included in the response. Url encoded dates in ISO 8601 format.

Example Response

 
[
{
  "id": "3e9e37cb-aff9-451e-954d-9842b93013e9",
  "title": "CEO Townhall",
  "description": "Company update",
  "startDate": "2016-01-26T14:00:00Z",
  "endDate": "2016-01-26T15:00:00Z",
  "eventAdmin":
  {
    "id": "726b9364-fe7b-4091-baaf-ddc11649487d",
    "name": "john.smith"
  },
  "listingType": "AllUsers",
  "eventUrl": "http://RevUrl/#/events/3e9e37cb-aff9-451e-954d-9842b93013e9"
},
{
  "id": "bce0d760-4f71-4be2-a62a-2eeb64e944e2",
  "title": "Sales Meeting",
  "description": "Quarterly sales team meeting",
  "startDate": "2016-01-29T10:52:00Z",
  "endDate": "2016-01-29T11:52:00Z",
  "eventAdmin":
  {
    "id": "726b9364-fe7b-4091-baaf-ddc11649487d",
    "name": "john.smith"
  },
  "listingType": "Private",
  "eventUrl": "http://RevUrl/#/events/bce0d760-4f71-4be2-a62a-2eeb64e944e2"
  "backgroundImages": [
        {
          "backgroundImageUrl": "string",
          "scaleSize": "Original"
        }
   ]
} ]

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Get Webcast URLs

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

NOTE: This API is available as of Rev v7.23.

GET
/api/v1/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

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

Get Webcast Status

NOTE: As of Rev v7.22, this API is available.
NOTE: As of Rev v7.23, this API now returns the URL of the current slide if the Webcast is in any status other than “Scheduled” or “Deleted”. This also assumes that the Webcast uses slides.

GET
/api/v1/scheduled-events/{eventId}/status

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

  • Scheduled
  • Starting
  • InProgress
  • Broadcasting
  • Deleted
  • Recording
  • RecordingStarting
  • RecordingStopping
  • VideoSourceStarting

NOTE: Once the event is over, its status is Scheduled.

Request Parameters

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

Example Response

 
{
  "eventTitle": "string",
  "startDate": "2018-06-14T14:25:33.900Z",
  "endDate": "2018-06-14T14:25:33.900Z",
  "eventStatus": "Scheduled",
  "slideUrl": "string"
}

Response Codes

Code Description
401 Unauthorized error
500 Internal server error