Skip to main content

Compatibility API

This API may look very similar to other, existing APIs you've used before — on purpose! The SignalWire Compatible REST API is designed to make migrating your existing phone or messaging application easy and quick, while giving you access to our next generation APIs and endpoints to help you take your application to the next level.

Use our compatible REST APIs to manage resources in your SignalWire space.
Compatible language that you can use to define how your phone numbers react during calls or text messages.
Access the REST APIs through a compatible SDK available in most major languages.

Find documentation for the deprecated @signalwire/node LaML SDK here.

Examples

Here are a couple of ways you can use the XML and the REST Compatibility APIs.

XML

Answering calls with Text-To-Speech and connecting to another number:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
<!-- Say and Dial are examples of Verbs -->
<Say>Connecting you...</Say>
<Dial>
<!-- Number is an example of a Dial Noun -->
<Number>+15551234567</Number>
</Dial>
</Response>

REST

Starting a new call:

curl --request POST \
--url https://example.signalwire.com/api/laml/2010-04-01/Accounts/my-project-id/Calls \
--header 'Accept: application/json' \
--header 'Authorization: Basic ZGVtbzpkZW1v' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'From=+15551234567' \
--data 'To=+15553456789'