Table of Contents
GetWebcastInformation
Returns basic information about the webcast including the expected preroll, start and end times along with the expected duration.The preroll, starttime and endtime properties are returned as a Unix timestamp (the number of seconds that have elapsed since January 1, 1970 00:00 UTC). The ‘duration’ property is returned in seconds. The archive_expiry is a Unix timestamp of the expiry date, if the archive_expiry is null the wecast never expires.
Full List of Properties Returned
password_email_information, is_expired, players, language, registration_secondary, assigned_password_field, assigned_password, webcast_reservation_id, reservation_id, starttime, endtime, preroll, archive_end, archive_end_visible, archive_review_end, timezone, twelve_hour_display, title, subtitle, description_above, description, lobby_enabled, logo_filename, logo_align, logo_bg_colour, logo_bg_image, logo_bg_image_repeat, logo_bg_image_position_vertical, logo_bg_image_position_horizontal, domain, named_link, colour1, colour2, colour3, colour4, colour5, password, user_passwords, password_list, password_text_above, password_text_below, registration_enabled, registration_closed, registration_one_per_primary, registration_text_above, registration_text_below, launch_text_above, launch_text_below, questions_enabled, questions_sendto, ics_include, ics_mailto, ics_mailto_name, ics_name, ics_body, conf_email, conf_email_mailto, conf_email_mailto_name, conf_email_subject, conf_email_body, template, footer, branding_visible, state, liveslide, multipage, ip_filtering, webcast_question_extra_field, webcast_survey, webcast_survey_url, webcast_survey_again, webcast_survey_forward_url, webcast_polling_vote_again, chat_enabled, webcast_extra_launch_text, webcast_layout, webcast_include, webcast_test_mode, webcast_customPlayer, display_audience_message_id, display_audience_question_id, marked_in, flash_source_url, display_poll, display_pollresult, broadcast_video_id, auto_producer_moderate, auto_moderator_moderate, client_name, user_editing, show_preroll_video, base_slideimage_url, creation_time, created_by_id, modified_time, modified_by_id, video_link_height, video_link_width, video_link_source, media_switcher_enabled, display_all_participants, external_chat_url, tech_chat, chat_logo, chat_launch_width, chat_launch_height, chat_name_entry, chat_remove_CRLFs, enable_closed_captions, external_chat_code, music_on_source, music_off_source, waitlist_threshold, waitlist_email_mailto, waitlist_email_mailto_name, waitlist_email_subject, waitlist_email_body, waitlist_email, liveslide_from_webcast_id, secondary_flash_source_url, is_template, last_cuepoint, use_phpamfmessages, display_location_info, colour6, colour7, use_nl2br, use_flash_slide_display, colour8, passwords_case_insensitive, hide_top_bottom_bars, hide_page_side_borders, full_page_question_id, put_registration_first, bar_display_path, base_slide_lookup_url, test_mode, record_player_messages, redirect, hide_question_name, closed_message, enter_button_text, requirements_above_enter_button, hide_system_test, system_test_below_launch, hide_enter_button, hide_broadcast_date, page_widths, custom_broadcast_date, custom_archive_date, login_title, registration_title, display_speaker_id, client_id, colour10, use_webcast_id_for_session, authentication_type, enable_robots_meta, portal_id, group_id, region_id, archive_starttime, use_starttime_cutoff, kick_participants, exit_url, exit_html, stats_version, notes, automatic_open, was_automatically_opened, passwords_emailed, questions_archive_hide, purchases_enabled, purchase_text_above, purchase_text_below, block_hours_after_login, tertiary_rtmp_source_url, tertiary_stream_name, hive_ticket_url, use_participant_chat, show_only_bitrate_menu, show_poll_confirmations, colour11, colour12, logo_alt_text, copy_questions_to_webcast_id, page_title_override, company_id, company_name, user_id, participant_chat_password_field_label, rumble_chat_room_id, rumble_chat_room_hash, tech_chat_code, enable_elemental, admin_version, player_version, tech_chat_code_player, ignore_other_webcast_cuepoints, archive_language_id, preregistration_message, use_registration_text_for_launch_text, feedback_url, upcoming_events_url, normal_notifications, base_asset_url, hide_player_map, icon_player_footer_text, colour13, colour14, colour15, colour16, cookie_login, full_page_preview_question_id, launch_enabled, exit_button, exit_button_url, reference, question_chat_opened, start_slide_position, question_chat_position, transcoder_started_once, chat_markup_urls, polling_wait_time, polling_wait_percent, polling_last_show_time, vmr_id, player_language_id, peer5_player_level, webcast_id_for_participant_chat, email_whitelist, lockout_admin_minutes, flashphoner_calls_vmr, use_freeswitch, webcast_id_for_registration, player_recording_started, error_on_registration_exists, use_kamailio, open_askaquestion_fields_required, polling_position, survey_again, branding_id, number_poll_questions, number_survey_questions, number_slide_decks, duration, deleted.
Example
Call= GetWebcastInformation
Parameters={“AccessID”:”1234abc”,”WebcastID”:1485,”AccessKey”:”abcde”}
URL with Urlencoded Values
https://www.domain.com/templates2.0/API/0.2/Call=GetWebcastInformation&Parameters=%7B%22AccessID%22:50,%22WebcastID%22:1485,%22AccessKey%22:%22abcde%22%7D
Example Return
{“is_expired”:false,”preroll”:”1371550500″,”starttime”:”1371551400″,”endtime”:”1371553200″,”timezone”:”Australia\/Sydney”,”domain”:”https:\/\/www.webcasts.com.au\/”,”named_link”:”students180613″,”state”:”archived”,”duration”:1800,”WebcastID”:1485}
