Adding display name to CreateSipParticipant (#544)

Author: alexlivekit

.changeset/brown-teams-kiss.md

@@ -0,0 +1,5 @@
+---
+'livekit-server-sdk': minor
+---
+
+Added displayName field to CreateSipParticipantOptions

examples/agent-dispatch/package.json

@@ -13,8 +13,7 @@
   },
   "dependencies": {
     "dotenv": "^16.4.5",
-    "livekit-server-sdk": "workspace:*",
-    "@livekit/protocol": "^1.39.0"
+    "livekit-server-sdk": "workspace:*"
   },
   "devDependencies": {
     "@types/node": "^20.10.4",

packages/livekit-server-sdk/package.json

@@ -43,7 +43,7 @@
   },
   "dependencies": {
     "@bufbuild/protobuf": "^1.10.1",
-    "@livekit/protocol": "^1.39.0",
+    "@livekit/protocol": "^1.42.0",
     "camelcase-keys": "^9.0.0",
     "jose": "^5.1.2"
   },

packages/livekit-server-sdk/src/SipClient.ts

@@ -123,6 +123,8 @@ export interface CreateSipParticipantOptions {
   participantIdentity?: string;
   /** Optional name of the participant */
   participantName?: string;
+  /** Optional display name for the SIP participant */
+  displayName?: string;
   /** Optional metadata to attach to the participant */
   participantMetadata?: string;
   /** Optional attributes to attach to the participant */
@@ -719,6 +721,7 @@ export class SipClient extends ServiceBase {
       roomName: roomName,
       participantIdentity: opts.participantIdentity || 'sip-participant',
       participantName: opts.participantName,
+      displayName: opts.displayName,
       participantMetadata: opts.participantMetadata,
       participantAttributes: opts.participantAttributes,
       dtmf: opts.dtmf,