Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.48 KB

CreateConference.md

File metadata and controls

28 lines (22 loc) · 1.48 KB

Freeclimb::CreateConference

Properties

Name Type Description Notes
action_url String This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response.
_alias Boolean Descriptive name for the Conference. [optional]
play_beep PlayBeep [optional]
record Boolean When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. [optional]
status_callback_url String This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. [optional]
wait_url String If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. [optional]

Example

require 'freeclimb'

instance = Freeclimb::CreateConference.new(
  action_url: null,
  _alias: null,
  play_beep: null,
  record: null,
  status_callback_url: null,
  wait_url: null
)