Voice Alerts/Notifications Broadcasting

Node

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a file called Broadcast.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_number1<destination_number2", // to
        "https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

node Broadcast.js

Ruby

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a file called broadcast.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_number1>', '<destination_number2>'],
    'https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

Note: We recommend that you store your credentials in the auth_id and auth_token environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialize the client with no arguments and it will automatically fetch them 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 broadcast.rb

Python

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a file called broadcast.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_number1<destination_number2',
    answer_url='https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

python broadcast.py

PHP

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a file called broadcast.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_number1<destination_number2',
    answer_url='https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

php Broadcast.php

.NET

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

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_number1>", "<destination_number2>" },
                from: "<caller_id>",
                answerMethod: "GET",
                answerUrl: "https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

Java

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a Java class in the project called Broadcast 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_number1>", "<destination_number2>"),
                "https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

Go

Overview

This guide shows how to broadcast voice messages to multiple recipients at once. You can play recorded audio when the call recipient answers or use text-to-speech, as we show here.

You can use voice broadcasting for use cases such as:

• Bulk voice calling campaigns
• Emergency notifications
• Survey campaigns
• User feedback
• Announcements
• Promotions and special deals
• Reminder campaigns

You can broadcast voice alerts 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 broadcast voice alerts and notifications using XML.

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/broadcast.xml as an answer URL to test your first outgoing call. The file contains this XML code:

<Response>
<Speak>Congratulations! You have made your first bulk call.</Speak>
</Response>

This code instructs Plivo to say, “Congratulations! You have made your first bulk call” to the call recipients. 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 Ruby development environment and a web server and safely expose that server to the internet.

Create voice alert broadcast application

Create a file called Broadcast.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_number1<destination_number2",
			AnswerURL: "https://s3.amazonaws.com/static.plivo.com/broadcast.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, [phone]). Destination numbers may also be SIP endpoints, in which case each destination_number placeholder must be a valid SIP URI — for example, sip:[e-mail].

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

Test

Save the file and run it.

go run Broadcast.go