Esendex USA logo
Talk to an expert
Get a quote

NotifyPhoneBasic

Quick Start

Methods

Types

This method calls any phone number and read aloud the contents of TextToSay. Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneBasic(PhoneNumberToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter NameDescriptionData TypeRequiredSample Value
PhoneNumberToDialThe 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.StringTrue7575559999
TextToSayThe text-to-speech text or combination of text-to-speech and script to be read to the receiving party.StringTrueHello, this is a sample call from Phone Notify.
CallerIDThe number to display on the receiving party’s Caller ID.StringFalse (may be an empty string)7575550000
CallerIDnameThe name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)StringFalse (may be an empty string)Esendex Services
VoiceIDThe text-to-speech voice ID.StringTrue2
LicenseKeyYour license key.StringTrue00000000-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#

/* 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 callerId = "7575550000";
var callerIdName = "Esendex Services";
var voiceId = "1";
var response = await client.NotifyPhoneBasicAsync(
    YOUR_TO_NUMBER, textToSay, callerId, callerIdName, voiceId, 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 NotifyPhoneBasic {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/NotifyPhoneBasic?"
                            + "PhoneNumberToDial=17575449510" + "&TextToSay=JAVA+Test+call" + "&CallerID=180098443710"
                            + "&CallerIDName=Esendex" + "&VoiceID=1" + "&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."
caller_id = "7575550000"
caller_id_name = "Esendex Services"
voice_id = 1
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.NotifyPhoneBasic(
    phone_number_to_dial, text_to_say, caller_id, caller_id_name, voice_id, license_key
)

print(result)

GET Request

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

POST Request

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

PhoneNumberToDial=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=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/NotifyPhoneBasic"

<?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>
    <NotifyPhoneBasic xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasic>
  </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>
    <NotifyPhoneBasicResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <NotifyPhoneBasicResult>
        <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>
      </NotifyPhoneBasicResult>
    </NotifyPhoneBasicResponse>
  </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>
    <NotifyPhoneBasic xmlns="https://ws.esendex.us/NotifyWS/">
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasic>
  </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>
    <NotifyPhoneBasicResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <NotifyPhoneBasicResult>
        <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>
      </NotifyPhoneBasicResult>
    </NotifyPhoneBasicResponse>
  </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 get your business buzzing

Spark customer connections in minutes. Discover the full power of our mobile messaging platform—no hidden fees, just real results.

Get a quote
Talk to an expert
Esendex USA logo
Industries
Developers
Contact
Talk to an expert
Get a quote