Compatibility Libraries and SDKs

SignalWire has clients in a number of different languages that make using the SignalWire Compatibility API possible with your existing application. They are also built to make migrating from other service providers to SignalWire quick and easy.

The Compatibility SDK has two primary components:

• REST Client: The REST client is used to make API calls for initiating outbound calls and messages, managing phone numbers, retrieving call logs, and other operations. See the REST API documentation for the complete API reference.

• cXML Builders: The cXML builders do not make API calls directly. Instead, they are helper libraries that enable you to easily generate cXML responses within your language of choice. The SDK provides three response builders for the different channel types:

  • VoiceResponse — Build XML for handling voice calls
  • MessagingResponse — Build XML for handling SMS/MMS messages
  • FaxResponse — Build XML for handling faxes

  See the cXML Specification for technical reference on the XML format and available verbs.

Getting started with the SDKs

1
npm install @signalwire/compatibility-api

1
const { RestClient } = require("@signalwire/compatibility-api");
2
3
const client = RestClient(
4
"your-project",
5
"your-token",
6
{ signalwireSpaceUrl: "example.signalwire.com" }
7
);
8
9
// You can then use client to make calls, send messages, and more.

1
  SIGNALWIRE_SPACE_URL=example.signalwire.com

1
  const { RestClient } = require("@signalwire/compatibility-api");
2
3
  const client = RestClient(
4
  "your-project",
5
  "your-token"
6
  );

1
// Replace these lines:
2
const twilio = require('twilio')
3
const response = new twilio.twiml.VoiceResponse()
4
5
// With:
6
const { RestClient } = require('@signalwire/compatibility-api')
7
const response = new RestClient.LaML.VoiceResponse()
8
9
// Now use response like you did before!
10
response.say('Hey, welcome to SignalWire!')