REST Client

1
client = SignalWireClient(
2
    project="your-project-id",
3
    token="your-api-token",
4
    host="your-space.signalwire.com",
5
)

1
# With env vars set, no arguments needed
2
client = SignalWireClient()

1
client.fabric          # AI agents, SWML scripts, subscribers, call flows
2
client.calling         # REST-based call control (37 commands)
3
client.phone_numbers   # Search, purchase, manage numbers
4
client.video           # Rooms, sessions, recordings, conferences
5
client.datasphere      # Document management and semantic search
6
client.compat          # Twilio-compatible LAML API
7
client.logs            # Message, voice, fax, conference logs
8
client.registry        # 10DLC brand/campaign management
9
client.queues          # Call queue management
10
client.recordings      # Recording management
11
client.project         # Project-level token management
12
client.mfa             # Multi-factor authentication
13
client.lookup          # Phone number carrier/CNAM lookup
14
client.pubsub          # PubSub token management
15
client.chat            # Chat token management

1
# List resources
2
result = client.phone_numbers.list(page_size=10)
3
4
# Create a resource
5
new = client.fabric.ai_agents.create(name="my-agent", type="ai_agent")
6
7
# Get a single resource
8
agent = client.fabric.ai_agents.get("resource-id")
9
10
# Update a resource
11
client.fabric.ai_agents.update("resource-id", name="updated-name")
12
13
# Delete a resource
14
client.fabric.ai_agents.delete("resource-id")

1
# AI agents
2
agents = client.fabric.ai_agents.list()
3
agent = client.fabric.ai_agents.create(name="support-bot", type="ai_agent")
4
5
# SWML scripts
6
scripts = client.fabric.swml_scripts.list()
7
8
# SWML webhooks
9
webhooks = client.fabric.swml_webhooks.list()
10
11
# Subscribers
12
subs = client.fabric.subscribers.list()
13
14
# Subscriber SIP endpoints
15
endpoints = client.fabric.subscribers.list_sip_endpoints("subscriber-id")
16
client.fabric.subscribers.create_sip_endpoint("subscriber-id", username="ext100")
17
18
# Call flows with versioning
19
flows = client.fabric.call_flows.list()
20
versions = client.fabric.call_flows.list_versions("flow-id")
21
client.fabric.call_flows.deploy_version("flow-id", version_id="v2")
22
23
# Tokens (subscriber, guest, invite, embed)
24
token = client.fabric.tokens.create_subscriber_token(subscriber_id="sub-id")
25
guest = client.fabric.tokens.create_guest_token(name="Guest User")

1
# Search for available numbers
2
available = client.phone_numbers.search(
3
    area_code="512",
4
    quantity=5,
5
)
6
7
# List your numbers
8
numbers = client.phone_numbers.list()
9
10
# Get a specific number
11
number = client.phone_numbers.get("number-id")
12
13
# Update number configuration
14
client.phone_numbers.update("number-id", name="Support Line")

1
# Initiate a call
2
result = client.calling.dial(
3
    call_id="call-id",
4
    devices=[[{"type": "phone", "params": {"to_number": "+15559876543"}}]],
5
)
6
7
# Play audio on a call
8
client.calling.play(call_id="call-id", play=[
9
    {"type": "tts", "text": "Hello from REST!"}
10
])
11
12
# Record a call
13
client.calling.record(call_id="call-id", record={"audio": {}})
14
15
# Control playback
16
client.calling.play_pause(call_id="call-id", control_id="ctrl-id")
17
client.calling.play_resume(call_id="call-id", control_id="ctrl-id")
18
client.calling.play_stop(call_id="call-id", control_id="ctrl-id")
19
20
# AI commands
21
client.calling.ai_message(call_id="call-id", message_text="New instruction")
22
client.calling.ai_hold(call_id="call-id")
23
client.calling.ai_unhold(call_id="call-id")
24
25
# End a call
26
client.calling.end(call_id="call-id", reason="hangup")

1
# Create a video room
2
room = client.video.rooms.create(name="standup", max_participants=10)
3
4
# List room sessions
5
sessions = client.video.room_sessions.list()
6
7
# Get session members
8
members = client.video.room_sessions.list_members("session-id")
9
10
# Manage conferences
11
conf = client.video.conferences.create(name="team-conf")
12
client.video.conferences.list_streams("conference-id")

