start call to conference room

class UASCallChannel

UASCallChannel.start_call_conference_room(conference_room_name, talker_and_listener=True, conference_lifetime_control=None, conference_party_media_settings=None)

Start a call to a named conference room.

Required argument:

• conference_room_name

  the name of the conference room to which to add this party

Optional arguments:

• talker_and_listener:

  whether the party is allowed to talk, as well as listen, in the conference. Default is True.

• conference_lifetime_control:

  whether the conference should start/end when this party enters/leaves.

• conference_party_media_settings:

  file and TTS play options, mute options.

This function is used to start a call to a named conference room, in which parties can talk with each other subject to the arguments, e.g. talker_and_listener provided when each entered.

The argument conference_room_name is the name of the conference room to which to add this party. If the conference room does not exist when this function is called, it will be created. When choosing a name for the conference room, it is strongly advised to choose a new name for each new conference. This avoids various potential issues, for example the case where a caller stays in one conference longer than expected and is suddenly introduced into a supposedly new conference as new callers ring in. The name is a string containing only alpha-numeric characters. It uniquely describes the conference room in the Cloud. Thus, all parties who wish to join a given conference must supply the same conference_room_name, and parties joining other conferences must supply different conference_room_name values.

The argument conference_lifetime_control controls whether the conference starts or stops when this party joins and leaves.

The argument conference_party_media_settings defines the audio that will be played to the conference at various times.

When this function is called, a new outbound call is placed to the named conference room. If the named conference does not already exist, it will be created. The call will ring until the conference is started; or until timeout expires or the original call hangs up. Once the conference starts (or if it has already started) the call is answered and the party is transferred to the conference.

This function will block until an acknowledgement has been received that the outgoing call has started, the global timeout has been reached, or the call state has returned to IDLE.

This function should be called when the call state is IDLE; otherwise, it will raise an Error exception.

This function will return True on success, else False.

Usage example:

if channel.start_call_conference_room(conference_room_name) is True:
    # the outgoing call has started
    # do something and then wait for the call to go to answered
    if channel.wait_for_outgoing_call() != channel.State.ANSWERED:
        # not answered, could be timeout or IDLE
        pass