Table of Contents
CopyWebcast
Copies the webcast with the passed ID and returns the ID of the new webcast. Some components of the webcast are not copied such as slides, dates and the named link. A JSON encoded values object can be passed to override some webcast properties. Currently the supported properties are “preroll”,”starttime”,”endtime”,”archive_end”,”archive_starttime”,”title”,”subtitle”,”reference”,”client_name”,”named_link”,””conference_id”,”client_id”,”region_id”,”portal_id”,”group_id” and “company_id”. The times must be passed as unix timestamps. The times passed should have minutes divisible by 5 or end in zero. If there are no “Values” to be passed the “Values” object should be omitted.
The ‘reference’ property must be unique to each webcast. If an identical ‘reference’ is found an error will occur: “The ‘reference’ value already exists. The ‘reference’ must be unique. The webcast could not be copied [id=12345]”. If the ‘reference’ is omitted no check will occur.
The ‘named_link’ property must be unique to each webcast. This text is used in the construction of the webcast url and appears after the domain name. If an identical ‘named_link’ is found an error will occur: “The ‘named_link’ already exists, the ‘named_link’ must be unique. The webcast could not be copied [id=12345]”. The named link must be made up of alphanumeric characters or the hyphen and dash characters. It cannot consist entirely of numeric characters. If any the the aforementioned rules are violated an error will occur: :”Invalid ‘named_link’ value. The ‘named_link’ must begin with a non numeric character and must be made up of alphanumeric characters, also the dash and hyphen characters are allowed. The webcast could not be copied [id=12345]”. If the ‘named_link’ is omitted or blank the value of the webcast id will be used in the url.
Example
Call=CopyWebcast
Parameters={“AccessID”:”1234abc”,”WebcastID”:1485,”AccessKey”:”abcde”, “Values”:{“Webcast”:{“reference”:”somereference”,”preroll”:1536116400,”starttime”:1536118200,”endtime”:1536130800,”archive_end”:1543928400,”title”:”New Title”,”company_id”:12345,”timezone”:”America/Vancouver”}}}
URL with Urlencoded Values
https://www.domain.com/templates2.0/API/0.2/Call=CopyWebcast&Parameters=%7B%22AccessID%22%3A%221234abc%22%2C%22WebcastID%22%3A1485%2C%22AccessKey%22%3A%22abcde%22%2C%0A%22Values%22%3A%7B%22Webcast%22%3A%7B%22reference%22%3A%22somereference%22%2C%22preroll%22%3A1536116400%2C%22starttime%22%3A1536118200%2C%22endtime%22%3A1536130800%2C%22archive_end%22%3A1543928400%2C%22title%22%3A%22New%20Title%22%2C%22company_id%22%3A12345%2C%22timezone%22%3A%22America%2FVancouver%22%7D%7D%7D
Example Return
{“WebcastID”:6586}
