v2

latestOpenAPI 3.0.32026-07-266076394.0 KB
rooms

rooms/:name/dialOut/start

Start a dial-out in a room

post/rooms/{room_name}/dialOut/start

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

determine the phone number used for outbound call (i.e. phone number displayed on the called phone). purchased phone

videoboolean

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

Response

200