Getting Started with SMS Notification

SMS Notification are used to send regular updates and notification to the users. Plivo’s PHLO allows you to quickly create and configure a SMS Notifications for your business. An API call will trigger the PHLO and will enable sending SMS messages to the customers.

Use Case Outline

Creating the Use Case using PHLO

With PHLO, you can quickly create a workflow that suits your use case. To use PHLO, make sure to register and log on to Plivo Console.

Use the following components to create this PHLO:

  • Send SMS

When you send an API request to the PHLO, it triggers a SMS message to the user using the Send SMS component. This is a simple use case, yet it is one of the most widely used.

Note: The Callback function provides the user details required to send the SMS message.

To create this PHLO

  1. On the top navigation bar, click PHLO. The PHLO page will appear and display your existing PHLOs, if any. If this is your first PHLO, then the PHLO page will be empty.
  2. Click CREATE NEW PHLO to build a new PHLO.
  3. On the Choose your use-case window, click Build my own. The PHLO canvas will appear with the Start node. Note: The Start node is the starting point of any PHLO. You can choose between the four available trigger states of the Start node; Incoming SMS, Incoming Call, Endpoint Call, and API Request. For this PHLO, we will use the API Request trigger state.
  4. Click the Start node to open the Configurations tab and then enter the information to retrieve from the HTTP Request payload. For example, this could be a list of numbers to send an SMS message to.
  5. Click Validate to save the configurations for the node.
  6. From the list of components, on the left hand side, drag and drop the Send SMS component onto the canvas. This will add a Send SMS node onto the canvas.
  7. Connect the Start node with the Send SMS node, using the API Request trigger state.
  8. Rename the node to Send_Notification. Note: You can rename the nodes as per your requirements. We are using specific names to help you relate to the different nodes used in this use case.
  9. Next, configure the Send SMS node to select the From and To numbers from the Start node. Note: The SMS message can be static or dynamic. In this example, we will use a combination of a static message along with some dynamic message.
  10. On the Send SMS Configurations tab, enter a static message (For example, Your order status is: ) in the Message field, followed by a variable to include the dynamic text. You can choose a variable by entering two curly brackets in the Speak Text field. Note:
  11. Enter two curly brackets to view all available variables.
  12. The values for the From and To numbers are picked from the HTTP Request Payload. Make sure to clearly define the variables in the Start node.
  13. Click Validate to save the configurations for the node.
  14. After you complete the configurations, click Save. You can trigger your PHLO using the PHLO URL to test it out.

Your complete PHLO will look like this:

SMS Notification

Triggering the PHLO from your SMS app

Once you have created and configured your PHLO, copy the PHLO Run URL. You can integrate a PHLO into your application workflow by making an API request to the PHLO URL with the required payload.

You can find the PHLO Run URLs on the PHLO Listing page.

Phlo List

Code Samples

1
2
3
4
5
6
7
8
9

import plivo

auth_id = 'Your AUTH ID'
auth_token = 'Your AUTH Token'
phlo_id = 'Your PHLO ID' # https://console.plivo.com/phlo/list/
phlo_client = plivo.phlo.RestClient(auth_id=auth_id, auth_token=auth_token)
phlo = phlo_client.phlo.get(phlo_id)
response = phlo.run()
print str(response)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

import com.plivo.api.Plivo;
import com.plivo.api.PlivoClient;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.phlo.Phlo;
import java.io.IOException;

public class Example
{
    private static final String authId = "Your AUTH ID";
    private static final String authToken = "Your AUTH Token";
    private static PlivoClient client = new PlivoClient(authId, authToken);
    public static void main(String[] args) throws IOException, PlivoRestException
    {
        String phloId = "Your PHLO ID";
        Plivo.init(authId, authToken);
        Phlo phlo = Phlo.getter(phloId).client(client).get();
        Map<String, Object> payload = new HashMap<>();
        payload.put("phone", "+1111111111");
        payload.put("to", "+1111111112");
        PhloUpdateResponse response = Phlo.updater(phloId).payload(payload).run();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

package main

import (
	"fmt"
	"plivo-go"
)

// Initialize the following params with corresponding values to trigger resources

const authId  = "auth_id"
const authToken = "auth_token"
const phloId = "phlo_id"

// with payload in request

func main() {
	testPhloRunWithParams()
}

func testPhloRunWithParams() {
	phloClient,err := plivo.NewPhloClient(authId, authToken, &plivo.ClientOptions{})
	if err != nil {
		panic(err)
	}
	phloGet, err := phloClient.Phlos.Get(phloId)
	if err != nil {
		panic(err)
	}
	//pass corresponding from and to values
	type params map[string]interface{}
	response, err := phloGet.Run(params{
		"from": "111111111",
		"to": "2222222222",
	})

	if (err != nil) {
		println(err)
	}
	fmt.Printf("Response: %#v\n", response)
}

// without payload in request

func main() {
	testPhloRunWithoutParams()
}

func testPhloRunWithoutParams() {
	phloClient,err := plivo.NewPhloClient(authId, authToken, &plivo.ClientOptions{})
	if err != nil {
		panic(err)
	}
	phloGet, err := phloClient.Phlos.Get(phloId)
	if err != nil {
		panic(err)
	}
	response, err := phloGet.Run(nil)
	if err != nil {
		panic(err)
	}
	fmt.Printf("Response: %#v\n", response)

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<?php
/**
 * Example for API Request
 */
require 'vendor/autoload.php';
use Plivo\Resources\PHLO\PhloRestClient;
use Plivo\Exceptions\PlivoRestException;
$client = new PhloRestClient("YOUR_AUTH_ID", "YOUR_AUTH_TOKEN");
$phlo = $client->phlo->get("YOUR_PHLO_ID");
try {
    $response = $phlo->run(["field1" => "value1", "field2" => "value2"]); // These are the fields entered in the PHLO console
    print_r($response);
} catch (PlivoRestException $ex) {
    print_r($ex);
}
?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

var plivo = require('../dist/rest/client.js');
var PhloClient = plivo.PhloClient;

var authId = 'auth-id';
var authToken = 'auth-token';
var phloId = 'PHLO_ID';
var phloClient = phlo = null;

// Run phlo
phloClient = new PhloClient(authId, authToken);
phloClient.phlo(phloId).run().then(function (result) {
    console.log('Phlo run result', result);
}).catch(function (err) {
    console.error('Phlo run failed', err);
});

You can install the server SDKs and setup your development environment by referring to the instructions available in the below links:

Server SDKs
Setup your development environment

You can get your Auth_ID and Auth_token from your dashboard

AuthID

You can find the PHLO_ID on the PHLO Listing page.

Phlo Listing

Uses of this PHLO

You can also use this PHLO structure for other use cases, like:

  • Promotional notification
  • Package tracking
  • Order Notifications