API: Add trigger into bot handover api endpoint RD-29540 (#253)

* API: ADD trigger into bot handover api endpoint RD-29540 * remove engage
ringcentral · Jul 1, 2024 · 3af3c54 · 3af3c54
1 parent d99c6e5
commit 3af3c54
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/specs/engage-digital_openapi3.yaml b/specs/engage-digital_openapi3.yaml
@@ -405,7 +405,7 @@ paths:
     post:
       description: This method is used to handover a conversation between a bot and an agent.
         It handles 2 different cases, specific sources handover (Messenger for example, see Bots API doc)
-        and handover between Engage Virtual Agents and human agents. This method recategorizes the thread if the thread_category_ids parameter is provided.
+        and handover between Virtual Agents and human agents. This method recategorizes the thread if the thread_category_ids parameter is provided.
       operationId: handoverFromBotToAgent
       parameters:
         - description: Who we are taking the conversation control from (either bot or agent).
@@ -438,7 +438,7 @@ paths:
           required: false
           schema:
             type: string
-        - description: The id of the intervention that we want to handover (only for Engage Virtual Agent handover).
+        - description: The id of the intervention that we want to handover (only for Virtual Agent handover).
           in: query
           name: intervention_id
           required: false
@@ -453,6 +453,12 @@ paths:
             items:
               type: string
             type: array
+        - description: The string configured in the handover rules trigger field of the Virtual Agent.
+          in: query
+          name: trigger
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           content:

diff --git a/specs/engage-digital_postman2.json b/specs/engage-digital_postman2.json
@@ -635,14 +635,20 @@
                     {
                       "key": "intervention_id",
                       "value": "\u003cstring\u003e",
-                      "description": "The id of the intervention that we want to handover (only for Engage Virtual Agent handover).",
+                      "description": "The id of the intervention that we want to handover (only for Virtual Agent handover).",
                       "disabled": true
                     },
                     {
                       "key": "thread_category_ids[]",
                       "value": "\u003carray.string.csv\u003e",
                       "description": "An array containing the new categories to set on the thread.",
                       "disabled": true
+                    },
+                    {
+                      "key": "trigger",
+                      "value": "\u003cstring\u003e",
+                      "description": "The string configured in the handover rules trigger field of the Virtual Agent.",
+                      "disabled": true
                     }
                   ]
                 },
@@ -657,7 +663,7 @@
                     "value": "application/json"
                   }
                 ],
-                "description": "This method is used to handover a conversation between a bot and an agent. It handles 2 different cases, specific sources handover (Messenger for example, see Bots API doc) and handover between Engage Virtual Agents and human agents. This method recategorizes the thread if the thread_category_ids parameter is provided."
+                "description": "This method is used to handover a conversation between a bot and an agent. It handles 2 different cases, specific sources handover (Messenger for example, see Bots API doc) and handover between Virtual Agents and human agents. This method recategorizes the thread if the thread_category_ids parameter is provided."
               }
             }
           ]