pause

Pause the play-and-collect operation.

Parameters

behavior

str | NoneDefaults to None

Optional pause behavior. Controls what happens to the audio stream while paused (e.g., silence insertion).

Returns

dict — Server acknowledgment.

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()
    action = await call.play_and_collect(
        media=[{"type": "tts", "params": {"text": "Press 1 for sales, 2 for support."}}],
        collect={"digits": {"max": 1, "digit_timeout": 5.0}},
    )
    # Pause during an interruption
    await action.pause()
    # ... interruption handled ...
    await action.resume()
client.run()