POST
/rooms/:name/dialOut/start

Starts a dialOut with given parameters.

Path params

string

The name of the room.

Body params

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

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

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

string

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

string

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

boolean

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

object

Specify the codecs to use for dial-out.

array

Specify the audio codecs to use for dial-out. ['OPUS', 'G722', 'PCMU', 'PCMA']

array

Specify the video codecs to use for dial-out. ['H264', 'VP8']

Example requests

Example responses