🔐 Bundle plugin only: This is exclusive to the Video, Audio & Live Bundle. Get the bundle plugin here.

Fields

room name
text
required

The name of the room where dial-in settings will be applied.

display name
text
required

Set the display name for PSTN participants when they join the room.

wait for meeting start
boolean

If a PSTN participant joins before the room starts, choose whether they wait in the conference with hold music or get disconnected.

room number
text

Assign a purchased phone number to PIN dial-in. If no number is specified, the default (earliest purchased) number is used.

exp
number

Set a custom exp otherwise the number will expire in 364 days, an exp is mandatory.

⚠️ Important Notes:

  • Must have an expiration. If no exp is set, the room will automatically expire in 364 days
  • Expiration must be a UNIX timestamp
  • If using an owner token, consider enabling eject_at_exp for better session control

Return Values

id
text

Unique identifier for the room

name
text

Name of the room

privacy
text

Privacy setting of the room

url
text

URL of the room

created at
date

When the room was created

dial-in code
number

PIN code for dial-in access

phone number
text

Phone number assigned for dial-in if specified when making the request

dial-in number
text

Dial-in number. Empty if phone number is specified, otherwise returns the earliest purchased number on the domain

dial-in with pin
text

Formatted dial-in number with number and PIN code. If no dial-in number or phone number is present, will use Daily global numbers

error
boolean

Whether an error occurred

error message
text

Error message if an error occurred

error status
number

Error status code if an error occurred