Voice Notifications

Overview

This guide shows how to send audio notifications using voice calls. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here, combining static text with dynamic information that Plivo gets from a variable.You can use voice notification for use cases such as:

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

Plivo requests an answer URL when the call is answered (step 4) and expects the file at that address to hold a valid XML response from the application with instructions on how to handle the call. To see how this works, you can use https://s3.amazonaws.com/static.plivo.com/notification.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

This code instructs Plivo to say, “Congratulations, your order was successfully placed” to the call recipient. You can find the entire list of valid Plivo XML verbs in our XML Reference documentation.

Prerequisites

To get started, you need a Plivo account — sign up with your work email address if you don’t have one already. If this is your first time using Plivo APIs, follow our instructions to set up a Node.js development environment.

Create a voice notification application in Node.js

Create a file called Makecall.js and paste into it this code.

var plivo = require('plivo');

(function main() {
    'use strict';

    var client = new plivo.Client("<auth_id>","<auth_token>");
    client.calls.create(
        "<caller_id>", // from
        "<destination_number>", // to
        "https://s3.amazonaws.com/static.plivo.com/notification.xml", // answer url
        {
            answerMethod: "GET",
        },
    ).then(function (response) {
        console.log(response);
    }, function (err) {
        console.error(err);
    });
})();

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use process.env to store environment variables and fetch them while initializing the client.

Test

Save the file and run it.

$ node Makecall.js

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in Ruby

Create a file called make_call.rb and paste into it this code.

require 'rubygems'
require 'plivo'

include Plivo
include Plivo::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")

begin
  response = api.calls.create(
    '<caller_id>',
    ['<destination_number>'],
    'https://s3.amazonaws.com/static.plivo.com/notification.xml'
  )
  puts response
rescue PlivoRESTError => e
  puts 'Exception: ' + e.message
end

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use ENV to store environment variables and fetch them when initializing the client.

Test

Save the file and run it.

$ ruby make_call.rb

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in Python

Create a file called make_call.py and paste into it this code.

import plivo

client = plivo.RestClient('<auth_id>','<auth_token>')
response = client.calls.create(
    from_='<caller_id>',
    to_='<destination_number>',
    answer_url='https://s3.amazonaws.com/static.plivo.com/notification.xml',
    answer_method='GET', )
print(response)

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use the os module (os.environ) to store environment variables and fetch them when initializing the client.

Test

Save the file and run it.

$ python make_call.py

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in PHP

Create a file called MakeCall.php and paste into it this code:

<?php
require 'vendor/autoload.php';
use Plivo\RestClient;

$auth_id    = "<auth_id>";
$auth_token = "<auth_token>";
$p          = new RestClient($auth_id, $auth_token);

$response = $client->calls->create('<caller_id>',
                                 ['<destination_number>'],
                                 'https://s3.amazonaws.com/static.plivo.com/notification.xml',);
print_r($response);

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use the $_ENV or putenv/getenv functions to store environment variables and fetch them when initializing the client.

Test

Save the file and run it.

$ php MakeCall.php

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in C#

In Visual Studio, open the file in the CS project called Program.cs and paste into it this code.

using System;
using System.Collections.Generic;
using Plivo;

namespace testplivo
{
    class Program
    {
        static void Main(string[] args)
        {
            var api = new PlivoApi("<auth_id>","<auth_token>");
            var response = api.Call.Create(
                to: new List<String> { "<destination_number>" },
                from: "<caller_id>",
                answerMethod: "GET",
                answerUrl: "https://s3.amazonaws.com/static.plivo.com/notification.xml"
            );
            Console.WriteLine(response);
        }
    }
}

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

<a href="https://docs.microsoft.com/en-us/dotnet/api/system.environment.setenvironmentvariable?view=netcore-3.1" rel="nofollow">Environment.SetEnvironmentVariable</a>

method to store environment variables and

<a href="https://docs.microsoft.com/en-us/dotnet/api/system.environment.getenvironmentvariable?view=netcore-3.1" rel="nofollow">Environment.GetEnvironmentVariable</a>

to fetch them when initializing the client.

Test

Save the file and run it.

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in Java

Create a Java class in the project MakeCall and paste into it this code.

import java.io.IOException;
import java.util.Collections;
import com.plivo.api.Plivo;
import com.plivo.api.exceptions.PlivoRestException;
import com.plivo.api.models.call.Call;
import com.plivo.api.models.call.CallCreateResponse;

class MakeCall {
    public static void main(String [] args) throws IOException, PlivoRestException {
        Plivo.init("<auth_id>","<auth_token>");
        CallCreateResponse response = Call.creator("<caller_id>",
                Collections.singletonList("<destination_number>"),
                "https://s3.amazonaws.com/static.plivo.com/notification.xml")
                .answerMethod("GET")
                .create();
        System.out.println(response);
    }
}

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use <a rel="nofollow" href="https://docs.oracle.com/javase/tutorial/essential/environment/env.html">System.getenv()</a> to store environment variables and retrieve them when initializing the client.

Test

Save the file and run it.

Overview

Order notification
Booking status
Delivery status
Flight cancellation/rescheduling
Two-factor authentication/one-time password
New offer notification
Account balance notification

Implement voice notification either by using our PHLO visual workflow builder or our APIs and XML documents. Follow the instructions in one of the tabs below.

Using XML

Here’s how to use Plivo APIs and XML to implement voice notifications.

How it works

<Response>
<Speak>Congratulations, your order was successfully placed</Speak>
</Response>

Prerequisites

Create a voice notification application in Go

Create a file called MakeCall.go and paste into it this code.

package main

import "fmt"
import "github.com/plivo/plivo-go/v7"

func main() {
	client, err := plivo.NewClient("<auth_id>","<auth_token>", &plivo.ClientOptions{})
	if err != nil {
			fmt.Print("Error", err.Error())
			return
		}
	response, err := client.Calls.Create(
		plivo.CallCreateParams{
			From: "<caller_id>",
			To: "<destination_number>",
			AnswerURL: "https://s3.amazonaws.com/static.plivo.com/notification.xml",
			AnswerMethod: "GET",
		},
	)
	if err != nil {
			fmt.Print("Error", err.Error())
			return
		}
	fmt.Printf("Response: %#v\n", response)
}

Replace the auth placeholders with your authentication credentials from the Plivo console. Replace the phone number placeholders with actual phone numbers in E.164 format (for example, +12025551234).

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and Plivo will automatically fetch the values from the environment variables. You can use the os.Setenv and os.Getenv functions to store environment variables and fetch them when initializing the client.

Test

Save the file and run it.

go run MakeCall.go

​Overview

​How it works

​Prerequisites

​Create a voice notification application in Node.js

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in Ruby

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in Python

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in PHP

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in C#

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in Java

​Test

​Overview

​How it works

​Prerequisites

​Create a voice notification application in Go

​Test

Overview

How it works

Prerequisites

Create a voice notification application in Node.js

Test

Overview

How it works

Prerequisites

Create a voice notification application in Ruby

Test

Overview

How it works

Prerequisites

Create a voice notification application in Python

Test

Overview

How it works

Prerequisites

Create a voice notification application in PHP

Test

Overview

How it works

Prerequisites

Create a voice notification application in C#

Test

Overview

How it works

Prerequisites

Create a voice notification application in Java

Test

Overview

How it works

Prerequisites

Create a voice notification application in Go

Test