LogoLogo
WherebyStatusCommunity
  • 📹Whereby 101
    • Create Your Video Experience
      • Get started in 3 steps
      • Embedding Whereby in a web app
        • Using Whereby's Web Component & Pre-built UI
          • Script Tags
          • With Low Code
            • Embedding in Squarespace or Wordpress
            • No code video conferencing in Bubble
        • Using Whereby's Browser SDK with React Hooks for a fully custom UI
      • Embedding Whereby in a mobile app
        • Embedding Whereby in iOS
          • Using Whereby's Native iOS SDK
        • Embedding Whereby in Android
          • Using Whereby's Native SDK
        • Using Flutter
        • Using React Native
      • Github SDK Examples
      • Meeting scheduling with Cronofy
    • Generating Room URLs
      • Name prefixes
      • Using “Create a room”
      • Using Postman
    • Customize Your Video Experience
      • During room creation
      • Using Attributes/URL Params
      • Global preferences
      • Branding elements
      • Dial-In
      • File sharing
      • Breakout Groups with Embedded
      • Waiting Rooms
    • User roles & Meeting Permissions
    • FAQ
      • Accessibility
      • Whereby Words
      • Firewall & Security
      • HIPAA compliant setup
      • Allowed Domains & Localhost
      • Whereby Embedded Feature Comparison
  • 🔍Meeting Content & Quality
    • Recording
      • Cloud Recording
      • Local Recording
    • Transcribing
      • Session Transcription
      • Recording Transcription
    • Live Captions
    • Session summaries
    • Live streaming RTMP
    • Quality Insights
      • Real-time troubleshooting
      • Using the Insights dashboard
      • Improving call quality
      • Tracking room events with Webhooks
  • 🤷End User
    • End User Support Guides
      • Supported Browsers & Devices
      • Screen Sharing Setup & Usage
      • Using Breakout Groups
      • Troubleshooting & Basics
  • đźššDeveloper Guides
    • Quickly deploy Whereby to your domain
    • Tracking Customer Usage
    • Migrating from Twilio
      • Twilio JS SDK Quick Migration
      • Twilio JS SDK Direct Migration
  • 🖥️Reference
    • REST API Reference
      • /meetings
      • /insights
      • /recordings
      • /transcriptions
      • /summaries
      • /rooms
    • Web Component Reference
    • React Hooks Reference
      • Quick Start
        • Getting started with the Browser SDK
      • Guides & Tutorials
        • Migrate from version 2.x to 3
        • Grid logic
        • Custom Video Tiles with React
        • Usage with Next.js
        • How to customize the toolbar
      • API Reference
        • WherebyProvider
        • VideoView
        • VideoGrid
        • useLocalMedia
        • useRoomConnection
      • Types
    • React Native Reference
      • Quick Start
      • WherebyEmbed
    • Webhooks Reference
Powered by GitBook
On this page
  • Per room configuration
  • Getting details of the dial-in access codes
  • Using webhooks
  • Additional information

Was this helpful?

Edit on GitHub
  1. Whereby 101
  2. Customize Your Video Experience

Dial-In

The Dial-in option allows meeting participants to join via a phonecall. This is particularly useful if they have internet issues, are traveling, or cannot use video for other reasons.

Dial-in is currently in closed Beta and available to selected customers only. Email us at embedded@whereby.com to join our pilot program (terms and conditions apply).

Per room configuration

You can configure the dial-in feature for individual rooms. Use the POST /meetings request to create the new room. During the creation request, add the following fields to the request’s body:

{    
    "endDate": "2099-03-25T13:30:00.000Z",
    “isDialInEnabled”: true,
    "fields": ["dialIn"]
}

Multiple fields can be specified in the same request, including things like hostRoomUrl

Example response:

{
	"startDate": "<now>",
	"endDate": "2099-03-25T13:30:00.000Z",
	"roomName": "/example-room”,
	"roomUrl": "https://example.whereby.com/example-room",
	"meetingId": "1234",
	"dialIn": {
		"code": "1234567890",
		"phoneNumbers": [
			{
				"countryCode": "US",
				"phoneNumber": "111-867-5309"
			}
		]
	},
	"roomPreferences": {
		"dialIn": true
	}
}

Getting details of the dial-in access codes

To obtain the dial-in details and access codes for a specific meeting, use the meetingId and send a GET request with ?fields=dialIn as a query param. The details are provided in a text response in JSON format, and include:

  • List of Dial-in phone numbers from different countries that participants can call to join the meeting

  • Dial-in access code

The above request will work for both a specific meetingId, or all active meetings. The response will be an array of meetings and the meetings will have the Dial-in details, but only if they were created with Dial-in enabled.

Creating callable links

The phone number and room code can be combined and presented as a link on your website or HTML email, allowing users to 'click' the link and dial into the room without having to manually enter the code.

To do so, create an anchor element with the href set to "tel:<phone number>,<room code>" like so:

<a href="tel:111-867-5309,1234567890">Click here</a>

The comma separating the phone number from the room code above, causes the phone to wait for an answer before entering the code

Here's how that renders on this website: Click here

Using webhooks

Webhook events can be used to track dial-in participants. When a dialed-in participant joins or leaves the meeting, Whereby sends a webhook event with details:

  • Participant’s phone number

  • Participant’s date and time of joining

  • Participant’s date and time of leaving the room

Additional information

  1. The Dial-in feature currently provides voice messages to participants in English only.

  2. The Dial-in feature is not compatible with our Breakout Groups feature.

Last updated 10 months ago

Was this helpful?

📹