@ciptex/conference-playback-sdk

Conference Playback SDK

The conference-playback-sdk helper library lets you write Node.js code to make HTTP requests to the Ciptex Conference Playback API.

Do not use Basic Authentication in a front-end application. Doing so can expose your Twilio credentials to end-users as part of the bundled HTML/JavaScript sent to their browser.

Installation

The easiest way to install conference-playback-sdk is from NPM. You can run the command below from your project directory to install the library:

npm install --save @ciptex/conference-playback-sdk@latest

Then in your code:

import { ConferencePlaybackClient } from  "@ciptex/conference-playback-sdk"

Testing your installation

Try Listing Available Plugins like this:

import { ConferencePlaybackClient } from  "@ciptex/conference-playback-sdk"

const  accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; // Your Account SID from www.twilio.com/console
const  authToken = "your_auth_token"; // Your Auth Token from www.twilio.com/console
const  client = new  ConferencePlaybackClient({ accountSid, authToken });

const  main = async () => {
	try {
		await client.audio.play({ 
			url: https://cdn2.melodyloops.com/mp3/preview-more-joy-please.ogg, 
			conferenceId: CIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX, 
			accountSid: accountSid, 
			loop: true, 
			cid: true // This is needed to Send Cookies for Cross Site Requests
		});
	}
	catch (error) {
		console.error(error);
	}
}

main()

It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out How to Set Environment Variables for more information.

Using This Library

Authenticate Client

const  accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const  authToken = "your_auth_token";
const  client = new  ConferencePlaybackClient({ accountSid, authToken });

Stop Playback

import { ConferencePlaybackClient } from  "@ciptex/conference-playback-sdk"

const  accountSid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const  authToken = "your_auth_token";
const  client = new  ConferencePlaybackClient({ accountSid, authToken });

const  main = async () => {
	try {
		await client.audio.stop({ 
			conferenceId: CIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX, 
			accountSid: accountSid, 
		});
	}
	catch (error) {
		console.error(error);
	}
}

main()

Handling Exceptions

If the Conference Playback API returns a 400 or a 500 level HTTP response, the conference-playback-sdk library will throw an error which can be caught. 400-level errors are normal during API operation ("Invalid number", "Cannot deliver SMS to that number", for example) and should be handled appropriately.

More Documentation

Once you're up and running with the conference-playback-sdk library, you'll find code samples using the latest version in our REST API docs