Skip to Content
SessionCloud PortalDesktop Link Provisioning
SessionCloud Portal

Desktop Link Provisioning lets you set up a user’s Windows or macOS desktop softphone by sending them a single link. You enter the user’s SIP credentials in the portal, the portal stores them securely and generates a one-time setup link, and you send that link to the user. When the user clicks it, the already-installed desktop app provisions itself automatically.

The SIP password is never included in the link. The link only carries a short-lived, single-use token; the app exchanges that token for the configuration over an encrypted (HTTPS) connection.

This feature applies to desktop apps only — Windows Desktop and macOS Desktop. iOS and Android are not affected.


How it works

  1. In the portal, enter the user’s SIP credentials (username, password, domain, transport, and any optional settings such as proxy or SRTP).
  2. The portal stores the record encrypted and generates a setup link backed by a one-time, expiring token.
  3. You send the link to the user by email or SMS.
  4. The user clicks the link. Their operating system launches the desktop softphone via the registered scloc handler.
  5. The app exchanges the token for the configuration over HTTPS, provisions the SIP account, and the token is then invalidated so it cannot be reused.

Calls themselves still go directly to your PBX — only the one-time provisioning step contacts the portal.


The setup link uses the scloc scheme already registered by the desktop apps:

scloc:?v=2&token=<one-time-token>
  • v=2 identifies the token-based (secure) link.
  • token is an opaque, single-use, expiring value. It is not the username and cannot be guessed.

Setup code fallback

If the user’s email client strips custom links, or the link does not launch the app, the desktop login screen also accepts a pasted setup code. The user opens the app, chooses Enter setup code, and pastes the full scloc:?v=2&token=... string. This provisions the account exactly as clicking the link would.


Token lifetime and re-issuing

  • Setup links are single use and expire (default 72 hours).
  • Once a link has been used, clicking it again shows a message asking the user to request a new link.
  • If a link expires or is used by mistake, re-issue a new link for the user from the portal. Re-issuing invalidates the previous link.

Notes

  • The user must have the desktop softphone installed before clicking the link — the link launches an installed app, it does not install one. Include your installer download link in the same message.
  • Whitelabel desktop apps and the generic SessionCloud desktop app both support setup links.
Last updated on