anchorDial Into or Out of a Meeting

A user can trigger the dial-in or dial-out using the Meeting object's usePhoneAudio method and passing an optional phone number as a String:

await meeting.usePhoneAudio(phoneNumber);

When a phone number is provided, the SDK provisions a device for dial out functionality, and initiates a call to the specified phone number. When a user answers the call, the meeting's audio input and output are connected to the phone device. In the absence of a phone number, the SDK defaults to provisioning a device for the dial in functionality.

The SDK is designed to provision only one device each for either dialing in or out. Once a device is provisioned, subsequent calls to the usePhoneAudio() method do not result in additional provisioning.

anchorDial-In Attendee Information

To dial-in to the meeting, the user has to know the following dial-in information:

• Dial-In number (US toll by default).
• Global call-in numbers (for non-US attendees).
• Access Code.
• Attendee ID.

The first three can be easily obtained after calling the meeting.usePhoneAudio() API as follows:

await meeting.usePhoneAudio();
const accessCode = meeting.meetingInfo.audio.accessCode;
const globalCallInWebUrl = meeting.meetingInfo.audio.globalCallinNumberWebLink;
const tollCallInLabel = meeting.meetingInfo.audio.tollCallInLabel;
const tollNum = meeting.meetingInfo.audio.tollNum;

However, to obtain the attendee ID, the easiest way is to listen to the following event:

meeting.on(
    "meeting:self:phoneAudioUpdate",
    (payload) => {
        console.log(payload)
        // payload.dialIn = {
        //     "status": "JOINED",
        //     "attendeeId": "123456"
        // }
    }
);
await meeting.usePhoneAudio();

Here's a full code that can be useful:

const dialInInfo = {};
meeting.on(
    "meeting:self:phoneAudioUpdate",
    (payload) => dialInInfo.attendeeId = payload?.dialIn?.attendeeId
);
await meeting.usePhoneAudio();
dialInInfo.accessCode = meeting.meetingInfo.audio.accessCode;
dialInInfo.globalCallInWebUrl = meeting.meetingInfo.audio.globalCallinNumberWebLink;
dialInInfo.tollCallInLabel = meeting.meetingInfo.audio.tollCallInLabel;
dialInInfo.tollNum = meeting.meetingInfo.audio.tollNum;

Once you have this information, you can display it to your user for them to dial-in to the meeting via a PSTN call.

After the usePhoneAudio() method successfully completes, the user is connected to the meeting through both the browser and the dial-in/dial-out device. Consequently, the next step involves updating the Meeting object to disable sending and receiving audio via the browser.

SDK 3.x:

For 3.x SDKs to disable sending and receiving audio via the browser, send the flag audioEnabled: false in the Meeting object's updateMedia method:

await meeting.updateMedia({
  audioEnabled: false
});

updateMedia Options

SDK 2.x

For the 2.x SDK to disable sending and receiving audio via the browser, send the flags sendAudio: false and receiveAudio: false as well as the Stream object to the Meeting object's updateAudio method:

await meeting.updateAudio({
  sendAudio: false,
  receiveAudio: false,
  stream
});

Options

anchorDisconnect Dial In or Out Calls

Disconnect dial-in or dial-out calls using the Meeting object's disconnectPhoneAudio method:

await meeting.disconnectPhoneAudio();

anchorRe-enable Browser Audio

If, after disconnecting the phone audio for a meeting, you want to enable computer audio (assuming it was not already enabled or was disconnected during the use of phone audio), depending on the SDK version:

SDK 3.x

For 3.x SDKs to enable sending and receiving audio via the browser, send the flag audioEnabled: true in the Meeting object's updateMedia method:

await meeting.updateMedia({
  audioEnabled: true
});

SDK 2.x

For the 2.x SDK to enable sending and receiving audio via the browser, send the flags sendAudio: true and receiveAudio: true as well as the Stream object to the Meeting object's updateAudio method:

await meeting.updateAudio({
  sendAudio: true,
  receiveAudio: true,
  stream
});