📦
JavaScript SDK
Official JavaScript/Node.js SDK for the BringRings API.
Installation
Terminal
npm install @bringrings/sdkInitialization
app.js
import BringRings from '@bringrings/sdk';const client = new BringRings({ apiKey: process.env.BRINGRINGS_API_KEY});Calls
calls.js
// Initiate a callconst call = await client.calls.initiate({ to: '+1234567890', agentId: 'agent-uuid', metadata: { customerId: '123' }});// Get call detailsconst details = await client.calls.get(call.id);// Get transcriptconst transcript = await client.calls.transcript(call.id);Agents
agents.js
// List agentsconst agents = await client.agents.list();// Create agentconst agent = await client.agents.create({ name: 'Support Agent', voice: 'elevenlabs:rachel', language: 'en-US'});// Update agentawait client.agents.update(agent.id, { name: 'New Name' });Error Handling
errors.js
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.