Use the action field instead of the intent name to determine what should happen

Author: Bertware

README.md

@@ -26,8 +26,7 @@ After creating a new agent, you click the gear wheal in the top left, next to yo
 ![Dialogflow settings](docs/dialogflow-settings.png)
 
 After going to the settings, choose the Export and Import tab. Choose `Restore from zip` to clone the project from the zip file.
-Read [the dialogflow docs](https://dialogflow.com/docs/agents/export-import-restore) for more information.
- 
+Read [the dialogflow docs](https://dialogflow.com/docs/agents/export-import-restore) for more information. 
 
 ### Webhook
 In order to deploy your webhook, you can use Heroku as a free and easy hosting service. This repository already contains 
@@ -46,6 +45,23 @@ Ensure that you update your DialogFlow project with the correct fulfillment URL.
 its requests. You can change this by going to [the DialogFlow console](https://console.dialogflow.com), and going to the fulfillment page for your agent. The domain
 there should correspond with your own domain, or the one generated for your Heroku project.
 
+## Usage
+Send requests from DialogFlow to the `/dialogflow/intent/handle` endpoint.
+Supported intents:
+- `next-departure` to get the next departures from a stop, with parameters:
+    - `transportation-method`: bust, tram, train, metro, ferry
+    - `location`: stop location name
+    
+- `plan-route` to plan a route from A to B, with parameters:
+    - `origin`: Origin stop location name
+    - `destination`: Destination stop location name
+    
+When using your own DialogFlow agen, ensure that both the intent action (for example `plan-route`) and parameters are 
+correctly configured in your agent. If they are not correctly configured, the intent will not be recognized correctly.
+An example configuration can be seen in the image below.
+
+![Dialogflow action and parameters](docs/dialogflow-action-parameters.png)
+
 ## Forking, reporting issues and creating pull requests
 
 This project is meant as an example and base to create your own, better version of it.

app/Http/Controllers/DialogFlowController.php

@@ -87,7 +87,7 @@ public static function buildDialogFlowResponse(string $responseText, bool $isEnd
      */
     public function redirectIntentToController()
     {
-        switch ($this->_dialogFlowPayload->getIntentDisplayName()) {
+        switch ($this->_dialogFlowPayload->getAction()) {
             case 'next-departure':
                 // There are likely nicer options to do this, and definitely a more efficient one,
                 // but it ain't stupid if it works
@@ -100,7 +100,7 @@ public function redirectIntentToController()
                 return $controller->getRoutePlanning();
             default:
                 return self::createTextToSpeechResponse(
-                    "I can only tell you about the next departures or plan routes for you");
+                    "I can only tell you about the next departures or plan routes for you.");
         }
     }
 

app/Http/Controllers/RoutePlanningController.php

@@ -61,8 +61,7 @@ public function getRoutePlanning()
 
             // In case no result was found, we tell this to user.
             if (count($response->getTrips()) == 0) {
-                return $this->createTextToSpeechResponse("I could not find any route " . strtolower($this->getDialogFlowPayload()->getParameter("transportation-method")) .
-                    " from " . $origin->getName() . " to " . $destination->getName());
+                return $this->createTextToSpeechResponse("I could not find any route from " . $origin->getName() . " to " . $destination->getName());
             }
 
             // We will tell the user about the first found result