Ading configurable SIP display name (#1216)

Author: alexlivekit

.changeset/tender-facts-mate.md

@@ -0,0 +1,5 @@
+---
+"github.com/livekit/protocol": minor
+---
+
+Added DisplayName field to CreateSIPParticipantRequest

livekit/livekit_sip.pb.go

@@ -675,6 +675,16 @@ func (p *CreateSIPParticipantRequest) Validate() error {
 	if err := validateHeaderKeys(p.Headers); err != nil {
 		return err
 	}
+
+	// Validate display_name if provided
+	if p.DisplayName != nil {
+		if len(*p.DisplayName) > 128 {
+			return errors.New("display_name too long (max 128 characters)")
+		}
+
+		// TODO: Validate display name doesn't contain invalid characters
+	}
+
 	return nil
 }
 

livekit/livekit_sip.twirp.go

@@ -669,7 +669,15 @@ message CreateSIPParticipantRequest {
 
   // Wait for the answer for the call before returning.
   bool wait_until_answered = 19;
-  // NEXT ID: 21
+
+  // Optional display name for the 'From' SIP header.
+  //
+  // Cases:
+  // 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number.
+  // 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream.
+  // 3) Non-empty: Use the specified value as the display name.
+  optional string display_name = 21;
+  // NEXT ID: 22
 }
 
 message SIPParticipantInfo {

livekit/sip.go

@@ -105,7 +105,15 @@ message InternalCreateSIPParticipantRequest {
   // Wait for the answer for the call before returning.
   bool wait_until_answered = 29;
 
-  // NEXT ID: 31
+  // Optional display name for the 'From' SIP header.
+  //
+  // Cases:
+  // 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 
+  // 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream.
+  // 3) Non-empty: Use the specified value as the display name.
+  optional string display_name = 31;
+
+  // NEXT ID: 32
 }
 
 message InternalCreateSIPParticipantResponse {

protobufs/livekit_sip.proto

@@ -71,6 +71,9 @@ func NewCreateSIPParticipantRequest(
 	req *livekit.CreateSIPParticipantRequest,
 	trunk *livekit.SIPOutboundTrunkInfo,
 ) (*InternalCreateSIPParticipantRequest, error) {
+	if err := req.Validate(); err != nil {
+		return nil, err
+	}
 	var (
 		hostname           string
 		enc                livekit.SIPMediaEncryption
@@ -190,6 +193,7 @@ func NewCreateSIPParticipantRequest(
 		MaxCallDuration:       req.MaxCallDuration,
 		MediaEncryption:       enc,
 		WaitUntilAnswered:     req.WaitUntilAnswered,
+		DisplayName:           req.DisplayName,
 	}, nil
 }