Public Switched Telephone Network (PSTN)

The Video SDK call out feature allows users to join Video SDK sessions completely over the phone or use their phone as the audio connection to the session while viewing the Video on Web. This is useful when:

  • You do not have a microphone or speaker on your computer.
  • You do not have an iOS or Android smartphone.
  • You cannot connect to a network for a video session with computer audio (VoIP).

See Customize audio conferencing for details.

Prerequisites

Make a call

Use zoom.phoneHelper.inviteByPhone(countryCode: string, phoneNumber: string, name: string) to make a call.

  • Provide the name if the user will join completely by phone.
  • If the user is already connected to the session on the web, but wants to use their phone for the audio portion, the name will default to the name provided in the zoom.joinSession() function.
zoom.phoneHelper.inviteByPhone(
    "<Country Code>",
    "<Phone Number>",
    "<Display Name>",
);

Hang up a call

Use zoom.phoneHelper.cancelInviteByPhone() to hang up a call.

zoom.phoneHelper.cancelInviteByPhone();

Receive events

Use the onInviteByPhoneStatus event listener to find out about the status of the call, for example, ringing, accepted, hangup, etc.

const inviteByPhoneStatusListener = zoom.addListener(
  EventType.onInviteByPhoneStatus,
  (params: {status: PhoneStatus; reason: PhoneFailedReason}) => {
    console.log(params);
    console.log('status: ' + params.status + ', reason: ' + params.reason);
  }
);