Adding support for dynamic dispatch rules by nishadmusthafa · Pull Request #1123 · livekit/protocol

nishadmusthafa · 2025-06-30T05:58:27Z

Adding the capability for dispatch rule to have a url and http method
Allowing the user to respond with a dynamic response for the url
Allowing three types of dispatch actions(answer, hangup and transfer)

1. Adding the capability for dispatch rule to have a url and http method 2. Allowing the user to respond with a dynamic response for the url 3. Allowing three types of dispatch actions(answer, hangup and transfer)

changeset-bot · 2025-06-30T05:58:31Z

🦋 Changeset detected

Latest commit: c71f955

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR

Some errors occurred when validating the changesets config:
The package or glob expression "github.com/livekit/protocol" specified in the `fixed` option does not match any package in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

PR for dynamic dispatch rules: livekit/protocol#1123 go.mod changes will be made once that PR is approved.

nishadmusthafa · 2025-06-30T06:20:55Z

This is the cli change -> livekit/livekit-cli#606

dennwc · 2025-06-30T10:52:01Z

livekit/sip.go

+		if dynamicRule.Url == "" {
+			return errors.New("dynamic dispatch rule URL cannot be empty")
+		}
+		if !strings.HasPrefix(dynamicRule.Url, "https://") {


Plain HTTP should probably be allowed for OSS.

dennwc · 2025-06-30T10:53:13Z

protobufs/livekit_sip.proto

+  // Type of action to take
+  DispatchAction action = 1;
+
+  // Fields used when action is ACTION_ANSWER


This should be a separate message and a oneof field. In that case we no longer need a DispatchAction enum.

hah.. that's exactly what I'd done earlier. But @davidzhao and I had a discussion on this. My initial version had a bunch of nesting and using messages in messages. The idea here was to make it simple and give users the ability to use as flat a structure as possible when returning a response.

Just to add more context here, the flat json for response as well as for payload is so that anyone who wants to use this doesn't need to have the sdk to be able to do this.

dennwc · 2025-06-30T10:54:57Z

protobufs/livekit_sip.proto

+  string room_preset = 4;
+  // RoomConfiguration to use if the participant initiates the room
+  RoomConfiguration room_config = 5;
+  //valid for only cloud
+  bool krisp_enabled = 6;
+  SIPMediaEncryption media_encryption = 7;


We should probably put these common fields in some message type and share in for inbound and outbound calls. Could be done later, of course.

Same point on flat json as above

dennwc · 2025-06-30T10:56:52Z

protobufs/livekit_sip.proto

+  // Room name to connect to
+  string room_name = 2;
+  // Optional pin required to enter room
+  string pin = 3;


I believe this would change the dispatch logic significantly. I wonder if an entered pin should be sent as a new webhook event.

Yeah, DZ was also mentioning webhooks for another category of events. This would be if the agent fails to connect. Are we talking about adding more events here -> https://github.com/livekit/protocol/blob/main/webhook/consts.go#L27 ?

dennwc · 2025-06-30T10:58:21Z

protobufs/livekit_sip.proto

+
+  // Fields from SIPDispatchRuleDynamicResponse for dynamic rules
+  // Type of action to take
+  DispatchAction action = 13;


Shouldn't it already be in the rule field?

Not really, action is only in the SIPDispatchRuleDynamicResponse and only when it's a dynamic rule. So we have to explicitly set it once a response comes back.

dennwc · 2025-06-30T10:59:10Z

sip/sip.go

 // EvaluateDispatchRule checks a selected Dispatch Rule against the provided request.
 func EvaluateDispatchRule(projectID string, trunk *livekit.SIPInboundTrunkInfo, rule *livekit.SIPDispatchRuleInfo, req *rpc.EvaluateSIPDispatchRulesRequest) (*rpc.EvaluateSIPDispatchRulesResponse, error) {
+	log := logger.GetLogger()
+	log.Debugw("Evaluating dispatch rule dailamooooo", "rule", rule)


Should be removed?

Yes 😅. thanks for catching that.

dennwc · 2025-06-30T11:00:06Z

sip/sip.go

+			return nil, twirp.WrapError(twirp.NewError(twirp.Internal, "Failed to get room and pin"), err)
+		}
+	case *livekit.SIPDispatchRule_DispatchRuleDynamic:
+		type dynamicDispatchRequest struct {


We should define these as protobufs and use protojson to encode/decode.

dennwc · 2025-06-30T11:00:54Z

sip/sip.go

+			return nil, twirp.WrapError(twirp.NewError(twirp.Internal, "Failed to marshal request"), err)
+		}
+
+		resp, err := http.Post(dynamicRule.DispatchRuleDynamic.GetUrl(), "application/json", bytes.NewReader(reqBytes))


We might want an option to pass a custom http.Client here.

dennwc · 2025-06-30T11:01:29Z

sip/sip.go

+		if err != nil {
+			return nil, twirp.WrapError(twirp.NewError(twirp.Internal, "Failed to get room and pin"), err)
+		}
+	case *livekit.SIPDispatchRule_DispatchRuleDynamic:


Worth moving to a separate function.

Adding support for dynamic dispatch rules

844b955

1. Adding the capability for dispatch rule to have a url and http method 2. Allowing the user to respond with a dynamic response for the url 3. Allowing three types of dispatch actions(answer, hangup and transfer)

nishadmusthafa and others added 3 commits June 29, 2025 23:00

Adding generated protobufs

b8e7667

Adding changeset

6eb1a76

generated protobuf

c71f955

nishadmusthafa requested review from biglittlebigben, davidzhao and dennwc June 30, 2025 06:05

nishadmusthafa added a commit to livekit/livekit-cli that referenced this pull request Jun 30, 2025

Adding support in livekit-cli for dynamic dispatch rules

51537e9

PR for dynamic dispatch rules: livekit/protocol#1123 go.mod changes will be made once that PR is approved.

nishadmusthafa mentioned this pull request Jun 30, 2025

Adding support in livekit-cli for dynamic dispatch rules livekit/livekit-cli#606

Open

dennwc requested changes Jun 30, 2025

View reviewed changes

Conversation

nishadmusthafa commented Jun 30, 2025

Uh oh!

changeset-bot bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

nishadmusthafa commented Jun 30, 2025

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!

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!

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!

2 participants

changeset-bot bot commented Jun 30, 2025 •

edited

Loading