Skip to content

docs(sip): state that SIP presence and PIDF-LO are not supported - #662

Open
Devon-White wants to merge 6 commits into
mainfrom
devon/sip-presence-pidf-lo
Open

docs(sip): state that SIP presence and PIDF-LO are not supported#662
Devon-White wants to merge 6 commits into
mainfrom
devon/sip-presence-pidf-lo

Conversation

@Devon-White

Copy link
Copy Markdown
Collaborator

Summary

Resolves signalwire/cloud-product#20822: no docs page mentioned PIDF-LO or SIP presence, so the Sigmond assistant answered the support query "PIDF-lo support SIP presence" from the unrelated Bring your own carrier page.

Investigation (ticket comment) found no customer-facing usage of either feature on the cloud platform, so this documents them as not supported.

Changes

fern/products/platform/pages/calling/voice/SIP/index.mdx

  • New ## Presence and location support section: explains SIP presence (SUBSCRIBE/NOTIFY, PIDF, BLF) and PIDF-LO (RFC 4119/5491, Geolocation header), states both are unsupported, points to the E911 guide as how location reaches the dispatcher, and closes with a support contact line.
  • One-sentence pointer after the generic "Presence information" feature list linking to the new section.

Sourcing

  • SIP presence: every cloud FreeSWITCH SIP profile sets manage-presence=false.
  • PIDF-LO: no handling in prime-rails; #6975 closed as not needed; E911 is registered-address provisioning only.
  • Dashboard registration visibility / no API: cloud-product#20669.
  • Open caveat: Kamailio edge config wasn't readable. If the edge answers presence SUBSCRIBEs independently, the presence paragraph needs revising.

Verification

  • yarn fern-md-check passes (2823 files).
  • Preview: /docs/platform/voice/sip, confirm the #presence-and-location-support anchor resolves.
  • After merge: rebuild the Sigmond corpus and confirm "PIDF-lo support SIP presence" retrieves this page.

🤖 Generated with Claude Code

Adds a 'Presence and location support' section to the SIP overview so the
docs (and the Sigmond retriever) answer the 'PIDF-LO / SIP presence'
question directly instead of falling through to unrelated pages.

Closes signalwire/cloud-product#20822

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

@hey-august hey-august left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix before merge

  • "The Dashboard shows whether a SIP Credential is currently registered" is inaccurate. The Dashboard lists a "Last Registered" timestamp for each credential, not a live registered/unregistered state. Rewrite to "The Dashboard shows when a SIP Credential last registered". The rest of the sentence holds: neither REST spec exposes a registration field and no webhook covers it.

Grounding notes

  • Presence not supported is confirmed. The SIP profiles devices register against have presence handling disabled.
  • PIDF-LO not read or added rests on absence of evidence. No handling of the Geolocation header or PIDF bodies exists in the call-routing or SIP configuration I checked. That is consistent with the claim, but worth a one-line confirmation from Voice engineering before publishing an E911 statement.
  • The heading anchor #presence-and-location-support follows the auto-slug pattern used elsewhere, for example the prompt-engineering guide. No check covers anchors, so preview once.

Should fix, small

  • The "Flexibility" list still promises what the new section denies. Lines 60 to 64 say SIP gives you "the capability to identify a user's location", "determine user availability", and "user presence information, and E911 calls". The new pointer sentence only covers the Overview list. Either extend the pointer to this list or add "of the protocol" framing there too, so a reader who skims to Benefits doesn't leave with the wrong answer.
  • Bold-lead paragraphs. The two definition paragraphs open with **SIP presence** and **PIDF-LO** as labels. The style rule bans bold labels as a paragraph substitute. Plain openers read fine: "SIP presence is the SUBSCRIBE/NOTIFY event package…".
  • "so the request is on record" is an odd close for a customer. "so the request is tracked", or simply "to request either capability, contact SignalWire support", is cleaner.

Fine as is

  • RFC 4119 and RFC 5491 are the right citations. E911 link matches the target page's slug. Terminology matches the page and the REST spec ("SIP Credential"). Support link form matches sibling pages. Placement between Benefits and softphone setup is sensible, and the section is the kind of retriever target the ticket asked for. MDX check passes on all files.

hey-august and others added 4 commits September 10, 2026 07:02
- Dashboard shows last-registered time, not live registration state
- Drop bold labels from paragraph openers
- Point the Benefits list at the support section too
- Frame emergency location around the registered E911 address

@hey-august hey-august left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All notes addressed. Good to merge.

  • Dashboard claim now says "when a SIP Credential last registered", matching what the Dashboard shows.
  • Flexibility list has its own pointer to the new section.
  • Bold labels are gone. The definition paragraphs open in plain prose.
  • Support line is now "To request either capability, contact SignalWire support."
  • PIDF-LO paragraph no longer asserts that SignalWire ignores Geolocation on inbound INVITEs. It states only what's verifiable: dispatcher location comes from the registered E911 address. That removes the one claim I couldn't ground, so the engineering confirmation I suggested is no longer needed.

MDX check passes on all 2831 files. One optional nit: the new intro says SignalWire "handles both differently", which reads slightly vague before the colon explains it. Not worth another round.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants