Create a Conference

Create an empty Conference within the specified account.

Further details about specific parameters can be found below:

statusCallbackUrl

The status of a conference will be reported to the statusCallbackUrl when:

  • A new Conference is in the process of being created
  • The empty Conference is created, changing it to the empty status
  • The first participant joins the Conference, changing it to the populated status
  • The first participant whose startConfOnEnter property is set to true joins, changing it to the inProgress status
  • The last participant leaves the conference, changing it to the empty status

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: creating, empty, populated, inProgress, or terminated.

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.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!