start call

class UASCallChannel

UASCallChannel.start_call(call_to, call_from='', codecs=None, live_speaker_detect=None, lsd_timeout_milliseconds=5000)

Start making an outbound call.

Required argument:

• call_to

  the call destination.

Optional arguments:

• call_from

  the origin of this call. Required for PSTN calls.

• codecs

  list of codecs to use on this call. Default is None (use the default).

• live_speaker_detect

  live speaker detection settings. Default is None.

• lsd_timeout_milliseconds

  live speaker detection timeout. Default is 5000.

This is the function used to begin placing an outbound call to the destination call_to. For details on specifying PSTN or SIP destinations please see the documentation for outbound calls.

The originating address call_from is compulsory for PSTN calls. For more information please see the documentation for outbound calls.

For SIP calls, codecs is an optional parameter to specify a semi-colon delimited list (in priority order) of codecs to offer for the call; for example, g711a;g711u. Please see the documentation for protocols and formats.

The option live_speaker_detect allows the user to enable a live speaker detection algorithm. This algorithm will indicate whether the call was answered by a live speaker, or by a machine.

This function will block until an acknowledgement has been received that the call has started, or a timeout occurs. If the timeout does occur, the function will return False and the call cause will be TIMEOUT.

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('sip:3301@127.0.0.1:5060;user=phone', call_from='bob@1234') is True:
    # we have started an outbound call
    pass