Skip to main content
POST
rooms/:name/dialOut/start

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

room_name
string
required

Body

application/json
sipUri
string

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".

phoneNumber
string

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

extension
string

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

waitBeforeExtensionDialSec
integer
default:0

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

Required range: 0 <= x <= 60
displayName
string

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

userId
string

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

callerId
string

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.

callerName
string

SIP only. The name the called device shows for the incoming call: the display-name of the SIP From header. Independent of displayName, which names the participant inside the room. Max 70 characters; ", \ and control characters are rejected. Not allowed with phoneNumber. A back-to-back user agent (B2BUA) between Daily and the device decides what its own leg shows; see caller name on the called device.

Maximum string length: 70
video
boolean

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

videoSettings
object

Video settings for the SIP participant. Only applicable when video is true.

provider
enum<string>
default:signalwire

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.

Available options:
signalwire,
daily
codecs
object

Specify the codecs to use for dial-out.

permissions
object

Sets which media the dialed participant can receive.

Response

200