Events

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import CallStateEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def on_call(call):
13
    def handle_state(event: CallStateEvent):
14
        print(f"Call state: {event.call_state}")
15
16
    call.on("calling.call.state", handle_state)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay.event import RelayEvent
2
3
event = RelayEvent.from_payload({
4
    "event_type": "calling.call.state",
5
    "params": {"call_state": "answered"},
6
})
7
print(event.event_type)  # "calling.call.state"

1
from signalwire.relay.event import parse_event
2
3
event = parse_event({
4
    "event_type": "calling.call.play",
5
    "params": {"control_id": "abc-123", "state": "playing"},
6
})
7
# Returns a PlayEvent instance
8
print(event.state)  # "playing"

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import CallStateEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_state(event: CallStateEvent):
14
        print(f"State: {event.call_state}, reason: {event.end_reason}")
15
16
    call.on("calling.call.state", handle_state)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import PlayEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_play(event: PlayEvent):
14
        print(f"Playback: {event.state}")
15
16
    call.on("calling.call.play", handle_play)
17
    await call.answer()
18
    await call.play([{"type": "tts", "text": "Hello!"}])
19
20
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import RecordEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_record(event: RecordEvent):
14
        print(f"Recording {event.state}: {event.url}")
15
16
    call.on("calling.call.record", handle_record)
17
    await call.answer()
18
    await call.record({"direction": "both"})
19
20
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import CollectEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_collect(event: CollectEvent):
14
        print(f"Collected: {event.result}")
15
16
    call.on("calling.call.collect", handle_collect)
17
    await call.answer()
18
    await call.play_and_collect(
19
        media=[{"type": "tts", "text": "Press 1 or 2."}],
20
        collect={"digits": {"max": 1}},
21
    )
22
23
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import ConnectEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_connect(event: ConnectEvent):
14
        print(f"Connection: {event.connect_state}")
15
16
    call.on("calling.call.connect", handle_connect)
17
    await call.answer()
18
    await call.connect(
19
        devices=[[{"type": "phone", "params": {"to_number": "+15559876543", "from_number": "+15551234567"}}]]
20
    )
21
22
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import DetectEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_detect(event: DetectEvent):
14
        print(f"Detected: {event.detect}")
15
16
    call.on("calling.call.detect", handle_detect)
17
    await call.answer()
18
    await call.detect({"type": "machine", "params": {"initial_timeout": 5.0}})
19
20
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import FaxEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_fax(event: FaxEvent):
14
        print(f"Fax: {event.fax}")
15
16
    call.on("calling.call.fax", handle_fax)
17
    await call.answer()
18
    await call.send_fax(document="https://example.com/invoice.pdf")
19
20
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import TapEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_tap(event: TapEvent):
14
        print(f"Tap {event.state}: {event.tap}")
15
16
    call.on("calling.call.tap", handle_tap)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import StreamEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_stream(event: StreamEvent):
14
        print(f"Stream {event.state}: {event.url}")
15
16
    call.on("calling.call.stream", handle_stream)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import SendDigitsEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_digits(event: SendDigitsEvent):
14
        print(f"Send digits: {event.state}")
15
16
    call.on("calling.call.send_digits", handle_digits)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import ReferEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_refer(event: ReferEvent):
14
        print(f"Refer to {event.sip_refer_to}: {event.state}")
15
16
    call.on("calling.call.refer", handle_refer)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import HoldEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_hold(event: HoldEvent):
14
        print(f"Hold: {event.state}")
15
16
    call.on("calling.call.hold", handle_hold)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import DenoiseEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_denoise(event: DenoiseEvent):
14
        print(f"Denoise active: {event.denoised}")
15
16
    call.on("calling.call.denoise", handle_denoise)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import PayEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_pay(event: PayEvent):
14
        print(f"Payment: {event.state}")
15
16
    call.on("calling.call.pay", handle_pay)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import EchoEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_echo(event: EchoEvent):
14
        print(f"Echo: {event.state}")
15
16
    call.on("calling.call.echo", handle_echo)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import QueueEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_queue(event: QueueEvent):
14
        print(f"Queue {event.queue_name}: position {event.position}/{event.size}")
15
16
    call.on("calling.call.queue", handle_queue)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import ConferenceEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_conference(event: ConferenceEvent):
14
        print(f"Conference {event.name}: {event.status}")
15
16
    call.on("calling.conference", handle_conference)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import TranscribeEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_transcribe(event: TranscribeEvent):
14
        print(f"Transcription {event.state}: {event.url}")
15
16
    call.on("calling.call.transcribe", handle_transcribe)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import CallingErrorEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_call
12
async def handle_call(call):
13
    def handle_error(event: CallingErrorEvent):
14
        print(f"Error {event.code}: {event.message}")
15
16
    call.on("calling.error", handle_error)
17
    await call.answer()
18
19
client.run()

1
from signalwire.relay import RelayClient
2
from signalwire.relay.event import MessageStateEvent
3
4
client = RelayClient(
5
    project="your-project-id",
6
    token="your-api-token",
7
    host="your-space.signalwire.com",
8
    contexts=["default"],
9
)
10
11
@client.on_message
12
async def handle_message(message):
13
    def handle_state(event: MessageStateEvent):
14
        print(f"Message {event.message_id}: {event.message_state}")
15
16
    message.on(handle_state)
17
18
client.run()