Getting Started with Voice Notifications

You can send an audio notification to the user using Voice Calls. Plivo’s PHLO allows you to quickly create and configure a voice alert system for your business. An API call from your application will trigger the PHLO and will enable making direct calls to the customers with critical alerts.

Use Case Outline

Creating the Use Case using PHLO

With PHLO, you can quickly create a workflow that suits your use case. Make sure you are registered and logged in on Plivo Console to proceed.

Use the following components to create this PHLO:

  • Initiate Call
  • Play Audio

When the application send an API request to the PHLO, it triggers a call to the user’s phone number using the Initiate Call component. Once the user answers the call, the Play Audio component plays an audio to the user. The call will disconnect automatically after the playback audio is completed.

Note: The Callback function provides the user details required to make the call.

To create this PHLO:

  • 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.

    Console Top Nav Bar

  • Click CREATE NEW PHLO to build a new PHLO.

    Console Create New PHLO

  • 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.
  • Click the Start node to open the Configurations tab.

  • Then, enter the information to retrieve from the HTTP Request payload. For example, this could be a variable for the list of numbers to call.

  • From the list of components, on the left hand side, drag and drop the Initiate Call component onto the canvas. This will add a Initiate call node onto the canvas.

  • Connect the Start node with the Initiate Call node, using the API Request trigger state.

  • 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.

  • Next, to configure the From and To numbers in the Initiate Call node, use the variables set in the Start node. Note:

    • Enter two curly brackets to view all available variables.

    • 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.

  • Similarly, create a node for the Play Audio component and connect it to the Initiate Call node using the Answered trigger state.

  • Next, configure the Play Audio node to play a specific message to the user.

    Note:

    • The audio playback can either be static or dynamic. In this example, we will use a combination of a static message along with some dynamic message.
    • On the Play Audio Configurations tab, enter a static message (For example, Your Flight status is:) in the Speak Text field, followed by a variable to include the dynamic text.
Note:
  • You can choose a variable by entering two curly brackets in the Speak Text field.
  • Make sure you validate the configuration for each node.

  • 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:

    Voice Notification

Triggering the PHLO from your Voice 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.

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:

  • Order notification
  • Booking status
  • Delivery status
  • Flight cancellation/reschedule
  • Two-Factor Authentication/One-Time Password
  • New Offer notification
  • Account balance notification