Merge pull request #34 from RocketChat/incoming-messages

[NEW] add a new action to send message as a bot user

Author: renatobecker

README.md

@@ -77,6 +77,9 @@ The app provides API to trigger specific actions. The URL for the API can be fou
     2. **Handover**<br/>
         To perform a handover
         - REST API Documentation for this endpoint can be found [here](./docs/api-endpoints/perform-handover.md)
+    3. **Send-Message**<br/>
+        To send a message as a bot to Visitor
+        - REST API Documentation for this endpoint can be found [here](./docs/api-endpoints/send-message.md)
 2. Fulfillment API/Endpoint
 
     The fulfillment endpoint will enable the app to handle asynchronous messages. More information on it [here](./docs/api-endpoints/fulfillment-endpoint.md)

docs/api-endpoints/send-message.md

@@ -0,0 +1,95 @@
+**Send Message**
+----
+  Action to send Message to Visitor. The sender for this message will be the Bot.
+
+* **URL**
+
+    REST API URL can be found on Apps Page <br />
+    Sample Url for eg: <br /> `http://localhost:3000/api/apps/public/783d8e4d-b06a-409a-aaf3-b37650dc0a26/incoming`
+
+* **Method:**
+
+  `POST`
+  
+*  **Input Data Format**
+
+    `JSON`
+
+* **Data Params**
+
+  **Required:**
+ 
+   1. `action` = `send-message`  <br/>
+ 
+   2. `sessionId=[string]`
+      > Note. Session Id is the same session of Dialogflow
+
+   3. ```bash
+        actionData: {
+            `messages=[Array<string | QuickReplies>]`
+        }
+        ```
+      > Note: `messages` is an array of simple string messages and QuickReplies. 
+
+      > Format for quick-replies is almost similar to [this](../QuickReplies.md). Following is the format.
+        ```bash
+        {
+            "text": string,
+            "options": [
+                string
+            ]
+        }
+        ```
+
+* **Success Response:**
+
+  * **Code:** 200 <br />
+    **Content:** `{ result: "Your request was processed successfully" }`
+ 
+* **Error Response:**
+
+  * **Code:** 400 BAD REQUEST <br />
+    **Content:** <br/>
+    `{
+        error: "Error: Session Id not present in request"
+    }`
+
+  OR
+
+  * **Code:** 500 Internal Server Error <br />
+    **Content:** <br />
+    `{ error : "Error occurred while processing perform-handover. Details:- [Error Details]" }`
+
+* **Sample Call:**
+
+    **Curl**
+    ```bash
+      curl "http://localhost:3000/api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming" \
+        -X POST \
+        -d "{\n  \"action\": \"send-message\",\n  \"sessionId\": \"6uppPYfLa3rnDF6Fe\",\n  \"actionData\": {\n    \"messages\": [\n      \"hello\",\n      {\n        \"text\": \"Do you want to continue?\",\n        \"options\": [\n          \"YES\",\n          \"NO\"\n        ]\n      }\n    ]\n  }\n}" \
+        -H "Content-Type: application/json" 
+    ```
+    **HTTP**
+
+  ```HTTP
+    POST /api/apps/public/21b7d3ba-031b-41d9-8ff2-fbbfa081ae90/incoming HTTP/1.1
+    Host: localhost:3000
+    Content-Type: application/json
+
+    {
+        "action": "send-message",
+        "sessionId": "6uppPYfLa3rnDF6Fe",
+        "actionData": {
+            "messages": [
+                "hello",
+                {
+                    "text": "Do you want to continue?",
+                    "options": [
+                        "YES",
+                        "NO"
+                    ]
+                }
+            ]
+        }
+    }
+  ```

endpoints/IncomingEndpoint.ts

@@ -5,6 +5,7 @@ import { EndpointActionNames, IActionsEndpointContent } from '../enum/Endpoints'
 import { Headers, Response } from '../enum/Http';
 import { Logs } from '../enum/Logs';
 import { createHttpResponse } from '../lib/Http';
+import { createDialogflowMessage } from '../lib/Message';
 import { closeChat, performHandover } from '../lib/Room';
 
 export class IncomingEndpoint extends ApiEndpoint {
@@ -42,6 +43,11 @@ export class IncomingEndpoint extends ApiEndpoint {
                 const { visitor: { token: visitorToken } } = room;
                 await performHandover(modify, read, sessionId, visitorToken, targetDepartment);
                 break;
+            case EndpointActionNames.SEND_MESSAGE:
+                const { actionData: { messages = null } = {} } = endpointContent;
+                if (!messages) { throw new Error(Logs.INVALID_MESSAGES); }
+                await createDialogflowMessage(sessionId, read, modify, { messages, isFallback: false });
+                break;
             default:
                 throw new Error(Logs.INVALID_ENDPOINT_ACTION);
         }

enum/Endpoints.ts

@@ -1,12 +1,16 @@
+import { IDialogflowQuickReplies } from './Dialogflow';
+
 export interface IActionsEndpointContent {
     action: EndpointActionNames;
     sessionId: string;
     actionData?: {
         targetDepartment?: string;
+        messages: Array<string | IDialogflowQuickReplies>;
     };
 }
 
 export enum EndpointActionNames {
     CLOSE_CHAT = 'close-chat',
     HANDOVER = 'handover',
+    SEND_MESSAGE = 'send-message',
 }

enum/Logs.ts

@@ -6,6 +6,7 @@ export enum Logs {
     INVALID_BOT_USERNAME_SETTING = 'The Bot User does not exist.',
     INVALID_VISITOR_TOKEN = 'Error: Visitor Token not valid',
     INVALID_DEPARTMENT_NAME = 'Error: Department Name is not valid',
+    INVALID_MESSAGES = 'Error! Messages data not present or in wrong format. Kindly refer the api documentation.',
     ENDPOINT_REQUEST_PROCESSING_ERROR = 'Error occurred while processing the request. Details:- ',
     INVALID_ENDPOINT_ACTION = 'Error!! Invalid Action type',
     EMPTY_CLIENT_EMAIL_OR_PRIVATE_KEY_SETTING = 'Client Email or Private Key Field cannot be empty',