Skip to main content
useDialin(params?): Object Tracks the dial-in readiness of the current room and the state of incoming caller sessions, and wraps the daily-js startDialIn() method. Accepts optional callbacks for the dial-in events. Readiness is set when a dialin-ready event is received. Incoming callers are tracked per session, keyed by sessionId. State is reset when the local participant leaves the meeting or the call instance is destroyed.
Dial-in requires a paid Daily account with a credit card on file. See the Dial-in and dial-out guide for setup and requirements.

Parameters

Function
Callback for the dialin-ready event.
Function
Callback for the dialin-connected event.
Function
Callback for the dialin-stopped event.
Function
Callback for the dialin-error event.
Function
Callback for the dialin-warning event.

Return value

Returns an object with the following properties:
boolean
true once a dialin-ready event has been received, meaning the room’s SIP endpoint is ready to receive incoming calls.
string
The room’s SIP endpoint. Populated after dialin-ready, from the event’s sipEndpoint. With an older daily-js version, which sends only sipEndPoint, it stays undefined; read sipEndPoint from the event in onDialinReady instead. See sipEndpoint and sipEndPoint.
string
The SIP provider: 'signalwire' or 'daily'. Populated after dialin-ready.
Object
A map of incoming dial-in caller sessions, keyed by sessionId.
Function
Wraps daily-js’s startDialIn() method.

Example

See also