Add more docs on the new headers fields.

livekit · Sep 12, 2024 · bb25cca · bb25cca
1 parent 05e4be4
commit bb25cca
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/protobufs/livekit_sip.proto b/protobufs/livekit_sip.proto
@@ -215,8 +215,10 @@ message SIPOutboundTrunkInfo {
   string auth_password = 8;
 
   // Include these SIP X-* headers in INVITE request.
+  // These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.
   map<string, string> headers = 9;
   // Map SIP X-* headers from 200 OK to SIP participant attributes.
+  // Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
   map<string, string> headers_to_attributes = 10;
 }
 

diff --git a/protobufs/rpc/io.proto b/protobufs/rpc/io.proto
@@ -159,9 +159,11 @@ message EvaluateSIPDispatchRulesResponse {
   // Used in Cloud only
   string project_id = 12;
 
-  // Include these SIP X-* headers in 200 OK response.
+  // Include these SIP X-* headers in 200 OK response to INVITE.
+  // These headers are included as-is and may help identify triggered LiveKit Dispatch Rule for the other SIP endpoint.
   map<string, string> headers = 13;
   // Map SIP X-* headers from INVITE to SIP participant attributes.
+  // Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
   map<string, string> headers_to_attributes = 14;
   // NEXT ID: 15
 }