Skip to content

feat(simulate): run audio simulations against a phone number with --to-phone-number #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
u9g merged 4 commits into from
Oct 27, 2026
Merged

feat(simulate): run audio simulations against a phone number with --to-phone-number #1035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aec8d03
chore: bump protocol for the simulation run's SIP fields
u9g Oct 26, 2026
277207e
feat(simulate): run audio simulations against a phone number with --t…
u9g Oct 26, 2026
9f26636
fix(simulate): reject --from-phone-number without --to-phone-number
u9g Oct 26, 2026
6122893
chore: bump protocol to the merged SIP fields
u9g Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 47 additions & 2 deletions cmd/lk/simulate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,18 @@ var simulateAudioCommand = &cli.Command{
Name: "packet-loss",
Usage: "Drop packets from the simulated user's audio track",
},
&cli.StringFlag{
Name: "to-phone-number",
Usage: "Call this `NUMBER` over SIP and simulate against whoever answers, instead of dispatching an agent. Requires --from-phone-number and --scenarios.",
},
&cli.StringFlag{
Name: "from-trunk",
Usage: "Outbound SIP trunk `ID` to place --to-phone-number calls through. Without it, calls go out from a LiveKit phone number.",
},
&cli.StringFlag{
Name: "from-phone-number",
Usage: "Caller `NUMBER` for --to-phone-number calls: a LiveKit phone number the project owns, or a number on --from-trunk",
},
},
}

