📦

JavaScript SDK

Official JavaScript/Node.js SDK for the BringRings API.

Installation

Terminal
bash
npm install @bringrings/sdk

Initialization

app.js
javascript
import BringRings from '@bringrings/sdk';
const client = new BringRings({
apiKey: process.env.BRINGRINGS_API_KEY
});

Calls

calls.js
javascript
// Initiate a call
const call = await client.calls.initiate({
to: '+1234567890',
agentId: 'agent-uuid',
metadata: { customerId: '123' }
});
// Get call details
const details = await client.calls.get(call.id);
// Get transcript
const transcript = await client.calls.transcript(call.id);

Agents

agents.js
javascript
// List agents
const agents = await client.agents.list();
// Create agent
const agent = await client.agents.create({
name: 'Support Agent',
voice: 'elevenlabs:rachel',
language: 'en-US'
});
// Update agent
await client.agents.update(agent.id, { name: 'New Name' });

Error Handling

errors.js
javascript
import { BringRings, BringRingsError } from '@bringrings/sdk';
try {
await client.calls.initiate({ to: 'invalid' });
} catch (error) {
if (error instanceof BringRingsError) {
console.error('API Error:', error.message);
console.error('Status:', error.status);
console.error('Code:', error.code);
}
}

TypeScript Support

The SDK includes full TypeScript definitions. Types are automatically available when you import the package.