wait_for_ringing | SignalWire

Wait until the call state reaches ringing. Returns immediately if the call is already ringing or has moved past it (answered, ending, or ended). A typed convenience over wait_for() on the calling.call.state event.

For an outbound call, this has usually already happened by the time you hold a reference to it: client.dial() returns only after the far end answers, so the method returns at once and event.params["call_state"] reports where the call is, working as a guard rather than a wait. An inbound call’s initial state is created; for it, the method returns once the ringing state event arrives, which usually precedes answer().

Parameters

timeout

float | NoneDefaults to None

Maximum seconds to wait. Raises asyncio.TimeoutError if exceeded. None waits indefinitely.

Returns

RelayEvent — The state event. When the call was already at or past the target, event.params["call_state"] holds the current state.

Example

from signalwire.relay import RelayClient
client = RelayClient(
    project="your-project-id",
    token="your-api-token",
    contexts=["default"],
)
@client.on_call
async def handle_call(call):
    await call.answer()
    dialed = await client.dial(
        devices=[[{"type": "phone", "params": {"to_number": "+15551234567", "from_number": "+15559876543"}}]]
    )
    event = await dialed.wait_for_ringing(timeout=10)
    # dial() already waited for the answer, so this prints "answered".
    print("State:", event.params["call_state"])
client.run()