wait for transferred call retrievalΒΆ

class UASCallChannel
wait_for_transferred_call_retrieval(seconds_timeout=120)
Optional arguments:
  • seconds_timeout

    the amount of time to wait for the transfer to end. If seconds_timeout is None, there is no timeout. Default is two minutes.

Wait for a call channel that was transferred using the retrievable_transfer function to return to IDLE or ANSWERED.

The channel will return to ANSWERED if the far end hangs up, in which case the audio path to the channel will be restored.

The channel state will go to IDLE if the call is hung up, in which case this function will raise a Hangup exception.

When this function is called, the channel should be in the TRANSFERRED state.

This function will block while the call channel state remains in the TRANSFERRED state or until the timeout expires.

This function will return the channel state. If the channel state is ANSWERED that indicates that the call has been retrieved.

Usage example:

if channel.wait_for_transferred_call_retrieval() == channel.State.TRANSFERRED:
    print("wait for transferred call timed out")