Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 2.11 KB

CreateConference.md

File metadata and controls

17 lines (13 loc) · 2.11 KB

freeclimb.Model.CreateConference

The CreateConference command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants). Once created, a Conference remains in FreeClimb until explicitly terminated by a customer. Once a Conference has been terminated, it can no longer be used.

Properties

Name Type Description Notes
Command string Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments) [optional]
ActionUrl 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 bool Descriptive name for the Conference. [optional]
PlayBeep string Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` [optional]
Record bool 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]
StatusCallbackUrl bool This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. [optional]
WaitUrl 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]

[Back to Model list] [Back to API list] [Back to README]