Merge pull request #16 from tcncloud/adding-transfer-protos

Adds call transfer functionality.

Author: namtzigla

tcnapi/exile/gate/v2/entities.proto

@@ -202,12 +202,13 @@ message ExileTransferInstance {
   }
   enum TransferType {
     TRANSFER_TYPE_UNSPECIFIED = 0;
-    WARM_AGENT = 1;
-    WARM_CALLER = 2;
-    WARM_OUTBOUND = 3;
-    WARM_SKILL = 4;
-    COLD_AGENT = 5;
-    COLD_OUTBOUND = 6;
+    WARM_AGENT = 1; // Warm transfer to another agent
+    WARM_CALLER = 2; // Transfer involving caller interaction
+    WARM_OUTBOUND = 3; // Warm transfer to external phone/PBX extension
+    WARM_SKILL = 4; // Warm transfer to skill queue/hunt group
+    COLD_AGENT = 5; // Cold transfer to another agent
+    COLD_OUTBOUND = 6; // Cold transfer to external phone/PBX extension
+    CONFERENCE = 7; // Conference all parties together
   }
   enum TransferResultType {
     TRANSFER_RESULT_TYPE_UNSPECIFIED = 0;

tcnapi/exile/gate/v2/public.proto

@@ -181,6 +181,7 @@ service GateService {
       body: "*"
     };
   }
+
   rpc ListNCLRulesetNames(ListNCLRulesetNamesRequest) returns (ListNCLRulesetNamesResponse) {
     option (google.api.http) = {get: "/tcnapi/exile/gate/v2/list_ncl_ruleset_names"};
   }
@@ -299,6 +300,12 @@ service GateService {
       body: "*"
     };
   }
+  rpc Transfer(TransferRequest) returns (TransferResponse) {
+    option (google.api.http) = {
+      get: "/tcnapi/exile/gate/v2/transfer"
+      body: "*"
+    };
+  }
 }
 
 // TimeRange represents an inclusive time interval for filtering logs.
@@ -1176,6 +1183,48 @@ message DialResponse {
   string caller_sid = 9 [deprecated = true];
 }
 
+/**
+ * Transfer Request/Response Messages
+ * These messages handle the various types of call transfers.
+ */
+
+/**
+ * Request message for transferring a call to another agent.
+ * Supports: Cold transfer, Warm transfer, and Conference.
+ */
+
+message TransferRequest {
+  string partner_agent_id = 1;
+  oneof destination {
+    Agent receiving_partner_agent_id = 2;
+    Outbound outbound = 3;
+    Queue queue = 4;
+  }
+  Kind kind = 5;
+  Action action = 6;
+
+  enum Kind {
+    KIND_COLD = 0;
+    WARM = 1;
+  }
+  enum Action {
+    ACTION_START = 0;
+    APPROVE = 1;
+    CANCEL = 2;
+  }
+  message Agent {
+    string partner_agent_id = 1;
+  }
+  message Outbound {
+    string caller_id = 1;
+    string destination = 2;
+    bool caller_hold = 3;
+  }
+  message Queue {}
+}
+
+message TransferResponse {}
+
 message ListNCLRulesetNamesRequest {}
 message ListNCLRulesetNamesResponse {
   repeated string ruleset_names = 1;