Create an empty Conference within the specified account. Making a Conference takes a short period of time. A 202 status code is returned if the Conference request was successfully queued by FreeClimb.
The waitUrl must remain accessible to FreeClimb until the conference is Terminated.
Further details about specific parameters can be found below:
statusCallbackUrl
The status of a conference will be reported to the statusCallbackUrl when:
- The empty Conference is created, changing it to the
emptystatus - The first participant joins the Conference, changing it to the
populatedstatus - The first participant whose startConfOnEnter property is set to
truejoins, changing it to theinProgressstatus - The last participant leaves the conference, changing it to the
emptystatus
Participants can be added to a Conference once the statusCallbackUrl is invoked, signifying the Conference has been created and is empty. When a populated or inProgress Conference is terminated, this URL is called twice — once when the Conference becomes empty and then again when it is terminated.
This is a notification only. Any PerCL returned by the application is ignored.
The statusCallbackUrl is invoked using HTTP POST with the following parameters (in addition to the standard request parameters).
| Parameter | Description |
|---|---|
| conferenceId | ID of the conference created. |
| status | The new status of the conference. Valid values: empty, populated, inProgress, terminated, or internalError. If an error occurs, the request can be retried. If it fails again, FreeClimb support should be contacted. Note there is no status callback posted for creating because the 202 response serves that purpose. |
| recordingUrl | URL of the Conference’s recorded audio file. Populated only if a recording exists and the Conference was emptied. |
| recordingId | ID of the recording from the Conference. Populated only if a recording exists and the Conference was emptied. |
| recordingDurationSec | The duration of the recorded audio (in seconds), rounded up to the nearest second. Populated only if a recording exists and the Conference was emptied. |
