Class: Call

Defined in: models/call.ts:14

Represents a call with reactive state streams.

This class wraps the underlying Telnyx Call object and provides reactive streams for all call state changes, making it easy to integrate with any state management solution.

new Call(_telnyxCall, _callId, _destination, _isIncoming, isReattached, _originalCallerName?, _originalCallerNumber?): Call

Defined in: models/call.ts:23

TelnyxCall

string

string

boolean

boolean = false

string

string

Call

get callId(): string

Defined in: models/call.ts:44

Unique identifier for this call

string

---

get destination(): string

Defined in: models/call.ts:51

The destination number or SIP URI

string

---

get isIncoming(): boolean

Defined in: models/call.ts:58

Whether this is an incoming call

boolean

---

get isOutgoing(): boolean

Defined in: models/call.ts:65

Whether this is an outgoing call

boolean

---

get currentState(): TelnyxCallState

Defined in: models/call.ts:72

Current call state (synchronous access)

TelnyxCallState

---

get currentIsMuted(): boolean

Defined in: models/call.ts:79

Current mute state (synchronous access)

boolean

---

get currentIsHeld(): boolean

Defined in: models/call.ts:86

Current hold state (synchronous access)

boolean

---

get currentDuration(): number

Defined in: models/call.ts:93

Current call duration in seconds (synchronous access)

number

---

get inviteCustomHeaders(): object[]

Defined in: models/call.ts:102

Custom headers received from the WebRTC INVITE message. These headers are passed during call initiation and can contain application-specific information. Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".

object[]

---

get answerCustomHeaders(): object[]

Defined in: models/call.ts:111

Custom headers received from the WebRTC ANSWER message. These headers are passed during call acceptance and can contain application-specific information. Format should be [{"name": "X-Header-Name", "value": "Value"}] where header names must start with "X-".

object[]

---

get telnyxCall(): TelnyxCall

Defined in: models/call.ts:119

Internal

Get the underlying Telnyx Call object (for internal use)

TelnyxCall

---

get callState$(): Observable<TelnyxCallState>

Defined in: models/call.ts:126

Observable stream of call state changes

Observable<TelnyxCallState>

---

get isMuted$(): Observable<boolean>

Defined in: models/call.ts:133

Observable stream of mute state changes

Observable<boolean>

---

get isHeld$(): Observable<boolean>

Defined in: models/call.ts:140

Observable stream of hold state changes

Observable<boolean>

---

get duration$(): Observable<number>

Defined in: models/call.ts:147

Observable stream of call duration changes (in seconds)

Observable<number>

---

get canAnswer$(): Observable<boolean>

Defined in: models/call.ts:154

Observable that emits true when the call can be answered

Observable<boolean>

---

get canHangup$(): Observable<boolean>

Defined in: models/call.ts:164

Observable that emits true when the call can be hung up

Observable<boolean>

---

get canHold$(): Observable<boolean>

Defined in: models/call.ts:174

Observable that emits true when the call can be put on hold

Observable<boolean>

---

get canResume$(): Observable<boolean>

Defined in: models/call.ts:184

Observable that emits true when the call can be resumed from hold

Observable<boolean>

answer(customHeaders?): Promise<void>

Defined in: models/call.ts:195

Answer the incoming call

object[]

Optional custom headers to include with the answer

Promise<void>

---

hangup(customHeaders?): Promise<void>

Defined in: models/call.ts:227

Hang up the call

object[]

Optional custom headers to include with the hangup request

Promise<void>

---

hold(): Promise<void>

Defined in: models/call.ts:266

Put the call on hold

Promise<void>

---

resume(): Promise<void>

Defined in: models/call.ts:282

Resume the call from hold

Promise<void>

---

mute(): Promise<void>

Defined in: models/call.ts:298

Mute the call

Promise<void>

---

unmute(): Promise<void>

Defined in: models/call.ts:315

Unmute the call

Promise<void>

---

toggleMute(): Promise<void>

Defined in: models/call.ts:332

Toggle mute state

Promise<void>

---

setConnecting(): void

Defined in: models/call.ts:344

Internal

Set the call to connecting state (used for push notification calls when answered via CallKit)

void

---

dispose(): void

Defined in: models/call.ts:352

Clean up resources when the call is disposed

void