Add support for SIP configuration by jflevesque-genetec · Pull Request #782 · onvif/specs

jflevesque-genetec · 2026-06-03T08:11:31Z

New API specifications for configuring some settings related to SIP.

SipServerConfiguration: How a SIP device can connect to a SIP registrar
NatConfiguration: If a device needs STUN/TURN servers to reach a SIP registrar (for example in a cloud setup)
CallConfiguration: Settings related to establish a call, for example which recipient are you calling when pressing on a button on an intercom
StreamingConfiguration: Configuration to be used when streaming through a SIP call.

jflevesque-genetec · 2026-06-03T08:12:01Z

Suggestion to move these new APIs into a SIP specification. Will be working on that shortly.
Update: Changes have been applied on the branch

johado · 2026-06-03T11:21:14Z

+			<!--===============================-->
+			<xs:complexType name="ServerConfiguration">
+				<xs:sequence>
+					<xs:element name="Registrar" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>


I think we need to support either multiple ServerConfiguration entries, or replace the Registrar array with an array of Registrar structs (or SIPAccount/SIPServer) and put the Authentication config within that struct.
Possibly some of the config in CallConfiguration such as AllowIncomingCalls and AutoAnswer belongs within that struct as well?
Also make it possible to support peer-to-peer accounts that does not use a registrar.

What would be the use cases of having multiple SIP server configurations? As it is currently defined, we already have redundancy and resilience using the multiple registrar URIs within the configuration.

johado · 2026-06-03T11:23:35Z

+							<xs:documentation>The user info/extension of the Address of Record (AoR) in SIP, identifying the recipient on the registrar.</xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="Order" minOccurs="1">


Suggest replacing this with a "CallTrigger" string,which should be one of the values returned from a new GetCallTriggers call or similar so there is a clear way to see if a call is triggered from what physical button or I/O, e.g: "Callbutton 1", "Callbutton 2", "External IO1", "External IO2", "TouchDisplay"
For calls triggered by a touch display, the value could be e.g "TouchDisplay" could be part of the supported CallTriggers.
And let the order in the array control the order of display based call triggers. Ok to have multiple recipients that share the same CallTrigger.

johado · 2026-06-03T11:24:05Z

+							<xs:documentation></xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="VideoEncoder" type="tt:VideoEncoder2Configuration" minOccurs="0" maxOccurs="1">


You typically want to offer multiple codecs and profiles of a codec.
Same for AudioEncoder and AudioDecoder.

johado

Like the idea in general. Hard to balance making it simple enough without make it to limited and hard to map to our current implementation.

toa-kumalija · 2026-06-04T21:14:28Z

+			<!--===============================-->
+			<xs:complexType name="ServerConfiguration">
+				<xs:sequence>
+					<xs:element name="Registrar" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>


I think the following configuration should be added as part of registrar configuration.

Transport protocol [UDP, TCP, TLS, SIPS] ==> Mandatory field

Outbound proxy server (I think is important for Multitenant SIP platforms, Service provider routing,Security and policy enforcement, NAT traversal) ==> Optional field.

Is it important for the client to know the registration status of the SIP configuration? I think we can add it as event or part of the get configuration response, to notify the client on registered, failed to register state.

We will propose something for this

I don't mind adding this, what other than a URI would be needed for the proxy config?

It is great idea to add this event. Do you already have a suggestion for which fields to include in the event?

toa-kumalija · 2026-06-04T21:23:25Z

+				</xs:complexType>
+			</xs:element>
+			<!--===============================-->
+			<xs:complexType name="CallRecipient">


DTMF can be added as part of CallRecipient configuration.
DTMF can be used to trigger actions like lock or open the door. I am not very clear of the use-case.

We weren't initially planning to add DTMFs in the specification. I know that ONVIF already supports relay outputs which seems to be what would be used to trigger the door opening. Wouldn't that specification work better than plugging it here with recipients?

toa-kumalija · 2026-06-04T21:32:09Z

+							<xs:documentation></xs:documentation>
+						</xs:annotation>
+					</xs:element>
+					<xs:element name="AudioDecoder" type="tt:AudioDecoderConfiguration" minOccurs="0" maxOccurs="1">


This can be multiple codecs.
The codecs can be in order of priority, which is common in SIP.
I am not sure if SIP supports decoder only codecs and encoder only codecs.

toa-kumalija · 2026-06-04T21:44:03Z

+					<xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>   <!-- first ONVIF then Vendor -->
+				</xs:sequence>
+			</xs:complexType>
+			<xs:complexType name="StreamingConfigurationOptions">


In streamingConfiguration media encryption options can be added.
Like SRTP mandatory, best-effort or just plain RTP without encryption.

True. It doesn't really match the way the configuration models in ONVIF operate, but maybe we could add a global SIP config to this model to have these types of settings?

I've checked the SipStreamingConfiguration model and Srtp configuration is already part of it in the VideoEncoder configuration, the field is named SecureStreamingProtocolAlgorithm

johado · 2026-06-05T09:34:54Z

+			<xs:complexType name="ServerConfiguration">
+				<xs:sequence>
+					<xs:element name="Registrar" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/>
+					<xs:element name="UserId" type="xs:string">


Is this the sip address and the AuthenticationId use the UserName in Authentication/Credential below?
Or can the sip address be part of the Registrar uri?
(In SIP those could be two different things)
Does use of AuthorizationServer require a special AuthenticationId if it is not the UsertId?

johado · 2026-06-05T09:35:51Z

+								<xs:element name="Credential" type="tsip:BasicCredential" minOccurs="0" maxOccurs="1"/>
+								<xs:element name="AuthorizationServer" type="tt:ReferenceToken" minOccurs="0" maxOccurs="1">
+									<xs:annotation>
+										<xs:documentation>AuthorizationServer token referring to the server that provides access tokens to authorize with the renewal endpoint.</xs:documentation>


Add doc on where the AuthorizationServers are defined.

Add support for SIP configuration

7095580

jflevesque-genetec added 8 commits June 3, 2026 04:33

Create SIP specification and move out SIP stuff from core spec

44e6a82

Rename types and operations to remove SIP prefix

36a8f7e

Move SipStreamingConfiguration from Media2 to SIP

722e324

Add SIP to list of specifications

a88274d

Reviewed NAT configuration documentation

f1f0691

Reordered capabilities to be sorted asc

2cefe70

Bump version to 26.12

aff140f

Removed BasicCredential that was moved to sip wsdl

a79c720

jflevesque-genetec commented Jun 3, 2026

View reviewed changes

Comment thread doc/Media2.xml

Comment thread wsdl/ver10/device/wsdl/devicemgmt.wsdl

HansBusch added 27.06 IPR needed WG_enh TC and removed TC labels Jun 3, 2026

johado reviewed Jun 3, 2026

View reviewed changes

toa-kumalija reviewed Jun 4, 2026

View reviewed changes

jflevesque-genetec and others added 2 commits June 5, 2026 05:23

Merge branch 'development' into video/sip

776f250

Update AudioDecoder options type

8920c12

ocampana-videotec added this to the 27.06 milestone Jun 5, 2026

johado reviewed Jun 5, 2026

View reviewed changes

Conversation

jflevesque-genetec commented Jun 3, 2026

Uh oh!

jflevesque-genetec commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johado left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

toa-kumalija Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

toa-kumalija Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jflevesque-genetec commented Jun 3, 2026 •

edited

Loading

toa-kumalija Jun 4, 2026 •

edited

Loading

toa-kumalija Jun 4, 2026 •

edited

Loading