DAdaily
rooms

rooms/:name/dialOut/start

Changed on

Start a dial-out in a room

post/rooms/{room_name}/dialOut/start

Request

  • Base URL
    https://api.daily.co/v1
  • Auth
    HTTP bearer

Path parameters

room_namestring required

Request body

sipUristring

sipUri to call. uri should start with sip:. Query parameters appended to the sipUri will appear as SIP Headers in the INTIVE message at the remote SIP endpoint. Headers must start with "X-", e.g. to append a header "myexampleHeader" it is appended to sipUri as "sip:<dialout_sip_uri>?X-header-1=val-1&X-header-2=val-2".

phoneNumberstring

phone number to call. number must start with country code e.g +1

extensionstring

the extension to dial after dialed number is connected. e.g. 1234

waitBeforeExtensionDialSecinteger

number of seconds to wait before dialing the extension, once dialed number is connected.

displayNamestring

The sipUri or The phone participant is shown with this name in the web UI.

userIdstring

userId to assign to the participant. default userId is null.

callerIdstring

The id of a purchased phone number on the domain, not the phone number itself. The phone number associated with this id is displayed as the caller ID on the called phone.

videoboolean

Enable SIP video in the room, only available for sipUri.

provider'signalwire' | 'daily'

The SIP provider for this dial-out. Applies to sipUri dial-out only. "daily" dials the sipUri through the Daily SIP provider, the recommended choice for SIP dial-out. A phoneNumber dial-out with "daily" returns 400. See SIP providers.

Example request

{
  "videoSettings": {
    "layout": {
      "preset": "sip-portrait",
      "variant": "inset",
      "mainParticipant": "patient-42",
      "insetParticipant": "doctor-7"
    }
  }
}

Response

200

Changes

  • a65528c3e5b8Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • b4d8f24f57daRevision changes
    • info

      added the new optional request property /

    • info

      the / request property's max was increased from 720.00 to 1280.00