Introduction to the Compatibility API

This API may look very similar to other, existing APIs you've used before — on purpose! The SignalWire Compatibility 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.

THE API FORMERLY KNOWN AS LĀML

The Compatibility API and cXML were previously known as "LāML". 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!

API Reference

Use our cXML REST APIs to manage resources in your SignalWire Space.

cXML Specification

Compatible language that you can use to define how your phone numbers react during calls or text messages.

Client SDKs

Access the cXML REST APIs through a compatible client SDK available in most major languages.

Examples

Here are a couple of ways you can use the XML and the REST cXML 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'