1
# List documents
2
docs = client.datasphere.documents.list()
3
4
# Upload a document
5
doc = client.datasphere.documents.create(
6
    name="FAQ",
7
    content="Your FAQ content here...",
8
)
9
10
# Semantic search
11
results = client.datasphere.documents.search(
12
    query_string="How do I reset my password?",
13
    count=5,
14
)
15
16
# Manage chunks
17
chunks = client.datasphere.documents.list_chunks("document-id")
18
client.datasphere.documents.delete_chunk("document-id", "chunk-id")

1
# Voice call logs
2
calls = client.logs.voice.list(page_size=20)
3
call = client.logs.voice.get("log-id")
4
events = client.logs.voice.list_events("log-id")
5
6
# Message logs
7
messages = client.logs.messages.list()
8
9
# Fax logs
10
faxes = client.logs.fax.list()
11
12
# Conference logs
13
confs = client.logs.conferences.list()

1
# List brands
2
brands = client.registry.brands.list()
3
4
# Create a brand
5
brand = client.registry.brands.create(
6
    entity_type="PRIVATE_PROFIT",
7
    display_name="My Company",
8
)
9
10
# Create a campaign under a brand
11
campaign = client.registry.brands.create_campaign(
12
    "brand-id",
13
    description="Customer notifications",
14
    usecase="MIXED",
15
)
16
17
# Assign numbers to campaigns
18
order = client.registry.campaigns.create_order(
19
    "campaign-id",
20
    phone_number_ids=["number-id-1"],
21
)

1
# List calls
2
calls = client.compat.calls.list()
3
4
# Send an SMS
5
msg = client.compat.messages.create(
6
    To="+15559876543",
7
    From="+15551234567",
8
    Body="Hello from SignalWire!",
9
)
10
11
# Manage phone numbers
12
numbers = client.compat.phone_numbers.list()
13
14
# Start call recording
15
client.compat.calls.start_recording("call-sid")

1
# Queue management
2
queues = client.queues.list()
3
members = client.queues.list_members("queue-id")
4
next_member = client.queues.get_next_member("queue-id")
5
6
# Recordings
7
recordings = client.recordings.list()
8
9
# Phone number lookup
10
info = client.lookup.phone_number("+15551234567")
11
12
# Multi-factor authentication
13
client.mfa.sms(to="+15551234567", from_="+15550000000", message="Your code: {code}")
14
client.mfa.verify(request_id="req-id", token="123456")
15
16
# SIP profile
17
profile = client.sip_profile.get()
18
client.sip_profile.update(username="my-sip-user")
19
20
# Verified caller IDs
21
callers = client.verified_callers.list()

1
from signalwire.rest._pagination import PaginatedIterator
2
3
# Iterate all phone numbers across pages
4
for number in PaginatedIterator(
5
    client._http,
6
    "/api/relay/rest/phone_numbers",
7
    data_key="data",
8
):
9
    print(number["name"], number["number"])

1
from signalwire.rest import SignalWireClient, SignalWireRestError
2
3
client = SignalWireClient()
4
5
try:
6
    client.phone_numbers.get("nonexistent-id")
7
except SignalWireRestError as e:
8
    print(f"HTTP {e.status_code}: {e.body}")
9
    print(f"URL: {e.method} {e.url}")

1
#!/usr/bin/env python3
2
"""Provision a phone number and assign it to an AI agent."""
3
4
from signalwire.rest import SignalWireClient, SignalWireRestError
5
6
client = SignalWireClient()
7
8
# Search for a local number
9
available = client.phone_numbers.search(area_code="512", quantity=1)
10
numbers = available.get("data", [])
11
12
if not numbers:
13
    print("No numbers available")
14
    exit(1)
15
16
# Purchase the first available number
17
number_id = numbers[0]["id"]
18
print(f"Purchasing: {numbers[0].get('number', number_id)}")
19
20
# List AI agents
21
agents = client.fabric.ai_agents.list()
22
agent_list = agents.get("data", [])
23
24
if agent_list:
25
    agent_id = agent_list[0]["id"]
26
    print(f"Found agent: {agent_list[0].get('name', agent_id)}")
27
28
# Query recent call logs
29
logs = client.logs.voice.list(page_size=5)
30
for log in logs.get("data", []):
31
    print(f"  Call: {log.get('from')} -> {log.get('to')} ({log.get('status')})")