Constants

The signalwire.relay.constants module defines string and numeric constants used throughout the RELAY namespace for call states, end reasons, connect states, event types, message states, media operation states, and protocol settings.

1
from signalwire.relay.constants import (
2
    CALL_STATE_ANSWERED,
3
    CALL_STATE_ENDED,
4
    END_REASON_HANGUP,
5
    EVENT_CALL_STATE,
6
    MESSAGE_STATE_DELIVERED,
7
)

Protocol

JSON-RPC Methods

Internal method identifiers used by the RELAY WebSocket protocol.

Call States

Constants representing the lifecycle states of a RELAY call. A call progresses through these states in order: created -> ringing -> answered -> ending -> ended.

End Reasons

Constants for the reason a call ended. Available in CallStateEvent.end_reason when the call reaches the ended state.

Connect States

Constants representing the state of a call bridge (connect) operation. Used in ConnectEvent.connect_state.

Event Types

String constants for all RELAY event types. Use these when registering event handlers with Call.on() or when matching against RelayEvent.event_type.

Calling Events

Messaging Events

Authorization Event

Message States

Constants representing the lifecycle states of an SMS/MMS message. Outbound messages progress through: queued -> initiated -> sent -> delivered (or undelivered / failed). Inbound messages arrive with state received.

Play States

Constants for audio playback operation states. Used in PlayEvent.state.

Record States

Constants for recording operation states. Used in RecordEvent.state.

Detect Types

Constants for detection operation types. Used in the type field of the detect parameter passed to call.detect().

Room States

Constants for audio/video room join/leave states.

Reconnect Settings

Configuration constants for the WebSocket reconnection strategy.

Example

1
from signalwire.relay.constants import (
2
    CALL_STATE_ANSWERED,
3
    CALL_STATE_ENDED,
4
    END_REASON_HANGUP,
5
    EVENT_CALL_STATE,
6
    MESSAGE_STATE_DELIVERED,
7
    MESSAGE_TERMINAL_STATES,
8
)
9
10
# Use in event handlers
11
def handle_call_state(event):
12
    if event.call_state == CALL_STATE_ANSWERED:
13
        print("Call answered!")
14
    elif event.call_state == CALL_STATE_ENDED:
15
        print(f"Call ended: {event.end_reason}")
16
17
# Check terminal message states
18
def handle_message_state(message):
19
    if message.state in MESSAGE_TERMINAL_STATES:
20
        print("Message delivery complete")