Calls Client API

acceptCallCopy Anchor Link

Prepare media and accept this incoming call.

Signature client.acceptCall(call: { generation: string; id: string; sessionId: string }, media?: { camera?: any; microphone?: any; onMediaFailure?: "end" \| "keep-open"; speaker?: any }): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.acceptCall({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

clearCallAudioCopy Anchor Link

Discard queued outgoing audio.

Signature client.clearCallAudio(call: { generation: string; id: string; sessionId: string }): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.clearCallAudio({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

endCallCopy Anchor Link

Request hangup for this call.

Signature client.endCall(call: { generation: string; id: string; sessionId: string }): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.endCall({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

getActiveCallCopy Anchor Link

Get the current call snapshot. SDK clients hydrate its bound methods.

Signature client.getActiveCall(): Promise<{ id: string; sessionId: string; generation: string; peer: string; state: string; direction: "incoming" \| "outgoing"; video: boolean; terminal: boolean; observedAt: number \| "Infinity" \| "-Infinity" \| "NaN"; endReason?: { code: string; message: string; source: "local" \| "media" \| "license" \| "session" \| "whatsapp" } \| null; media?: { state: "attached" \| "ended"; reason?: string \| null } \| null>

UsageCopy Anchor Link

const result = await client.getActiveCall();

ParametersCopy Anchor Link

This method does not define input parameters.

ReturnsCopy Anchor Link

Resolves to { id: string; sessionId: string; generation: string; peer: string; state: string; direction: "incoming" \| "outgoing"; video: boolean; terminal: boolean; observedAt: number \| "Infinity" \| "-Infinity" \| "NaN"; endReason?: { code: string; message: string; source: "local" \| "media" \| "license" \| "session" \| "whatsapp" } \| null; media?: { state: "attached" \| "ended"; reason?: string \| null } \| null. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<Call \| null>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

muteCallCopy Anchor Link

Mute or unmute the microphone without ending reception.

Signature client.muteCall(call: { generation: string; id: string; sessionId: string }, muted: boolean): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.muteCall({}, true);

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

observeCallAudioCopy Anchor Link

Attach an isolated receive-only audio sink. Its failure does not interrupt the call owner.

Signature client.observeCallAudio(call: { generation: string; id: string; sessionId: string }, speaker?: unknown): Promise<{ ok: true; status: "requested"; observerId: string } \| { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.observeCallAudio({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; observerId: string } \| { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult & { observerId?: string }>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

rejectCallCopy Anchor Link

Reject this call with native state confirmation.

Signature client.rejectCall(call: { generation: string; id: string; sessionId: string }): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.rejectCall({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

setCallMediaCopy Anchor Link

Prepare a replacement before releasing the working media.

Signature client.setCallMedia(call: { generation: string; id: string; sessionId: string }, media?: { camera?: any; microphone?: any; onMediaFailure?: "end" \| "keep-open"; speaker?: any }): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.setCallMedia({});

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

startCallCopy Anchor Link

Prepare media and place an outgoing audio or video call.

Signature client.startCall(to: string, microphone?: unknown, speaker?: unknown, camera?: unknown): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.startCall("to");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.

stopCallAudioObserverCopy Anchor Link

Stop an audio observer and finalize its sink.

Signature client.stopCallAudioObserver(call: { generation: string; id: string; sessionId: string }, observerId: string): Promise<{ ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string>

UsageCopy Anchor Link

const result = await client.stopCallAudioObserver({}, "observerId");

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Resolves to { ok: true; status: "requested"; callId?: string \| null } \| { ok: false; status: "unavailable" \| "failed" \| "unknown"; reason: { code: string; message: string; status: number \| "Infinity" \| "-Infinity" \| "NaN" }; callId?: string. A rejected Promise indicates input validation or dispatch failure.

In-process Client resolves to Promise<CallActionResult>. The contract above is for the remote Node.js client; HTTP wraps that result in its data property.