Quickstart

Overview

The purpose of this guide is to help you create a working sample of the Send SMS and Start Job activities. This working sample enables you to quickly verify the connection to your Upwire account and get familiar with the activity's input/output datatypes.

By completing the steps in this guide, you'll have an automation sequence that does the following:

1. Establishes a connection to your Upwire account via the Upwire Scope activity.
2. Starts a job that runs a Send SMS template flow via the Start Job activity (your mobile will receive an SMS message)
3. Sends a second SMS message (after the Send SMS template flow) via the Send SMS activity (your mobile will receive a second SMS message).

Prerequisites

Before you begin:

1. Complete the Upwire Setup steps.

2. Create a new automation project.

   1. Open UiPath Studio.
   2. Under New Project, click Process (this opens a New Blank Process window).
   3. Enter a project Name,Location, and Description.

   4. Click Create.

      
      

      

      
      

3. Install the UiPath.Upwire.Activities package.

   1. In the Design ribbon, click Manage Packages (this opens the Manage Packages window).
   2. Under All Packages, click Go!
   3. In the Search bar, enter Upwire.

   4. Click, install and accept the license for the UiPath.Upwire.Activities.

      • For more information about Uipath Studio packages, see Managing Packages in the Studio Guide.

        
        

        

        
        

Steps

Create an SMS Flow Template

To demonstrate and validate the Upwire activities, you'll first create a simple Send SMS flow template in your Upwire account.

1. Login to your Upwire account.

2. From your account dashboard, click the Start an SMS, Voice and Email flow icon.

   1. Enter a Project Name (e.g. UpwireQuickstart),
   2. Under Where will the data for the UpwireQuickstart project come from?, click the Use our Builder icon and click the down arrow to proceed (you will do this after each step).
   3. Under Build Data Table, remove all default variables except for mobile and name.
   4. Under Contact details, click the SMS icon and select mobile.
   5. Under Select or Unselect columns that you wish to include for message personalization, select name and unselect mobile.
   6. Under What kind of service would you like to start with, select the SMS Template icon (this opens your new flow template)
   7. Click the phone icon in the center of the page.
   8. Click the Open Builder icon.

   9. Assign an Upwire number to the template (if you don't see a number available, click the Buy new number link) and enter an SMS message that you want to send (e.g., Hello from Upwire).

      • Take note of or copy the Template ID. You'll need this value for the Start Job activity you'll add in the next section of this guide.

        
        

        

        
        

Schedule Your Template

If you haven't already, follow the Setup steps to schedule your template to wait for API call.

Build Your Project

1. Add the Upwire Scope activity to your project.

   1. Enter your Upwire account Username.
   2. In the Passtoken property, enter your Upwire account passcode.
      • Your account passtoken is different from the password associated with your username.
      • For more information and to see how to find your passtoken, see Get your account passcode in the Setup guide
   3. Add the Start Job activity after the Upwire Scope activity.
   4. Enter the TemplateID of the template you created in the steps above.
   5. In the Data property, create a Collection that includes a mobile String variable (i.e., the variables you added under Build Data Table in step 3 above).
      1. To validate the success of the activities, create a String variable with your mobile number as the default value (including the country code and without spaces or dashes between the digits).
      2. Enter your String variable as the value for the mobile variable you entered in your Collection.
   6. Create and enter a String variable for the JobID.

2. Add the Send SMS activity after the Start Job activity.

   1. In the From property, enter the number you assigned to your Send SMS template in step 9 above.
   2. In the To property, enter your mobile number String variable.

   3. Enter the Message that you want to send to your mobile. In our example, we entered: "Job: " +jobID+ " completed successfully!"

      
      

      

      
      

Run Your Project

1. Click Run and verify that you receive 2 SMS messages to your mobile phone:

   1. Hello from Upwire (i.e., the message content entered in the Send SMS flow template)
   2. Job: VALUE completed successfully! (i.e., the content you entered in the Send SMS activity's Message property).

You're done!

To learn more about the Upwire activities, see the Activities page for a complete activity list and links to the activity detail pages.