CreateConference

The CreateConference command does exactly what its name implies — it creates an empty 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.

CreateConference is a Terminal command (any actions following it are never executed). When the Conference is successfully created, FreeClimb invokes the provided actionUrl using an HTTP POST with a createConference Webhook as the body. After this request, control picks up using the PerCL code received in the response.

Nesting Rules

No actions can be nested within CreateConference and CreateConference cannot be nested in any other actions.

Example

[
  {
    "CreateConference" : {
      "actionUrl" : "http://example.com/conferenceCreated",
      "statusCallbackUrl" : "http://www.example.com/conferenceStatusChanged"
    }
  }
]

Command Attributes

CreateConference supports the following attributes that modify its behavior:

Type: absolute URL

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. Both the actionUrl and statusCallbackUrl are invoked when the Conference is successfully created.

Note: A PerCL response is expected to control the Conference.

The actionUrl is sent a createConference Webhook. The conferenceId parameter indicates the ID of the Conference that was created.

Type: absolute URL
Default: null

This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. A Conference status can change via:

• PerCL command
• REST API request
• When it is successfully created and becomes empty
• When the first Participant joins, resulting in a populated Conference
• When the first Participant whose startConfOnEnter property is set to true joins (thereby changing the Conference to inProgress)
• When the last Participant leaves the Conference, thereby changing the Conference status to empty
  Participants can be successfully added to a Conference once the statusCallbackUrl is invoked, signifying the Conference has been successfully created and is empty.
  When a populated or inProgress Conference is terminated (via PerCL or the REST API), this URL will be called twice – once when the Conference becomes empty and then again when it is terminated.

Note: This is a notification only; any PerCL returned will be ignored.

Additional Request Parameters

status Valid Values

Type: string
Default: null

Descriptive name for the Conference.

Type: string (eitheralways, never, entryOnly, or exitOnly)
Default:always

Indicates whether to play a beep when a Participant enters or leaves the Conference.

Type: boolean
Default:false

When set to true, the entire Conference is recorded. The statusCallbackUrl of the Conference will receive a conferenceRecordingStatus Webhook when the Conference transitions from the inProgress to empty status.

Type: absolute URL
Default: null

If specified, this URL provides the custom hold music for the Conference when it is in the populated state. A system default hold music will play for Conferences not using the waitUrl attribute. This attribute is always fetched using HTTP GET and must remain accessible to FreeClimb until the conference is Terminated.

FreeClimb supports multi-channel 8 bit audio a-law/μ-law (WAV) formats with an audio sampling rate of between 1000 and 96000. The max download size is 100MB. You can convert files to this format using an audio editor. Audacity is a free, open source option. See Play command for more details on conversion.

Note: The URL must be an audio file that is reachable and readable by FreeClimb.