SIP dial-in (audio only)
Single SIP endpoint
Set thesip room property to enable SIP dial-in:
sip_uri.endpoint — the SIP address your client dials:
provider; see Using SignalWire.
Set sip to null to disable SIP on a room.
Multiple SIP endpoints
Usenum_endpoints to provision multiple SIP dial-in addresses. Each SIP and PSTN connection counts toward the max_sip_pstn_sessions_per_room limit (default: 5).
sip_uri.extra_endpoints with additional SIP addresses:
Using SignalWire
Leave outprovider, or set it to "signalwire", to put the room’s dial-in endpoints on SignalWire, the default:
num_endpoints, video, and codecs work the same way on either provider.
SIP dial-in (audio and video)
Setvideo: true to enable video SIP dial-in. You can also specify codecs explicitly:
Dynamic display names
display_name is set at room creation time. To pass a name at dial time instead, append it as a URL-encoded query parameter on the SIP URI:
encodeURIComponent to encode the name. If x-daily_display_name is not passed, the room-level display_name is used.
Testing SIP dial-in
Below describes the SIP dial-in flow for a room with one SIP endpoint. For multiple endpoints, the flow is the same but with additionaldialin-ready events and SIP URIs.
- A session starts and the SIP worker registers with the SIP network.
- The
dialin-readyevent fires for each registered SIP URI. The event carries the endpoint with asip:prefix, assipEndpointand assipEndPoint, which will be deprecated, which is the only key on older daily-js versions; seesipEndpointandsipEndPoint. - After
dialin-ready, your SIP client dials thesip_uri.endpoint.
- Each
sip_uriendpoint can only be used by one SIP client at a time. - After a disconnect, the same
sip_urican be redialed. - When the Daily session ends, all SIP connections are terminated.
SIP dial-out
A Daily room can dialout to a one or more"sipUri". You can initiate dial-out from the client SDK or REST API. See the overview for details on dial-out prerequisites and supported codecs.
Dial out audio-only:
provider to dial through SignalWire, the default. The room’s sip.provider does not apply to dial-out. See SIP providers.
SIP URIs must be prefixed with sip:. You can also use startDialOut() from the client SDK.
Caller name on the called device
By default the called device shows the SIP username asscoiated to the Daily Room. Typically,<room>.dialout.<n>. Pass callerName to show the user defined name instead. Daily puts it in the display-name of the SIP From header of the INVITE it sends:
callerName is independent of displayName. displayName identifies the remote participant in a Daily call, wheras, the callerName identifies the caller (Daily call) to the remote participant.
Basically callerName inserts a human comprehensible label to the From: sip address. See the REST API and startDialOut(), and with sipCallTransfer() for details.
It is not available for PSTN dial-out, where the caller ID is a phone number, or with sipRefer(), where the transferred device sends its own INVITE. Max 70 characters; ", \ and control characters are rejected. The dialout-* events echo it as callerName, and the dialout.* and calltransfer.triggered webhooks as caller_name.
A back-to-back user agent (B2BUA) between Daily and the device, such as a hosted SIP domain, a PBX or an SBC, answers Daily’s INVITE and sends its own INVITE to the device. That second INVITE carries whatever the B2BUA puts in it, so
callerName reaches the device only if the B2BUA forwards it. A Twilio SIP Domain, for example, exposes the name to your TwiML as the CallerName request parameter but shows the device whatever <Dial callerId> is set to, which does not accept spaces. A device registered directly with the dialed domain shows callerName as sent.SIP video layout
By default a SIP video participant sees the current speaker, one camera at a time, and hears everyone. A layout changes what Daily composites for them. Set it asvideoSettings.layout on dialOut/start or startDialOut(), and as video_settings.layout in the sip room property for dial-in (SIP trunk room templates included).
Participant references.
participants.video, participants.audio, videoParticipant, audioParticipant, mainParticipant and insetParticipant take a participant’s user_id (from their meeting token) or session id. The user_id is matched first, so a reference survives a rejoin and can name a participant who has not joined yet, which matters when the SIP call starts before the others arrive. participants.video and participants.audio also accept "*" (everyone) and "owners", and take up to 50 entries each.
The SIP participant is named by the dial’s userId (user_id in the sip room property for dial-in). Their own camera is sent back only when a reference names it, never through "*", and their own audio is never sent back to them.
Dial out to an interpreter who sees the patient full-frame and the doctor in a small tile:
startDialOut() reference for every option and its limits.