useDialin

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.

string

The SIP/PSTN service provider. Populated after dialin-ready.

Object

A map of incoming dial-in caller sessions, keyed by sessionId.

Show session properties

string

The session ID of the incoming caller.

string

The latest status for the session: 'connected', 'stopped', 'error' or 'warning'.

string

The SIP/PSTN service provider for the session, when reported.

string

The SIP call ID for the session, when reported.

string

The error or warning message, set when status is 'error' or 'warning'.

Function

Wraps daily-js’s startDialIn() method.

Example

import { useDialin } from '@daily-co/daily-react';

export const DialinStatus = () => {
  const { isReady, sipEndpoint, sessions } = useDialin({
    onDialinError: (ev) => console.error('Dial-in error', ev.errorMsg),
  });

  return (
    <div>
      <p>
        Dial-in {isReady ? 'ready' : 'not ready'}
        {sipEndpoint ? ` at ${sipEndpoint}` : ''}
      </p>
      <p>{Object.keys(sessions).length} caller(s) connected</p>
    </div>
  );
};

Components

Hooks

Parameters

Return value

Example

See also

Hooks

Events

Guides

​Parameters

​Return value

​Example

​See also

Hooks

Events

Guides

Parameters

Return value

Example

See also