Voice Broadcast API

NotifyPhoneEnglishBasic

This method calls any phone number and read aloud the contents of TextToSay using the voice of Diane (VoiceID: 0). Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneEnglishBasic(PhoneNumberToDial, TextToSay, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add `x` followed by the extension.	`String`	True	7575559999
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	`String`	True	Hello, this is a sample call from Phone Notify.
LicenseKey	Your license key.	`String`	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

Code Samples

You can use any programming language you want with our API, as long as it can make a REST or SOAP call. Here are examples for some of the most common platforms.

C#
Java
Python
GET Request
POST Request
SOAP 1.1 Request
SOAP 1.1 Response
SOAP 1.2 Request
SOAP 1.2 Response
XML Response

C#

/* https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Service Reference and given the name WSDL */

using WSDL;

var client = new PhoneNotifySoapClient(PhoneNotifySoapClient.EndpointConfiguration.PhoneNotifySoap);
var textToSay = "Hello, this is a test call.";
var response = await client.NotifyPhoneEnglishBasicAsync(
    YOUR_TO_NUMBER, textToSay, YOUR_LICENSE_KEY);

Console.WriteLine(
    "QueueID: " + response.QueueID + Environment.NewLine +
    "Response Code: " + response.ResponseCode + Environment.NewLine +
    "Response Text: " + response.ResponseText
);

Java

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

public final class NotifyPhoneBasicEnglish {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/NotifyPhoneEnglishBasic?"
                            + "PhoneNumberToDial=17575449510" + "&TextToSay=Java+test+call."
                            + "&LicenseKey=00000000-0000-0000-0000-000000000000");
            try {
                InputStream in = url.openStream();
                StreamSource source = new StreamSource(in);
                printResult(source);
            } catch (java.io.IOException e) {
                e.printStackTrace();
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    private static void printResult(Source source) {
        try {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            StreamResult sr = new StreamResult(bos);
            Transformer trans = TransformerFactory.newInstance().newTransformer();
            Properties oprops = new Properties();
            oprops.put(OutputKeys.OMIT_XML_DECLARATION, "yes");
            trans.setOutputProperties(oprops);
            trans.transform(source, sr);
            System.out.println("**** Response ******");
            System.out.println(bos.toString());

            bos.close();
            System.out.println();
        } catch (Exception e) {
        }
    }
}

Python

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
phone_number_to_dial = "17575559999"
text_to_say = "Hello, this call was sent with Python."
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.NotifyPhoneEnglishBasic(
    phone_number_to_dial, text_to_say, license_key
)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/NotifyPhoneEnglishBasic?PhoneNumberToDial=string&TextToSay=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

POST /NotifyWS/PhoneNotify.asmx/NotifyPhoneEnglishBasic HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

PhoneNumberToDial=string&TextToSay=string&LicenseKey=string

SOAP 1.1 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ws.esendex.us/NotifyWS/NotifyPhoneEnglishBasic"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <NotifyPhoneEnglishBasic xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneEnglishBasic>
  </soap:Body>
</soap:Envelope>

SOAP 1.1 Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <NotifyPhoneEnglishBasicResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <NotifyPhoneEnglishBasicResult>
        <ResponseCode>int</ResponseCode>
        <ResponseText>string</ResponseText>
        <CallAnswered>boolean</CallAnswered>
        <QueueID>long</QueueID>
        <TryCount>int</TryCount>
        <Demo>boolean</Demo>
        <DigitsPressed>string</DigitsPressed>
        <MachineDetection>string</MachineDetection>
        <Duration>int</Duration>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
        <MinuteRate>decimal</MinuteRate>
        <Country>string</Country>
        <CallComplete>boolean</CallComplete>
        <TextToSay>string</TextToSay>
        <VariableArray>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
        </VariableArray>
      </NotifyPhoneEnglishBasicResult>
    </NotifyPhoneEnglishBasicResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <NotifyPhoneEnglishBasic xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneEnglishBasic>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.2 Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <NotifyPhoneEnglishBasicResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <NotifyPhoneEnglishBasicResult>
        <ResponseCode>int</ResponseCode>
        <ResponseText>string</ResponseText>
        <CallAnswered>boolean</CallAnswered>
        <QueueID>long</QueueID>
        <TryCount>int</TryCount>
        <Demo>boolean</Demo>
        <DigitsPressed>string</DigitsPressed>
        <MachineDetection>string</MachineDetection>
        <Duration>int</Duration>
        <StartTime>dateTime</StartTime>
        <EndTime>dateTime</EndTime>
        <MinuteRate>decimal</MinuteRate>
        <Country>string</Country>
        <CallComplete>boolean</CallComplete>
        <TextToSay>string</TextToSay>
        <VariableArray>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
          <Variable>
            <VariableName>string</VariableName>
            <VariableValue>string</VariableValue>
          </Variable>
        </VariableArray>
      </NotifyPhoneEnglishBasicResult>
    </NotifyPhoneEnglishBasicResponse>
  </soap12:Body>
</soap12:Envelope>

XML Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<NotifyReturn xmlns="https://ws.esendex.us/NotifyWS/">
  <ResponseCode>int</ResponseCode>
  <ResponseText>string</ResponseText>
  <CallAnswered>boolean</CallAnswered>
  <QueueID>long</QueueID>
  <TryCount>int</TryCount>
  <Demo>boolean</Demo>
  <DigitsPressed>string</DigitsPressed>
  <MachineDetection>string</MachineDetection>
  <Duration>int</Duration>
  <StartTime>dateTime</StartTime>
  <EndTime>dateTime</EndTime>
  <MinuteRate>decimal</MinuteRate>
  <Country>string</Country>
  <CallComplete>boolean</CallComplete>
  <TextToSay>string</TextToSay>
  <VariableArray>
    <Variable>
      <VariableName>string</VariableName>
      <VariableValue>string</VariableValue>
    </Variable>
    <Variable>
      <VariableName>string</VariableName>
      <VariableValue>string</VariableValue>
    </Variable>
  </VariableArray>
</NotifyReturn>

Let’s start sending, together.

Talk to an expert

Take a free trial