> 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 API ## Docs - [Authorization](https://signalwire.com/docs/compatibility-api/authorization.md) - [Error codes](https://signalwire.com/docs/compatibility-api/rest/error-codes.md) - [Paging](https://signalwire.com/docs/compatibility-api/rest/paging.md) - [REST client SDKs](https://signalwire.com/docs/compatibility-api/rest/client-sdks.md) ## API Docs - Compatibility REST API > Calls > Webhooks [Voice status callback](https://signalwire.com/docs/compatibility-api/rest/calls/webhooks/voice-status-callback.md) - Compatibility REST API > Calls [List all Calls](https://signalwire.com/docs/compatibility-api/rest/calls/list-all-calls.md) - Compatibility REST API > Calls [Create a Call](https://signalwire.com/docs/compatibility-api/rest/calls/create-a-call.md) - Compatibility REST API > Calls [Retrieve a Call](https://signalwire.com/docs/compatibility-api/rest/calls/retrieve-a-call.md) - Compatibility REST API > Calls [Update a Call](https://signalwire.com/docs/compatibility-api/rest/calls/update-a-call.md) - Compatibility REST API > Calls [Delete a Call](https://signalwire.com/docs/compatibility-api/rest/calls/delete-a-call.md) - Compatibility REST API > Recordings > Webhooks [Recording status callback](https://signalwire.com/docs/compatibility-api/rest/recordings/webhooks/recording-status-callback.md) - Compatibility REST API > Recordings [Create a Recording](https://signalwire.com/docs/compatibility-api/rest/recordings/create-recording.md) - Compatibility REST API > Recordings [Update a Recording](https://signalwire.com/docs/compatibility-api/rest/recordings/update-recording.md) - Compatibility REST API > Recordings [List all Recordings](https://signalwire.com/docs/compatibility-api/rest/recordings/list-recordings.md) - Compatibility REST API > Recordings [Retrieve a Recording](https://signalwire.com/docs/compatibility-api/rest/recordings/retrieve-recording.md) - Compatibility REST API > Recordings [Delete a Recording.](https://signalwire.com/docs/compatibility-api/rest/recordings/delete-recording.md) - Compatibility REST API > Messages > Webhooks [SMS status callback](https://signalwire.com/docs/compatibility-api/rest/messages/webhooks/sms-status-callback.md) - Compatibility REST API > Messages [List all Messages](https://signalwire.com/docs/compatibility-api/rest/messages/list-messages.md) - Compatibility REST API > Messages [Create a Message](https://signalwire.com/docs/compatibility-api/rest/messages/create-message.md) - Compatibility REST API > Messages [Retrieve a Message](https://signalwire.com/docs/compatibility-api/rest/messages/retrieve-message.md) - Compatibility REST API > Messages [Update a Message](https://signalwire.com/docs/compatibility-api/rest/messages/update-message.md) - Compatibility REST API > Messages [Delete a Message](https://signalwire.com/docs/compatibility-api/rest/messages/delete-message.md) - Compatibility REST API > Incoming Phone Numbers > Webhooks [Incoming call status callback](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/webhooks/incoming-call-status-callback.md) - Compatibility REST API > Incoming Phone Numbers [List all Incoming Phone Numbers](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/list-incoming-phone-numbers.md) - Compatibility REST API > Incoming Phone Numbers [Create an Incoming Phone Number](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/create-incoming-phone-number.md) - Compatibility REST API > Incoming Phone Numbers [Retrieve an incoming phone number](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/retrieve-incoming-phone-number.md) - Compatibility REST API > Incoming Phone Numbers [Update an incoming phone number](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/update-incoming-phone-number.md) - Compatibility REST API > Incoming Phone Numbers [Delete an incoming phone number](https://signalwire.com/docs/compatibility-api/rest/incoming-phone-numbers/delete-incoming-phone-number.md) - Compatibility REST API > Recording Transcriptions > Webhooks [Transcription status callback](https://signalwire.com/docs/compatibility-api/rest/recording-transcriptions/webhooks/transcription-status-callback.md) - Compatibility REST API > Recording Transcriptions [List all Transcriptions](https://signalwire.com/docs/compatibility-api/rest/recording-transcriptions/list-transcriptions.md) - Compatibility REST API > Recording Transcriptions [Retrieve a Transcription](https://signalwire.com/docs/compatibility-api/rest/recording-transcriptions/retrieve-transcription.md) - Compatibility REST API > Recording Transcriptions [Delete a Recording Transcription](https://signalwire.com/docs/compatibility-api/rest/recording-transcriptions/delete-transcription.md) - Compatibility REST API > Accounts [List Accounts](https://signalwire.com/docs/compatibility-api/rest/accounts/list-accounts.md) - Compatibility REST API > Accounts [Create Subprojects](https://signalwire.com/docs/compatibility-api/rest/accounts/create-subprojects.md) - Compatibility REST API > Accounts [Find an Account by ID](https://signalwire.com/docs/compatibility-api/rest/accounts/get-account.md) - Compatibility REST API > Accounts [Update an Account](https://signalwire.com/docs/compatibility-api/rest/accounts/update-account.md) - Compatibility REST API > Applications [List Applications](https://signalwire.com/docs/compatibility-api/rest/applications/list-applications.md) - Compatibility REST API > Applications [Create an Application](https://signalwire.com/docs/compatibility-api/rest/applications/create-application.md) - Compatibility REST API > Applications [Find an Application by ID](https://signalwire.com/docs/compatibility-api/rest/applications/get-application.md) - Compatibility REST API > Applications [Update an Application](https://signalwire.com/docs/compatibility-api/rest/applications/update-application.md) - Compatibility REST API > Applications [Delete an Application](https://signalwire.com/docs/compatibility-api/rest/applications/delete-application.md) - Compatibility REST API > Available Phone Numbers [List of AvailablePhoneNumber resources](https://signalwire.com/docs/compatibility-api/rest/available-phone-numbers/list-available-phone-number-resources.md) - Compatibility REST API > Available Phone Numbers [List of AvailablePhoneNumber resources by country](https://signalwire.com/docs/compatibility-api/rest/available-phone-numbers/list-available-phone-number-resources-by-country.md) - Compatibility REST API > Available Phone Numbers [Search for available phone numbers that match your criteria.](https://signalwire.com/docs/compatibility-api/rest/available-phone-numbers/search-local-available-phone-numbers.md) - Compatibility REST API > Available Phone Numbers [Find toll-free numbers](https://signalwire.com/docs/compatibility-api/rest/available-phone-numbers/search-toll-free-available-phone-numbers.md) - Compatibility REST API > Streams [Create a Stream](https://signalwire.com/docs/compatibility-api/rest/streams/create-stream.md) - Compatibility REST API > Streams [Stop a Stream](https://signalwire.com/docs/compatibility-api/rest/streams/update-stream.md) - Compatibility REST API > Conferences [List All Conferences](https://signalwire.com/docs/compatibility-api/rest/conferences/list-all-conferences.md) - Compatibility REST API > Conferences [Retrieve a Conference](https://signalwire.com/docs/compatibility-api/rest/conferences/retrieve-conference.md) - Compatibility REST API > Conferences [Update Conference](https://signalwire.com/docs/compatibility-api/rest/conferences/update-conference.md) - Compatibility REST API > Conference Participants [List all active Participants](https://signalwire.com/docs/compatibility-api/rest/conference-participants/list-all-participants.md) - Compatibility REST API > Conference Participants [Retrieve a Participant](https://signalwire.com/docs/compatibility-api/rest/conference-participants/retrieve-participant.md) - Compatibility REST API > Conference Participants [Update a Participant](https://signalwire.com/docs/compatibility-api/rest/conference-participants/update-participant.md) - Compatibility REST API > Conference Participants [Delete a Participant](https://signalwire.com/docs/compatibility-api/rest/conference-participants/delete-participant.md) - Compatibility REST API > Conference Recordings [List Conference Recordings](https://signalwire.com/docs/compatibility-api/rest/conference-recordings/list-conference-recordings.md) - Compatibility REST API > Conference Recordings [Get a Conference Recording](https://signalwire.com/docs/compatibility-api/rest/conference-recordings/get-conference-recording.md) - Compatibility REST API > Conference Recordings [Update a Conference Recording](https://signalwire.com/docs/compatibility-api/rest/conference-recordings/update-conference-recording.md) - Compatibility REST API > Conference Recordings [Delete a Conference Recording](https://signalwire.com/docs/compatibility-api/rest/conference-recordings/delete-conference-recording.md) - Compatibility REST API > Conference Streams [Create a Conference Stream](https://signalwire.com/docs/compatibility-api/rest/conference-streams/create-conference-stream.md) - Compatibility REST API > Conference Streams [Update Conference Stream](https://signalwire.com/docs/compatibility-api/rest/conference-streams/update-conference-stream.md) - Compatibility REST API > Faxes [List all Faxes](https://signalwire.com/docs/compatibility-api/rest/faxes/list-all-faxes.md) - Compatibility REST API > Faxes [Send a Fax](https://signalwire.com/docs/compatibility-api/rest/faxes/send-fax.md) - Compatibility REST API > Faxes [Retrieve a Fax](https://signalwire.com/docs/compatibility-api/rest/faxes/retrieve-fax.md) - Compatibility REST API > Faxes [Update a Fax](https://signalwire.com/docs/compatibility-api/rest/faxes/update-fax.md) - Compatibility REST API > Faxes [Delete a Fax](https://signalwire.com/docs/compatibility-api/rest/faxes/delete-fax.md) - Compatibility REST API > Fax Media [List Fax Media](https://signalwire.com/docs/compatibility-api/rest/fax-media/list-all-fax-media.md) - Compatibility REST API > Fax Media [Retrieve Fax Media](https://signalwire.com/docs/compatibility-api/rest/fax-media/retrieve-medias.md) - Compatibility REST API > Fax Media [Delete Fax Media](https://signalwire.com/docs/compatibility-api/rest/fax-media/delete-fax-media.md) - Compatibility REST API > Imported Phone Numbers [Import a Phone Number](https://signalwire.com/docs/compatibility-api/rest/imported-phone-numbers/create-imported-phone-number.md) - Compatibility REST API > Cxml Scripts [List All cXML Scripts](https://signalwire.com/docs/compatibility-api/rest/cxml-scripts/list-cxml-scripts.md) - Compatibility REST API > Cxml Scripts [Create a cXML Script](https://signalwire.com/docs/compatibility-api/rest/cxml-scripts/create-cxml-script.md) - Compatibility REST API > Cxml Scripts [Retrieve a cXML Script](https://signalwire.com/docs/compatibility-api/rest/cxml-scripts/retrieve-cxml-script.md) - Compatibility REST API > Cxml Scripts [Update a cXML Script](https://signalwire.com/docs/compatibility-api/rest/cxml-scripts/update-cxml-script.md) - Compatibility REST API > Cxml Scripts [Delete a cXML Script](https://signalwire.com/docs/compatibility-api/rest/cxml-scripts/delete-cxml-script.md) - Compatibility REST API > Message Media [List Message Media](https://signalwire.com/docs/compatibility-api/rest/message-media/list-media.md) - Compatibility REST API > Message Media [Retrieve Message Media](https://signalwire.com/docs/compatibility-api/rest/message-media/retrieve-media.md) - Compatibility REST API > Message Media [Delete Message Media](https://signalwire.com/docs/compatibility-api/rest/message-media/delete-message-media.md) - Compatibility REST API > Queues [List All Queues](https://signalwire.com/docs/compatibility-api/rest/queues/list-queues.md) - Compatibility REST API > Queues [Create a Queue](https://signalwire.com/docs/compatibility-api/rest/queues/create-queue.md) - Compatibility REST API > Queues [Retrieve a Queue](https://signalwire.com/docs/compatibility-api/rest/queues/retrieve-queue.md) - Compatibility REST API > Queues [Update a Queue](https://signalwire.com/docs/compatibility-api/rest/queues/update-queue.md) - Compatibility REST API > Queues [Delete a Queue](https://signalwire.com/docs/compatibility-api/rest/queues/delete-queue.md) - Compatibility REST API > Queue Members [List All Queue Members](https://signalwire.com/docs/compatibility-api/rest/queue-members/list-all-queue-members.md) - Compatibility REST API > Queue Members [Retrieve a Queue Member](https://signalwire.com/docs/compatibility-api/rest/queue-members/retrieve-queue-member.md) - Compatibility REST API > Queue Members [Update a Queue Member](https://signalwire.com/docs/compatibility-api/rest/queue-members/update-queue-member.md) - Compatibility REST API > Tokens [Generate a new API Token](https://signalwire.com/docs/compatibility-api/rest/tokens/create-token.md) - Compatibility REST API > Tokens [Delete an API Token](https://signalwire.com/docs/compatibility-api/rest/tokens/delete-token.md) - Compatibility REST API > Tokens [Update an API Token](https://signalwire.com/docs/compatibility-api/rest/tokens/update-token.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://signalwire.com/docs/compatibility-api/rest/openapi.json) - [OpenAPI YAML](https://signalwire.com/docs/compatibility-api/rest/openapi.yaml) > **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. # Overview SignalWire's REST API allows you to manage and modify calls and messages made to or from your SignalWire phone numbers. You also have the ability to retrieve and update your account information, retrieve your entire history of calls, messages, transcriptions, media and more. This can all be achieved by sending HTTP requests to the SignalWire REST API. > **The API formerly known as LaML** > > The Compatibility API and cXML were previously known as "LaML". > `laml` still appears in endpoint URLs, and the cXML namespace of the REST Client is still titled `LaML`. > Don't worry, it's all cXML! ## Try it in Postman For developers who prefer working in Postman, we maintain an official Compatibility API collection with pre-built requests for every cXML endpoint, example payloads, and a configurable environment for your SignalWire credentials. It's a fully supported alternative to the API playground built into these docs — useful if Postman is already part of your workflow. ### Open the collection in Postman Click **Run in Postman** to fork the collection into your own Postman workspace. [Open the SignalWire Compatibility API collection in Postman](https://god.gw.postman.com/run-collection/16445495-16e14ee0-3762-42ac-9f4d-a61401e05209?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D16445495-16e14ee0-3762-42ac-9f4d-a61401e05209%26entityType%3Dcollection%26workspaceId%3D4f34e511-485e-4462-a432-20fbc2d1db33). ### Set your credentials Open the collection's **Variables** tab and fill in the three values from the [API pane](https://my.signalwire.com?page=credentials) of your SignalWire Dashboard: | Variable | Value | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | `space_name` | Your Space subdomain (e.g., `example`) | | `project_id` | Your **Project ID** (referred to as **AccountSid** in the Compatibility API — see [AccountSid vs ProjectID](#accountsid-vs-projectid) below) | | `api_token` | Your **Auth Token** | ### Send your first request Open any endpoint — try **Calls** to list the calls on your project, or **Messages** to send a test SMS — and hit **Send**. The collection uses your credentials automatically. ## Base URL Each Space on SignalWire gets its own subdomain and each Space will have its own URLs for accessing the REST API. All calls in the provided examples use the following as the base URL: `https://example.signalwire.com/api/laml/2010-04-01` However, please note that the actual base URL you will use will differ for each Space, since it will be customized to include your unique Space name. For your own custom URL, replace "example" with your unique subdomain. ## AccountSid vs ProjectID To support seamless migration and compatibility with other popular providers, the SignalWire Compatibility API often refers to the **AccountSid**. The AccountSid is a unique identifier on other providers. On SignalWire, this is known as the **Project ID**. Each project within your Space gets its own, unique Project ID and this is used to authenticate requests on the API. This will be the same value as your Project ID but is set as AccountSid for compatibility. On SignalWire's API, the AccountSid and Project ID are the same thing.