Registry / communication / sendbird-calls

sendbird-calls

library1.10.21jsnpmunverified

SendBird Calls enables real-time voice and video calls between users within a Sendbird application. The current stable version is 1.10.21, with active development. It offers a framework for one-to-one direct calls with features like muting, camera switching, and output device selection. Supports modern WebRTC browsers. Differentiators include integration with the Sendbird platform for user management and notifications.

communication

npm install sendbird-calls

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SENDBIRD-CALLS

sendbird-calls

communicationjavascriptv1.10.21

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

SendBirdCall

✓ import SendBirdCall from 'sendbird-calls'

✗ const SendBirdCall = require('sendbird-calls')

Default import requires TypeScript esModuleInterop true or use import * as SendBirdCall from 'sendbird-calls'

SendBirdCall.init

✓ SendBirdCall.init(APP_ID)

Called on the default import, no separate export

DirectCall

✓ const call = await SendBirdCall.dial({ calleeId: 'user2', isVideoCall: true })

DirectCall interface is returned from dial() and used in event listeners

Shows init, authenticate, connectWebSocket, dial, and event handlers for a voice call.

import SendBirdCall from 'sendbird-calls'; const APP_ID = process.env.SENDBIRD_APP_ID ?? ''; const USER_ID = process.env.SENDBIRD_USER_ID ?? ''; const ACCESS_TOKEN = process.env.SENDBIRD_ACCESS_TOKEN ?? ''; SendBirdCall.init(APP_ID); const authenticateResult = await SendBirdCall.authenticate({ userId: USER_ID, accessToken: ACCESS_TOKEN, }); SendBirdCall.onRinging = (call) => { console.log('Incoming call from', call.caller?.userId); }; await SendBirdCall.connectWebSocket(); // Make a call const call = await SendBirdCall.dial({ calleeId: 'recipientUserId', isVideoCall: false }); call.onEstablished = (call) => { console.log('Call established'); }; call.onEnded = (call) => { console.log('Call ended:', call.endResult); }; // To accept an incoming call, use call.accept() in the onRinging handler. // Media streams are automatically managed.

Debug

Known issues

gotchaTypeScript default import requires esModuleInterop or namespace import import * as SendBirdCall.

fix

Set esModuleInterop: true in tsconfig.json or use import * as SendBirdCall from 'sendbird-calls'

affects: >=1.0.0

gotchaWeSocket connection must be established before dialing; otherwise dial fails.

fix

Call await SendBirdCall.connectWebSocket() after authenticate() and before dial().

affects: >=1.0.0

deprecatedUse of deprecated method SendBirdCall.getOngoingCalls()

fix

Use SendBirdCall.getCalls() instead.

affects: >=1.5.0

gotchaMedia streams are auto-managed; calling getUserMedia directly may conflict.

fix

Let SDK handle media; use localMediaStream and remoteMediaStream from DirectCall.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'sendbird-calls'

Package not installed or path incorrect.

fix

Run npm install sendbird-calls

TypeError: SendBirdCall.init is not a function

Import style mismatch; likely using require() or wrong import.

fix

Use default import: import SendBirdCall from 'sendbird-calls'

SendBirdCall is not authenticated

Authenticate not called before dialing.

fix

Call SendBirdCall.authenticate() with valid userId and accessToken.

Upgrade

Version history

1.10.21latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

14 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/sendbird/sendbird-calls-javascript ↗

packagesendbird-calls ↗

homepagehttps://sendbird.com ↗