Sidebar Menu

NotifyPhoneBasicWithTryCount

Use this method to call any phone number in the US/Canada and read the value of TextToSay to that phone number. Use the TryCount parameter to specify the number of times the operation should retry the call if the original call is unanswered or busy.

Syntax

NotifyPhoneBasicWithTryCount(TryCount, PhoneNumberToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name Description Data Type Required Sample Value
TryCount

The number of retries to attempt if original call is unanswered or busy. The maximum is 3.

 String 2
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 9135550101
TextToSay

The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.

 String Hello, this is a sample call from Phone Notify.
CallerID

The number to display on the receiving party's Caller ID.

 String 7575449510
CallerIDName

The name to display on the receiving party's Caller ID. (Not commonly used, because most carriers will use their own directory assistance to display name information.)

 String Esendex Services
VoiceID

The text-to-speech voice ID.

 String 2
LicenseKey

Your license key, which is required to invoke this web service.

 String F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: NotifyReturn object

Code Samples

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using NotifyPhoneBasicWithTryCount.WSDL;

namespace NotifyPhoneBasicWithTryCount
{
    class Program
    {
        static void Main(string[] args)
        {
            WSDL.PhoneNotify PN = new WSDL.PhoneNotify();
            WSDL.NotifyReturn NR = new WSDL.NotifyReturn();

            NR = PN.NotifyPhoneBasicWithTryCount(3, "17575449510", "Hello this is a test.", "18009843710", "Esendex Test", "0", "YOUR LICENSE KEY");

            Console.WriteLine(
                "QueueID: " + NR.QueueID + "\n" +
                "Response Code: " + NR.ResponseCode + "\n" +
                "Response Text: " + NR.ResponseText
            );

            Console.ReadLine();
        }
    }
}

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

Imports NotifyPhoneBasicWithTryCount.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim NR As New WSDL.NotifyReturn

        NR = PN.NotifyPhoneBasicWithTryCount(3, "17575449510", "Hello this is a test.", "18009843710", "Esendex Test", "0", "YOUR LICENSE KEY")

        Console.WriteLine("QueueID: " & NR.QueueID & vbLf &
                        "Response Code: " & NR.ResponseCode & vbLf &
                        "Response Text: " & NR.ResponseText & vbLf)

        Console.ReadLine()

    End Sub

End Module

Dim request, oXMLHttp, url
url = "http://ws.esendex.us/NotifyWS/PhoneNotify.asmx"

request = "<?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>" & _
"<NotifyPhoneBasicWithTryCount xmlns=""http://ws.esendex.us/NotifyWS/"">" & _
"<PhoneNumberToDial>17575449510</PhoneNumberToDial>" & _
"<TransferNumber>18009843710</TransferNumber>" & _
"<TextToSay>Hello, this is a test.</TextToSay>" & _
"<CallerID>15551234567</CallerID>" & _
"<CallerIDname>CDYNE</CallerIDname>" & _
"<VoiceID>1</VoiceID>" & _
"<TryCount>1</TryCount>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</NotifyPhoneBasicWithTryCount>" & _
"</soap:Body>" & _
"</soap:Envelope>"

Set oXMLHttp = CreateObject("MSXML2.ServerXMLHTTP")
oXMLHttp.open "POST", url, False
oXMLHttp.setRequestHeader "Content-Type", "text/xml; charset=utf-8"
oXMLHttp.send request
response = oXMLHttp.responseText

MsgBox oXMLHTTP.responseText
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 NotifyPhoneBasicWithTryCount {
    public static void main(String[] args) {
        try {
            URL url = new URL("http://ws.esendex.us/NotifyWS/PhoneNotify.asmx/NotifyPhoneBasicWithTryCount?"
                            + "PhoneNumberToDial=17575449510" + "&TextToSay=JAVA+Test+call"
                            + "&CallerID=180098443710" + "&CallerIDname=TEST" + "&VoiceID=1" + "&TryCount=1"
                            + "&LicenseKey=f01d89fd-5155-5455-5585-e84ab8de8591");
            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) {
        }
    }
}

GET /NotifyWS/PhoneNotify.asmx/NotifyPhoneBasicWithTryCount?TryCount=string&PhoneNumberToDial=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us
POST /NotifyWS/PhoneNotify.asmx/NotifyPhoneBasicWithTryCount HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length

TryCount=string&PhoneNumberToDial=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=string&LicenseKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<NotifyReturn xmlns="http://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>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.esendex.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.esendex.us/NotifyWS/NotifyPhoneBasicWithTryCount"

<?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>
    <NotifyPhoneBasicWithTryCount xmlns="http://ws.esendex.us/NotifyWS/">
      <TryCount>short</TryCount>
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasicWithTryCount>
  </soap:Body>
</soap:Envelope>
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>
    <NotifyPhoneBasicWithTryCountResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <NotifyPhoneBasicWithTryCountResult>
        <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>
      </NotifyPhoneBasicWithTryCountResult>
    </NotifyPhoneBasicWithTryCountResponse>
  </soap:Body>
</soap:Envelope>
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>
    <NotifyPhoneBasicWithTryCount xmlns="http://ws.esendex.us/NotifyWS/">
      <TryCount>short</TryCount>
      <PhoneNumberToDial>string</PhoneNumberToDial>
      <TextToSay>string</TextToSay>
      <CallerID>string</CallerID>
      <CallerIDname>string</CallerIDname>
      <VoiceID>string</VoiceID>
      <LicenseKey>string</LicenseKey>
    </NotifyPhoneBasicWithTryCount>
  </soap12:Body>
</soap12:Envelope>
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>
    <NotifyPhoneBasicWithTryCountResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <NotifyPhoneBasicWithTryCountResult>
        <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>
      </NotifyPhoneBasicWithTryCountResult>
    </NotifyPhoneBasicWithTryCountResponse>
  </soap12:Body>
</soap12:Envelope>