API Reference — expo-callkit-telecom

Sessions

Name	Description
getActiveCallSession	Gets the currently active call session, if any.
addCallSessionAddedListener	Subscribes to call session added events.
addCallSessionUpdatedListener	Subscribes to call session updated events.
addCallSessionRemovedListener	Subscribes to call session removed events.
CallSession	Active call as tracked by the module.
CallOptions	Per-call options set at session start.
CallSessionOrigin	Where a call session originated.
CallParticipant	Identity for a remote party on a call.
CallSessionStatus	Call session status representing the lifecycle of a call.
CallSessionAddedEvent	Fired when a new CallSession is created (outgoing request or incoming report).
CallSessionUpdatedEvent	Fired when an existing CallSession's state changes (status, mute, hold, etc.).
CallSessionRemovedEvent	Fired when a CallSession is removed after the call has ended and been cleaned up.

Requests

Function	Description
startOutgoingCall	Starts an outgoing call to the specified recipient.
answerCall	Answers an incoming call.
endCall	Ends an active call.
setMuted	Changes the mute state of a call.
setHeld	Changes the hold state of a call.
playDTMF	Plays DTMF tones during a call.

Reporters

Function	Description
reportIncomingCall	Reports an incoming call to the system.
reportOutgoingCallConnected	Reports that an outgoing call's media connection is established.
reportCallEnded	Reports that a call has ended for an external reason.
reportVideo	Reports a video state change for a call.

Fulfillers

Function	Description
fulfillIncomingCallConnected	Fulfills an incoming call by confirming the media connection is established.
failIncomingCallConnected	Fails a pending incoming call connection request.

Call Events

Name	Description
addCallIntentReceivedListener	Subscribes to call intent received events.
addOutgoingCallStartedListener	Subscribes to outgoing call started events.
addIncomingCallReportedListener	Subscribes to incoming call reported events.
addCallAnsweredListener	Subscribes to call answered events.
addCallEndedListener	Subscribes to call ended events.
addReportedCallEndedListener	Subscribes to reported call ended events.
addSetMutedActionListener	Subscribes to set muted action events.
addVideoChangedListener	Subscribes to video state change events.
addSetHeldActionListener	Subscribes to set held action events.
addDTMFListener	Subscribes to DTMF events.
CallActionEvent	Base shape for any event carrying a CallSession.id.
OutgoingCallStartedEvent	Fired after startOutgoingCall, once the OS has accepted the call request.
IncomingCallReportedEvent	Fired after reportIncomingCall, once the OS has accepted the incoming-call report.
CallAnsweredEvent	Fired when the user answers an incoming call from the system UI.
CallEndedEvent	Fired when the user ends a call from the system UI, or the OS ends the call for any reason.
CallEndedReason	Reason a call was ended, reported on CallReportedEnded.
CallReportedEnded	Fired when the app calls reportCallEnded to inform the OS the call has ended externally (e.g. remote hang-up).
SetMutedActionEvent	Fired when the system requests a mute-state change (e.g. user pressed the mute button in the CallKit UI). Apply the change to your media connection.
VideoChangedEvent	Fired when video state changes on a call.
SetHeldActionEvent	Fired when the system requests a hold-state change. Apply the change to your media connection.
DTMFEvent	Fired when the system requests DTMF tones be played on the call.
CallIntentHandleType	Kind of handle attached to a call intent (Recents tap, Siri).
CallIntentReceivedEvent	Fired when the OS routes a "start call" intent to the app — e.g. the user tapped a Recents entry or said "call Jane" to Siri.

Audio

Name	Description
getAudioSession	Gets the current audio session state.
setRTCAudioSessionConfiguration	Sets the RTC audio session configuration (iOS only).
prepareAudioSessionForCall	Prepares the audio session for an upcoming call.
restoreAudioSession	Restores the audio session to its pre-call configuration.
setAudioSessionPortOverride	Sets the audio session port override.
AudioSession	Snapshot of the current audio session, including activation state, route, and (on iOS) the WebRTC RTCAudioSession coordination flags.
AudioRoute	Currently-selected audio inputs and outputs.
AudioPort	A single audio input or output (earpiece, speaker, headphones, Bluetooth device, etc.).
AudioOutputPortType	Cross-platform audio output port type identifiers. Both iOS and Android map their native audio device types to these shared values.

Audio Events

Name	Description
addAudioSessionActivatedListener	Subscribes to audio session activated events.
addAudioSessionDeactivatedListener	Subscribes to audio session deactivated events.
addAudioRouteChangedListener	Subscribes to audio route changed events.
AudioSessionCallInfo	Brief summary of one call associated with an audio-session activation event.
AudioSessionActivatedEvent	Fired when the system activates the audio session for a call.
AudioSessionDeactivatedEvent	Fired when the system deactivates the audio session after a call.
AudioRouteChangedEvent	Fired when the active audio route changes (e.g. AirPods connected, speaker toggled).

Capture

Name	Description
getCaptureSession	Gets the current capture session state.
CaptureSession	Snapshot of camera-related state, including permission and (on iOS 16+) multitasking-camera availability.

VoIP Push

Name	Description
registerVoIPPush	Registers for VoIP push notifications.
getVoIPPushToken	Gets the current VoIP push token and its type.
addVoIPPushTokenUpdatedListener	Subscribes to VoIP token updated events.
PushTokenType	Type of VoIP push token reported by getVoIPPushToken.
IncomingCallEvent	Payload describing one incoming call.
VoIPPushToken	A VoIP push token bundled with its transport type.
VoIPPushTokenUpdatedEvent	Fired when the VoIP push token is received, refreshed, or invalidated.

Hooks

Function	Description
useVoIPPushToken	Hook that returns the current VoIP push token and subscribes to updates.

Permissions

Type Alias	Description
PermissionStatus	Permission status for microphone and camera, reported on AudioSession and CaptureSession.

Core

Interface	Description
NativeEventMeta	Metadata attached to every native event.
NativeEvent	Base shape extended by every native event — carries a NativeEventMeta envelope.