Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Employee Directory with C# and ASP.NET MVC

Download the Code

This ASP.NET application is an Employee Directory that can be used from any SMS client to find an employee's contact information. To build this app, we will need to:

  • Create an Employee model
  • Receive an incoming SMS
  • Search for an Employee by name
  • Respond with an outgoing MMS
Let's get started!

Create an Employee Model

The first thing we need is a database of employees. We will be using Entity Framework (EF) Code First for this. That means we can use a POCO (Plain Old CLR Object) to represent our employees.

Our employee entity has a few fields for contact information, including their name, phone number, and a public URL containing an image of them.

Loading Code Sample...
      
      
          
          
          
          
        
      EmployeeDirectory.Web/Models/Employee.cs

      The Employee Model

      EmployeeDirectory.Web/Models/Employee.cs

      Now that we have a model that represents an employee, let's see how to search for employees by name.

      Search for an Employee by Name

      Search for an Employee by Name

      The EmployeeDirectoryService class allows us to search the database for employees either by name or by their unique database identifier. When searching by name, we'll return a list of employees whose name might match a search query, or just one if we find an exact match. If we know the ID of the employee we're looking for, we can return it right away.

      Loading Code Sample...
          
          
              
              
              
              
            
          EmployeeDirectory.Web/Services/EmployeeDirectoryService.cs

          Employee Search Service

          EmployeeDirectory.Web/Services/EmployeeDirectoryService.cs

          Now, let's use this search functionality when responding to an SMS from a user.

          Receive an incoming SMS

          Receive an incoming SMS

          When your number receives an SMS message, Twilio will send an HTTP POST request to our application. This will be handled by the Lookup action in EmployeeController.

          We check for numeric input (more on that later) or perform a lookup for the desired employee. The results are packaged up as a XML and sent back to Twilio and, in turn, the original sender of the SMS.

          Loading Code Sample...
              
              
                  
                  
                  
                  
                
              EmployeeDirectory.Web/Controllers/EmployeeController.cs

              Employee Lookup Action Method

              EmployeeDirectory.Web/Controllers/EmployeeController.cs

              Now that we have our search route, let's see how we can request a specific employee by name.

              Respond with Single Match for an Employee Name

              Respond with Single Match for an Employee Name

              Let's say the service finds a single employee matching the text message. In this case, we simply write out a response that contains the employee's contact information, including a photo, making our response a MMS message.

              Loading Code Sample...
                  
                  
                      
                      
                      
                      
                    
                  EmployeeDirectory.Web/Controllers/EmployeeController.cs

                  Get Twilio Response For Search Result

                  EmployeeDirectory.Web/Controllers/EmployeeController.cs

                  As you can see, The Twilio C# Helper Library simplifies the way you can generate and send SMS messages. Together with a simple database query, the application is able to return valuable information over SMS. Let's see how we handle multiple or no results next.

                  Handle Multiple or No Results

                  Handle Multiple or No Results

                  If we don't find any employees, we can simply return a "Not found" message.

                  What about multiple matches? For this case, we want to return a list of the matching employees' names along with an incrementing number the end user can use to make their selection. For example, if someone searched for "David" they might get something like:

                  We found: 1-David Prothero, 2-David Smith
                   - Reply with # of desired person
                  
                  Loading Code Sample...
                      
                      
                          
                          
                          
                          
                        
                      EmployeeDirectory.Web/Controllers/EmployeeController.cs

                      Get TwiML for Multiple Results

                      EmployeeDirectory.Web/Controllers/EmployeeController.cs

                      Let's see how these options are stored next.

                      Cache the List of Possible Matches

                      Cache the List of Possible Matches

                      For the message text returned to the user, we build a numbered menu of possible matches.

                      Our app needs to remember — between SMS messages from the user — the mapping of the 1, 2, 3 selection numbers to the actual unique ID's of employees. You will notice we are placing them in a cookie, which Twilio will send back with every HTTP request to our application.

                      Loading Code Sample...
                          
                          
                              
                              
                              
                              
                            
                          EmployeeDirectory.Web/Controllers/EmployeeController.cs

                          Get TwiML Response for Employee List

                          EmployeeDirectory.Web/Controllers/EmployeeController.cs

                          When the user that queried the employee directory receives the message with a list of employees, they will text back a number that corresponds to the result on the list that they are interested in querying further. Twilio will send a request to the webhook which handles incoming SMS messages. At this point, our app will try to parse the user's message to determine what to do next.

                          Return Employee's Contact Information by Number Choice

                          Return Employee's Contact Information by Number Choice

                          When we receive an SMS message, we check whether:

                          • The body of the text input is, in fact, a number.
                          • A cookie exists with the mapping of numbers to ID's.
                          • The mappings contain the number sent to us by the user.

                          If any of those checks fail, then we'll simply proceed with our typical name lookup.

                          However, if those conditions are all met, we return a single employee that matches their selection.

                          Loading Code Sample...
                              
                              
                                  
                                  
                                  
                                  
                                
                              EmployeeDirectory.Web/Controllers/EmployeeController.cs

                              Cached Employee Lookup Logic

                              EmployeeDirectory.Web/Controllers/EmployeeController.cs

                              The only thing left to do is celebrate.

                              You've come pretty far. Take a look at the code on GitHub to run the application yourself. There you will find the complete Visual Studio solution and instructions for getting up and running.

                              Where to Next?

                              Where to Next?

                              If you're a C# developer working with Twilio, you might want to check out these other tutorials.

                              Two-Factor Authentication

                              Appointment Reminders

                              Did this help?

                              Thanks for checking out this tutorial! If you have any feedback to share with us, we'd love to hear it. Tweet @twilio to let us know what you think!

                              David Prothero Jose Oliveros Agustin Camino Hector Ortega  Kat King

                              Need some help?

                              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                              Loading Code Sample...