> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # REST Client ## Docs - [Addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/addresses.md): Manage regulatory addresses. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/addresses/create.md): Create a new regulatory address. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/addresses/delete.md): Delete an address from the project. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/addresses/get.md): Retrieve a specific address. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/addresses/list.md): List addresses in the project. - [Calling](https://signalwire.com/docs/server-sdks/reference/python/rest/calling.md): REST-based call control namespace with 37 commands for managing active calls. - [ai_hold](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/ai-hold.md): Put an active AI session on hold via REST. - [ai_message](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/ai-message.md): Send a message to an active AI session on a call via REST. - [ai_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/ai-stop.md): Stop an active AI session on a call via REST. - [ai_unhold](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/ai-unhold.md): Resume a held AI session on a call via REST. - [collect](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/collect.md): Collect user input (DTMF or speech) on an active call via REST. - [collect_start_input_timers](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/collect-start-input-timers.md): Manually start input timers for a collection on a call via REST. - [collect_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/collect-stop.md): Stop an active input collection on a call via REST. - [denoise](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/denoise.md): Enable noise reduction on an active call via REST. - [denoise_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/denoise-stop.md): Disable noise reduction on an active call via REST. - [detect](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/detect.md): Start detection (answering machine, fax, DTMF) on a call via REST. - [detect_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/detect-stop.md): Stop an active detector on a call via REST. - [dial](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/dial.md): Initiate a new outbound call via REST. - [disconnect](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/disconnect.md): Disconnect (unbridge) a connected call without ending either leg via REST. - [end](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/end.md): End an active call via REST. - [live_transcribe](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/live-transcribe.md): Start live transcription with partial results on a call via REST. - [live_translate](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/live-translate.md): Start live translation on an active call via REST. - [play](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/play.md): Play audio or text-to-speech on an active call via REST. - [play_pause](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/play-pause.md): Pause an active playback on a call via REST. - [play_resume](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/play-resume.md): Resume a paused playback on a call via REST. - [play_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/play-stop.md): Stop an active playback on a call via REST. - [play_volume](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/play-volume.md): Adjust the volume of an active playback on a call via REST. - [receive_fax_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/receive-fax-stop.md): Stop an in-progress fax receive operation on a call via REST. - [record](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/record.md): Start recording an active call via REST. - [record_pause](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/record-pause.md): Pause an active recording on a call via REST. - [record_resume](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/record-resume.md): Resume a paused recording on a call via REST. - [record_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/record-stop.md): Stop an active recording on a call via REST. - [refer](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/refer.md): Send a SIP REFER to transfer a call at the SIP level via REST. - [send_fax_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/send-fax-stop.md): Stop an in-progress fax send operation on a call via REST. - [stream](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/stream.md): Stream call audio to a WebSocket endpoint via REST. - [stream_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/stream-stop.md): Stop an active audio stream on a call via REST. - [tap](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/tap.md): Tap call audio to an external endpoint via REST. - [tap_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/tap-stop.md): Stop an active audio tap on a call via REST. - [transcribe](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/transcribe.md): Start transcribing speech on an active call via REST. - [transcribe_stop](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/transcribe-stop.md): Stop an active transcription on a call via REST. - [transfer](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/transfer.md): Transfer an active call to a new destination via REST. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/update.md): Update parameters on an active call via REST. - [user_event](https://signalwire.com/docs/server-sdks/reference/python/rest/calling/user-event.md): Send custom user-defined events on an active call via REST. - [Chat](https://signalwire.com/docs/server-sdks/reference/python/rest/chat.md): Chat API namespace for token creation. - [create_token](https://signalwire.com/docs/server-sdks/reference/python/rest/chat/create-token.md): Create a Chat authentication token. - [Datasphere](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere.md): Document storage and vector search. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/create.md): Upload a new document. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/delete.md): Delete a document and all its chunks. - [delete_chunk](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/delete-chunk.md): Delete a specific chunk from a document. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/get.md): Retrieve a specific document. - [get_chunk](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/get-chunk.md): Retrieve a specific chunk from a document. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/list.md): List documents in the project. - [list_chunks](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/list-chunks.md): List chunks belonging to a document. - [search](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/search.md): Perform a semantic search across all documents. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/datasphere/update.md): Update a document. - [Fabric](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric.md): Manage AI agents, call flows, subscribers, conference rooms, tokens, and other Fabric resources. - [Addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/addresses.md): Read-only access to fabric addresses. - [AI Agents](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents.md): Manage AI agent resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/create.md): Create a new AI agent resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/delete.md): Delete an AI agent resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/get.md): Retrieve a single AI agent resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/list.md): List AI agent resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/list-addresses.md): List addresses associated with an AI agent resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/ai-agents/update.md): Partially update an AI agent resource. - [Call Flows](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows.md): Manage call flow resources with versioning and deployment. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/create.md): Create a new call flow resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/delete.md): Delete a call flow resource. - [deploy_version](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/deploy-version.md): Deploy a specific version of a call flow. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/get.md): Retrieve a single call flow resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/list.md): List call flow resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/list-addresses.md): List addresses associated with a call flow resource. - [list_versions](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/list-versions.md): List all versions of a call flow. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/call-flows/update.md): Replace a call flow resource. - [Conference Rooms](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms.md): Manage conference room resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/create.md): Create a new conference room resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/delete.md): Delete a conference room resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/get.md): Retrieve a single conference room resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/list.md): List conference room resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/list-addresses.md): List addresses associated with a conference room resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/conference-rooms/update.md): Replace a conference room resource. - [cXML Applications](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications.md): Manage cXML application resources. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications/delete.md): Delete a cXML application resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications/get.md): Retrieve a single cXML application resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications/list.md): List cXML application resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications/list-addresses.md): List addresses associated with a cXML application resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-applications/update.md): Replace a cXML application resource. - [cXML Scripts](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts.md): Manage cXML script resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/create.md): Create a new cXML script resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/delete.md): Delete a cXML script resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/get.md): Retrieve a single cXML script resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/list.md): List cXML script resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/list-addresses.md): List addresses associated with a cXML script resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-scripts/update.md): Replace a cXML script resource. - [cXML Webhooks](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks.md): Manage cXML webhook resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/create.md): Create a new cXML webhook resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/delete.md): Delete a cXML webhook resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/get.md): Retrieve a single cXML webhook resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/list.md): List cXML webhook resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/list-addresses.md): List addresses associated with a cXML webhook resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/cxml-webhooks/update.md): Partially update a cXML webhook resource. - [FreeSWITCH Connectors](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors.md): Manage FreeSWITCH connector resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/create.md): Create a new FreeSWITCH connector resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/delete.md): Delete a FreeSWITCH connector resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/get.md): Retrieve a single FreeSWITCH connector resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/list.md): List FreeSWITCH connector resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/list-addresses.md): List addresses associated with a FreeSWITCH connector resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/freeswitch-connectors/update.md): Replace a FreeSWITCH connector resource. - [Relay Applications](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications.md): Manage Relay application resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/create.md): Create a new Relay application resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/delete.md): Delete a Relay application resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/get.md): Retrieve a single Relay application resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/list.md): List Relay application resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/list-addresses.md): List addresses associated with a Relay application resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/relay-applications/update.md): Replace a Relay application resource. - [Resources](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources.md): Generic resource operations across all Fabric resource types. - [assign_domain_application](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/assign-domain-application.md): Assign a domain application to a Fabric resource. - [assign_phone_route](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/assign-phone-route.md): Assign a phone route to a Fabric resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/delete.md): Delete a Fabric resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/get.md): Retrieve a single Fabric resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/list.md): List all Fabric resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/resources/list-addresses.md): List addresses associated with a Fabric resource. - [SIP Endpoints](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints.md): Manage SIP endpoint resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/create.md): Create a new SIP endpoint resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/delete.md): Delete a SIP endpoint resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/get.md): Retrieve a single SIP endpoint resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/list.md): List SIP endpoint resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/list-addresses.md): List addresses associated with a SIP endpoint resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-endpoints/update.md): Replace a SIP endpoint resource. - [SIP Gateways](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways.md): Manage SIP gateway resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/create.md): Create a new SIP gateway resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/delete.md): Delete a SIP gateway resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/get.md): Retrieve a single SIP gateway resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/list.md): List SIP gateway resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/list-addresses.md): List addresses associated with a SIP gateway resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/sip-gateways/update.md): Partially update a SIP gateway resource. - [Subscribers](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers.md): Manage subscriber resources with SIP endpoint support. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/create.md): Create a new subscriber resource. - [create_sip_endpoint](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/create-sip-endpoint.md): Create a SIP endpoint for a subscriber. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/delete.md): Delete a subscriber resource. - [delete_sip_endpoint](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/delete-sip-endpoint.md): Delete a SIP endpoint for a subscriber. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/get.md): Retrieve a single subscriber resource. - [get_sip_endpoint](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/get-sip-endpoint.md): Retrieve a SIP endpoint for a subscriber. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/list.md): List subscriber resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/list-addresses.md): List addresses associated with a subscriber resource. - [list_sip_endpoints](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/list-sip-endpoints.md): List SIP endpoints for a subscriber. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/update.md): Replace a subscriber resource. - [update_sip_endpoint](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/subscribers/update-sip-endpoint.md): Partially update a SIP endpoint for a subscriber. - [SWML Scripts](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts.md): Manage SWML script resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/create.md): Create a new SWML script resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/delete.md): Delete a SWML script resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/get.md): Retrieve a single SWML script resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/list.md): List SWML script resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/list-addresses.md): List addresses associated with a SWML script resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-scripts/update.md): Replace a SWML script resource. - [SWML Webhooks](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks.md): Manage SWML webhook resources via the Fabric namespace. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/create.md): Create a new SWML webhook resource. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/delete.md): Delete a SWML webhook resource. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/get.md): Retrieve a single SWML webhook resource. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/list.md): List SWML webhook resources. - [list_addresses](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/list-addresses.md): List addresses associated with a SWML webhook resource. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/swml-webhooks/update.md): Partially update a SWML webhook resource. - [Tokens](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens.md): Create and manage Fabric authentication tokens. - [create_embed_token](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens/create-embed-token.md): Create an embed authentication token. - [create_guest_token](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens/create-guest-token.md): Create a guest authentication token. - [create_invite_token](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens/create-invite-token.md): Create an invite token for a subscriber. - [create_subscriber_token](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens/create-subscriber-token.md): Create a subscriber authentication token. - [refresh_subscriber_token](https://signalwire.com/docs/server-sdks/reference/python/rest/fabric/tokens/refresh-subscriber-token.md): Refresh an existing subscriber token. - [Imported Numbers](https://signalwire.com/docs/server-sdks/reference/python/rest/imported-numbers.md): Import phone numbers from other providers. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/imported-numbers/create.md): Import a phone number from an external provider. - [Logs](https://signalwire.com/docs/server-sdks/reference/python/rest/logs.md): Message, voice, fax, and conference logs. - [Conference Logs](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/conferences.md): Query conference log entries. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/conferences/list.md): List conference log entries. - [Fax Logs](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/fax.md): Query fax log entries. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/fax/get.md): Retrieve a specific fax log entry. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/fax/list.md): List fax log entries. - [Message Logs](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/messages.md): Query message log entries. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/messages/get.md): Retrieve a specific message log entry. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/messages/list.md): List message log entries. - [Voice Logs](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/voice.md): Query voice call log entries. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/voice/get.md): Retrieve a specific voice log entry. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/voice/list.md): List voice call log entries. - [list_events](https://signalwire.com/docs/server-sdks/reference/python/rest/logs/voice/list-events.md): List events for a specific voice call. - [Lookup](https://signalwire.com/docs/server-sdks/reference/python/rest/lookup.md): Phone Number Lookup namespace. - [phone_number](https://signalwire.com/docs/server-sdks/reference/python/rest/lookup/phone-number.md): Look up carrier and CNAM information for a phone number. - [Messages](https://signalwire.com/docs/server-sdks/reference/python/rest/messages.md): Send SMS and MMS messages and redact the body of a sent message. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/messages/create.md): Send an SMS or MMS message. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/messages/update.md): Redact the body of a previously sent message. - [MFA](https://signalwire.com/docs/server-sdks/reference/python/rest/mfa.md): Multi-factor authentication via SMS and voice. - [call](https://signalwire.com/docs/server-sdks/reference/python/rest/mfa/call.md): Send an MFA verification code via voice call. - [sms](https://signalwire.com/docs/server-sdks/reference/python/rest/mfa/sms.md): Send an MFA verification code via SMS. - [verify](https://signalwire.com/docs/server-sdks/reference/python/rest/mfa/verify.md): Verify an MFA code submitted by the user. - [Number Groups](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups.md): Manage number groups and membership. - [add_membership](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/add-membership.md): Add a phone number to a group. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/create.md): Create a new number group. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/delete.md): Delete a number group. - [delete_membership](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/delete-membership.md): Remove a phone number from a group. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/get.md): Retrieve a specific number group. - [get_membership](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/get-membership.md): Retrieve a specific membership. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/list.md): List number groups in the project. - [list_memberships](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/list-memberships.md): List phone numbers that belong to a group. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/number-groups/update.md): Update a number group. - [paginate](https://signalwire.com/docs/server-sdks/reference/python/rest/paginate.md): Iterate every item across all pages of a list endpoint. - [Phone Numbers](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers.md): Search and manage phone numbers, and bind inbound calls to handlers. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/create.md): Purchase a phone number. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/delete.md): Release a phone number from the project. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/get.md): Retrieve details for a specific phone number. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/list.md): List phone numbers owned by the project. - [search](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/search.md): Search for available phone numbers to purchase. - [set_ai_agent](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-ai-agent.md): Route inbound calls to an AI Agent Fabric resource by ID. - [set_call_flow](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-call-flow.md): Route inbound calls to a Call Flow by ID. - [set_cxml_application](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-cxml-application.md): Route inbound calls to an existing cXML application by ID. - [set_cxml_webhook](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-cxml-webhook.md): Route inbound calls to a cXML (LAML) webhook. - [set_relay_application](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-relay-application.md): Route inbound calls to a named Relay application. - [set_relay_topic](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-relay-topic.md): Route inbound calls to a Relay topic. - [set_swml_webhook](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/set-swml-webhook.md): Route inbound calls to an SWML webhook URL. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/phone-numbers/update.md): Update configuration for a phone number. - [Project](https://signalwire.com/docs/server-sdks/reference/python/rest/project.md): Project information and API tokens. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/project/create.md): Create a new API token for the project. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/project/delete.md): Revoke and delete an API token. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/project/update.md): Update an existing API token. - [Projects](https://signalwire.com/docs/server-sdks/reference/python/rest/projects.md): Create and manage subprojects and rotate a project's signing key. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/create.md): Create a subproject under the authenticated root project. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/delete.md): Delete a subproject. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/get.md): Retrieve a single project or subproject by ID. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/list.md): List the authenticated root project and its subprojects. - [rotate_signing_key](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/rotate-signing-key.md): Issue a new signing key for a project, invalidating the old one. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/projects/update.md): Update a project's name or media protection settings. - [PubSub](https://signalwire.com/docs/server-sdks/reference/python/rest/pubsub.md): PubSub API namespace for token creation. - [create_token](https://signalwire.com/docs/server-sdks/reference/python/rest/pubsub/create-token.md): Create a PubSub authentication token. - [Queues](https://signalwire.com/docs/server-sdks/reference/python/rest/queues.md): Manage call queues and members. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/create.md): Create a new queue. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/delete.md): Delete a queue. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/get.md): Retrieve a specific queue. - [get_member](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/get-member.md): Retrieve a specific member from a queue. - [get_next_member](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/get-next-member.md): Retrieve the next member in the queue. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/list.md): List queues in the project. - [list_members](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/list-members.md): List members currently in a queue. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/queues/update.md): Update a queue. - [Recordings](https://signalwire.com/docs/server-sdks/reference/python/rest/recordings.md): List, get, and delete call recordings. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/recordings/delete.md): Delete a recording. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/recordings/get.md): Retrieve a specific recording. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/recordings/list.md): List recordings in the project. - [Registry](https://signalwire.com/docs/server-sdks/reference/python/rest/registry.md): 10DLC brand and campaign registration. - [Brands](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands.md): 10DLC brand management. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands/create.md): Register a new 10DLC brand. - [create_campaign](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands/create-campaign.md): Create a messaging campaign under a brand. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands/get.md): Retrieve a specific brand. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands/list.md): List registered 10DLC brands. - [list_campaigns](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/brands/list-campaigns.md): List campaigns under a brand. - [Campaigns](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns.md): 10DLC campaign management. - [create_order](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns/create-order.md): Create a number assignment order for a campaign. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns/get.md): Retrieve a specific campaign. - [list_numbers](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns/list-numbers.md): List phone numbers assigned to a campaign. - [list_orders](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns/list-orders.md): List number assignment orders for a campaign. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/campaigns/update.md): Update a campaign. - [Numbers](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/numbers.md): 10DLC number assignment management. - [Orders](https://signalwire.com/docs/server-sdks/reference/python/rest/registry/orders.md): 10DLC number assignment order management. - [RequestOptions](https://signalwire.com/docs/server-sdks/reference/python/rest/request-options.md): Timeout, retry, and cancellation settings for REST requests. - [RestClient](https://signalwire.com/docs/server-sdks/reference/python/rest/client.md): HTTP client for the SignalWire REST API. - [Short Codes](https://signalwire.com/docs/server-sdks/reference/python/rest/short-codes.md): Manage short codes. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/short-codes/get.md): Retrieve a specific short code. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/short-codes/list.md): List short codes in the project. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/short-codes/update.md): Update a short code's configuration. - [SignalWireRestError](https://signalwire.com/docs/server-sdks/reference/python/rest/rest-error.md): Error raised when the REST API returns a non-success response. - [SignalWireRestTransportError](https://signalwire.com/docs/server-sdks/reference/python/rest/rest-transport-error.md): Error raised when a REST request never reaches a response. - [SIP Profile](https://signalwire.com/docs/server-sdks/reference/python/rest/sip-profile.md): Get and update the project SIP profile. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/sip-profile/get.md): Retrieve the current project SIP profile. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/sip-profile/update.md): Update the project SIP profile. - [Verified Callers](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers.md): Manage verified caller IDs. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/create.md): Create a new caller ID entry and initiate verification. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/delete.md): Delete a verified caller ID. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/get.md): Retrieve a specific verified caller ID. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/list.md): List verified caller IDs in the project. - [redial_verification](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/redial-verification.md): Redial the verification call for a pending caller ID. - [submit_verification](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/submit-verification.md): Submit a verification code to complete caller ID verification. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/verified-callers/update.md): Update a verified caller ID. - [Video](https://signalwire.com/docs/server-sdks/reference/python/rest/video.md): Manage video rooms, conferences, sessions, recordings, tokens, and streams. - [VideoConferences](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences.md): Video conference CRUD with token and stream management. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/create.md): Create a new video conference. - [create_stream](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/create-stream.md): Create a new stream for a conference. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/delete.md): Delete a video conference. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/get.md): Retrieve a single video conference. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/list.md): List video conferences. - [list_conference_tokens](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/list-conference-tokens.md): List tokens associated with a conference. - [list_streams](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/list-streams.md): List active streams for a conference. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conferences/update.md): Replace a video conference using PUT. - [VideoConferenceTokens](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conference-tokens.md): Retrieve and reset video conference tokens. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conference-tokens/get.md): Retrieve a specific conference token. - [reset](https://signalwire.com/docs/server-sdks/reference/python/rest/video/conference-tokens/reset.md): Reset a conference token, invalidating the current token and generating a new one. - [VideoRoomRecordings](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-recordings.md): Manage video room recordings with event history. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-recordings/delete.md): Delete a room recording. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-recordings/get.md): Retrieve a single room recording. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-recordings/list.md): List video room recordings. - [list_events](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-recordings/list-events.md): List events associated with a recording. - [VideoRooms](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms.md): Video room CRUD operations with stream management. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/create.md): Create a new video room. - [create_stream](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/create-stream.md): Create a new stream for a video room. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/delete.md): Delete a video room. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/get.md): Retrieve a single video room. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/list.md): List video rooms in the project. - [list_streams](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/list-streams.md): List active streams for a video room. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/video/rooms/update.md): Replace a video room using PUT. - [VideoRoomSessions](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions.md): Query video room sessions with events, members, and recordings. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions/get.md): Retrieve a single room session. - [list](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions/list.md): List video room sessions. - [list_events](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions/list-events.md): List events that occurred during a room session. - [list_members](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions/list-members.md): List members who joined a room session. - [list_recordings](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-sessions/list-recordings.md): List recordings created during a room session. - [VideoRoomTokens](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-tokens.md): Generate tokens to authorize participants to join video rooms. - [create](https://signalwire.com/docs/server-sdks/reference/python/rest/video/room-tokens/create.md): Create a room token that a participant uses to connect to a video room. - [VideoStreams](https://signalwire.com/docs/server-sdks/reference/python/rest/video/streams.md): Top-level stream management for get, update, and delete. - [delete](https://signalwire.com/docs/server-sdks/reference/python/rest/video/streams/delete.md): Delete a stream. - [get](https://signalwire.com/docs/server-sdks/reference/python/rest/video/streams/get.md): Retrieve a specific stream. - [update](https://signalwire.com/docs/server-sdks/reference/python/rest/video/streams/update.md): Update a stream using PUT. > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # REST Client > HTTP client for SignalWire REST API resource management. [client]: /docs/server-sdks/reference/python/rest/client [phone-numbers]: /docs/server-sdks/reference/python/rest/phone-numbers [fabric]: /docs/server-sdks/reference/python/rest/fabric [calling]: /docs/server-sdks/reference/python/rest/calling [video]: /docs/server-sdks/reference/python/rest/video [datasphere]: /docs/server-sdks/reference/python/rest/datasphere [logs]: /docs/server-sdks/reference/python/rest/logs [registry]: /docs/server-sdks/reference/python/rest/registry [messages]: /docs/server-sdks/reference/python/rest/messages [projects]: /docs/server-sdks/reference/python/rest/projects [paginate]: /docs/server-sdks/reference/python/rest/paginate [request-options]: /docs/server-sdks/reference/python/rest/request-options [transport-error]: /docs/server-sdks/reference/python/rest/rest-transport-error [mfa]: /docs/server-sdks/reference/python/rest/mfa The REST namespace provides a synchronous HTTP client for the SignalWire platform APIs. It organizes every HTTP endpoint into namespaced resource objects with standard CRUD operations, letting you manage phone numbers, fabric resources, call logs, video rooms, datasphere documents, and more from Python. ## Example Search for available phone numbers, purchase one, and assign it to a fabric AI agent resource: ```python from signalwire.rest import RestClient, SignalWireRestError client = RestClient( project="your-project-id", token="your-api-token", host="your-space.signalwire.com", ) # Search for available numbers in area code 512 available = client.phone_numbers.search(areacode="512", max_results=3) for number in available.get("data", []): print(f"{number['number']} - {number.get('region')}") # Purchase the first available number purchased = client.phone_numbers.create(number=available["data"][0]["number"]) print(f"Purchased: {purchased['number']}") # List your AI agent resources response = client.fabric.ai_agents.list() for agent in response.get("data", []): print(f"Agent: {agent['name']} ({agent['id']})") # Query recent voice call logs logs = client.logs.voice.list(page_size=5) for log in logs.get("data", []): print(f"Call from {log.get('from')} to {log.get('to')}") ``` > **Note** > > All three constructor arguments can also be provided via environment variables: > `SIGNALWIRE_PROJECT_ID`, `SIGNALWIRE_API_TOKEN`, and `SIGNALWIRE_SPACE`. > When those are set, you can instantiate with `RestClient()` and no arguments. ## Pagination `list()` returns one page, the server's first response. To walk every item across all pages, call [`paginate()`][paginate] on the same resource. It follows the response's `links.next` until the last page. Most list resources have it; the few that don't return a single page only. ```python for number in client.phone_numbers.paginate(): print(number["number"]) ``` ## Timeouts and retries Pass a [`RequestOptions`][request-options] to the constructor to set a default timeout and retry policy for every request, or to any method's `request_options=` argument to override it for one call. ## Error Handling REST errors raise `SignalWireRestError`. A request that never reaches the server (connection refused, DNS failure, timeout) raises [`SignalWireRestTransportError`][transport-error], a subclass whose `status_code` is `None`, so one `except` clause covers both. The error carries the response headers and the platform `request_id` for support correlation. ```python from signalwire.rest import RestClient, SignalWireRestError client = RestClient() try: client.phone_numbers.get("nonexistent-id") except SignalWireRestError as e: print(f"HTTP {e.status_code}: {e.body}") print(f"URL: {e.method} {e.url}") print(f"Request ID: {e.request_id}") ``` ## Resources #### [RestClient](/docs/server-sdks/reference/python/rest/client) Constructor, authentication, and all namespace properties. #### [Phone Numbers](/docs/server-sdks/reference/python/rest/phone-numbers) Search, purchase, and manage phone numbers. #### [Fabric](/docs/server-sdks/reference/python/rest/fabric) AI agents, SWML scripts, [subscribers](/docs/platform/subscribers), call flows, and tokens. #### [Calling](/docs/server-sdks/reference/python/rest/calling) REST-based call control with 37+ commands. #### [Video](/docs/server-sdks/reference/python/rest/video) Rooms, conferences, sessions, recordings, and streams. #### [Datasphere](/docs/server-sdks/reference/python/rest/datasphere) Document management and semantic search. #### [Logs](/docs/server-sdks/reference/python/rest/logs) Message, voice, fax, and conference log queries. #### [Registry](/docs/server-sdks/reference/python/rest/registry) 10DLC brand and campaign registration. #### [Messages](/docs/server-sdks/reference/python/rest/messages) Send SMS and MMS messages and redact sent message bodies. #### [Projects](/docs/server-sdks/reference/python/rest/projects) Create and manage subprojects and rotate signing keys. #### [MFA](/docs/server-sdks/reference/python/rest/mfa) Multi-factor authentication via SMS and voice.