Expand Down Expand Up @@ -410,14 +422,19 @@ type simulateConfig struct {
scenarioGroup *livekit.ScenarioGroup
scenariosPath string // path to the --scenarios file (empty when generating from source)
viewModeRunID string // non-empty when `view` opens a pre-existing run
liveAgent bool // --agent-name: run against an already-running agent, don't spawn one
liveAgent bool // --agent-name or --to-phone-number: run against an already-running agent, don't spawn one
warnings []string // config-level warnings surfaced at setup (e.g. ignored flags)

// impairments on the simulated user's audio, set only in SIMULATION_MODE_AUDIO
backgroundNoise bool
lowQualityMicrophone bool
packetLoss bool

// --to-phone-number: dial this number over SIP in place of dispatching agentName
sipCallTo string
sipTrunkID string
sipNumber string

// TODO (steveyoon): add agent deployment support
// agentDeployment string
}
Expand Down Expand Up @@ -522,6 +539,22 @@ func runSimulate(ctx context.Context, cmd *cli.Command, simulationMode livekit.S
samples := int32(cmd.Int("samples"))
passRate := cmd.Float("pass-rate")
liveAgentName := cmd.String("agent-name")
var phoneNumber, fromTrunk, fromPhoneNumber string
if simulationMode == livekit.SimulationMode_SIMULATION_MODE_AUDIO {
phoneNumber = cmd.String("to-phone-number")
fromTrunk = cmd.String("from-trunk")
fromPhoneNumber = cmd.String("from-phone-number")
}
if fromTrunk != "" && phoneNumber == "" {
return fmt.Errorf("--from-trunk requires --to-phone-number")
}
if fromPhoneNumber != "" && phoneNumber == "" {
return fmt.Errorf("--from-phone-number requires --to-phone-number")
}
// every call needs a caller: the number simulations are placed from
if phoneNumber != "" && fromPhoneNumber == "" {
return fmt.Errorf("--to-phone-number requires --from-phone-number")
}

// never auto-discovered: an explicit --scenarios file is the source of
// truth, otherwise scenarios are generated from the agent's source
Expand All @@ -547,7 +580,13 @@ func runSimulate(ctx context.Context, cmd *cli.Command, simulationMode livekit.S

// --agent-name (even empty) means: run against an already-running agent,
// don't spawn one. https://docs.livekit.io/agents/server/agent-dispatch/#automatic
if cmd.IsSet("agent-name") {
if phoneNumber != "" {
// nothing is spawned, so there's no source to generate scenarios from.
if scenariosPath == "" {
return fmt.Errorf("--to-phone-number requires --scenarios (no source to generate scenarios from when calling a number)")
}
liveAgent = true
} else if cmd.IsSet("agent-name") {
// nothing is spawned, so there's no source to generate scenarios from.
if scenariosPath == "" {
return fmt.Errorf("--agent-name requires --scenarios (no source to generate scenarios from when running against a live agent)")
Expand Down Expand Up @@ -628,6 +667,9 @@ func runSimulate(ctx context.Context, cmd *cli.Command, simulationMode livekit.S
simCfg.backgroundNoise = cmd.Bool("background-noise")
simCfg.lowQualityMicrophone = cmd.Bool("low-quality-microphone")
simCfg.packetLoss = cmd.Bool("packet-loss")
simCfg.sipCallTo = phoneNumber
simCfg.sipTrunkID = fromTrunk
simCfg.sipNumber = fromPhoneNumber
}

if !isInteractive() {
Expand Down Expand Up @@ -801,6 +843,9 @@ func createSimulationRun(ctx context.Context, c *simulateConfig) (string, *livek
BackgroundNoise: c.backgroundNoise,
LowQualityMicrophone: c.lowQualityMicrophone,
PacketLoss: c.packetLoss,
SipCallTo: c.sipCallTo,
SipTrunkId: c.sipTrunkID,
SipNumber: c.sipNumber,
Ci: ciFromEnv(),
}
if c.concurrency > 0 {
Expand Down
4 changes: 2 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ require (
github.com/gorilla/websocket v1.5.4-0.20250319132907-e064f32e3674
github.com/joho/godotenv v1.5.1
github.com/klauspost/compress v1.20.1
github.com/livekit/protocol v1.53.1-0.20261022182030-f1ed0814615a
github.com/livekit/protocol v1.53.2-0.20261026205625-e87b8f61d18c
github.com/livekit/server-sdk-go/v2 v2.19.0
github.com/mattn/go-isatty v0.0.22
github.com/moby/moby/client v0.4.1
Expand Down Expand Up @@ -132,7 +132,7 @@ require (
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/gammazero/deque v1.2.1 // indirect
github.com/getkin/kin-openapi v0.144.0 // indirect
github.com/go-jose/go-jose/v4 v4.1.4 // indirect
github.com/go-jose/go-jose/v4 v4.1.5 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-openapi/jsonpointer v0.23.1 // indirect
github.com/go-openapi/swag/jsonname v0.26.1 // indirect
Expand Down
8 changes: 4 additions & 4 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@ github.com/gammazero/deque v1.2.1 h1:9fnQVFCCZ9/NOc7ccTNqzoKd1tCWOqeI05/lPqFPMGQ
github.com/gammazero/deque v1.2.1/go.mod h1:5nSFkzVm+afG9+gy0VIowlqVAW4N8zNcMne+CMQVD2g=
github.com/getkin/kin-openapi v0.144.0 h1:hIRcTH+KjLfkLpYU6bSSfdFpi0fZi1fp+hSPi4aQu9Y=
github.com/getkin/kin-openapi v0.144.0/go.mod h1:3BH9M9XDe/y9M5DSvEocVYAYq1w0qrhJHjC/vZi0AaY=
github.com/go-jose/go-jose/v4 v4.1.4 h1:moDMcTHmvE6Groj34emNPLs/qtYXRVcd6S7NHbHz3kA=
github.com/go-jose/go-jose/v4 v4.1.4/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08=
github.com/go-jose/go-jose/v4 v4.1.5 h1:RjgjO2LOtWOJKUC5wpwY9LR3B3vwVAz6JS2YHfYU6eA=
github.com/go-jose/go-jose/v4 v4.1.5/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08=
github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.4.4 h1:tG4xh9yMsRCAiodLVTxyrkzSZ9+o0L1Kg/+cPVcbP/8=
github.com/go-logr/logr v1.4.4/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
Expand Down Expand Up @@ -364,8 +364,8 @@ github.com/livekit/mageutil v0.0.0-20250511045019-0f1ff63f7731 h1:9x+U2HGLrSw5AT
github.com/livekit/mageutil v0.0.0-20250511045019-0f1ff63f7731/go.mod h1:Rs3MhFwutWhGwmY1VQsygw28z5bWcnEYmS1OG9OxjOQ=
github.com/livekit/mediatransportutil v0.0.0-20260821083140-f234b534b095 h1:BcliKAXoMhl/nWmzQweQ5kmh4Qqagxl4s3Z5pvM/7AY=
github.com/livekit/mediatransportutil v0.0.0-20260821083140-f234b534b095/go.mod h1:o8CFmAdrVwzJNOCsQCLUzXRjokkufNshnQHOe4fRaqU=
github.com/livekit/protocol v1.53.1-0.20261022182030-f1ed0814615a h1:+2yEcpXySowdY80dJJ5uXhiykNh6M+HE5KdScn/Kx1w=
github.com/livekit/protocol v1.53.1-0.20261022182030-f1ed0814615a/go.mod h1:kUTAI2TrTngGOiWP6MTAOkJpru6YYGd0MP9wzlDATy4=
github.com/livekit/protocol v1.53.2-0.20261026205625-e87b8f61d18c h1:vGLJnV6d5WUPsZ84DO1uHcBtiMcxHQw7R1/13kdrdo8=
github.com/livekit/protocol v1.53.2-0.20261026205625-e87b8f61d18c/go.mod h1:h9P4KCc3K715NCgCrkkFsb8/RRY1kKqOS1EIHUNRlCk=
github.com/livekit/psrpc v0.8.2 h1:7tbkhBJoYlK5Csfkdv1XYbZjyAQeaEZgupvIXNCv7Dc=
github.com/livekit/psrpc v0.8.2/go.mod h1:6KnU8vULoizX0Er9NNfeKJDV8ug87j3fuo19M0bhj6Q=
github.com/livekit/server-sdk-go/v2 v2.19.0 h1:fZ0zmeC/5V+rXiI/MeC05EjwTfXmpaGkr/DXLG3EzgA=
Expand Down
Loading