NotifyMultiplePhoneBasic
Use this method to call multiple phone numbers in the US/Canada and read the value of TextToSay
to them.
Syntax
NotifyMultiplePhoneBasic(PhoneNumbersToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)
Request Parameters
Parameter Name | Description | Data Type | Required | Sample Value |
---|---|---|---|---|
PhoneNumbersToDial |
The phone numbers to call. Separate each number with a semicolon. |
String
|
9135550101; 9135550102; 9135550104 | |
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: Array of NotifyReturn
objects
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 NotifyMultiplePhoneBasic.WSDL;
namespace NotifyMultiplePhoneBasic
{
class Program
{
static void Main(string[] args)
{
WSDL.PhoneNotify PN = new WSDL.PhoneNotify();
Array Notifications = PN.NotifyMultiplePhoneBasic("17575449510;18009843710", "Hello, this is a test.", "17575551234", "Esendex", "0", "YOUR LICENSE KEY");
foreach (WSDL.NotifyReturn Info in Notifications)
{
Console.WriteLine(
"Queue ID: " + Info.QueueID + "\n" +
"Response Code: " + Info.ResponseCode + "\n" +
"Response Text: " + Info.ResponseText + "\n"
);
}
Console.ReadLine();
}
}
}
' https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Web Reference and given the name WSDL
Imports NotifyMultiplePhoneBasic.WSDL
Module Module1
Sub Main()
Dim PN As New WSDL.PhoneNotify
Dim Notifications As Array
Notifications = PN.NotifyMultiplePhoneBasic("17575449510;18009843710", "Hello, this is a test.", "17575551234", "Esendex", "0", "YOUR LICENSE KEY")
For Each Info As WSDL.NotifyReturn In Notifications
Console.WriteLine("QueueID: " & Info.QueueID & vbLf &
"Response Code: " & Info.ResponseCode & vbLf &
"Response Text: " & Info.ResponseText & vbLf)
Next
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>" & _
"<NotifyMultiplePhoneBasic xmlns=""http://ws.esendex.us/NotifyWS/"">" & _
"<PhoneNumbersToDial>17575449510;18009843710</PhoneNumbersToDial>" & _
"<TextToSay>Hello, this is a test.</TextToSay>" & _
"<CallerID>15551234567/CallerID>" & _
"<CallerIDname>CDYNE</CallerIDname>" & _
"<VoiceID>1</VoiceID>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</NotifyMultiplePhoneBasic>" & _
"</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 NotifyMultiplePhoneBasic {
public static void main(String[] args) {
try {
URL url = new URL("http://ws.esendex.us/NotifyWS/PhoneNotify.asmx/NotifyMultiplePhoneBasic?"
+ "PhoneNumbersToDial=17575449510;17575449510"
+ "&TextToSay=Hello+this+is+a+JAVA+test." + "&CallerID=18009843710"
+ "&CallerIDname=Testing" + "&VoiceID=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/NotifyMultiplePhoneBasic?PhoneNumbersToDial=string&TextToSay=string&CallerID=string&CallerIDname=string&VoiceID=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us
POST /NotifyWS/PhoneNotify.asmx/NotifyMultiplePhoneBasic HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length
PhoneNumbersToDial=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"?>
<ArrayOfNotifyReturn xmlns="http://ws.esendex.us/NotifyWS/">
<NotifyReturn>
<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>
<NotifyReturn>
<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>
</ArrayOfNotifyReturn>
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/NotifyMultiplePhoneBasic"
<?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>
<NotifyMultiplePhoneBasic xmlns="http://ws.esendex.us/NotifyWS/">
<PhoneNumbersToDial>string</PhoneNumbersToDial>
<TextToSay>string</TextToSay>
<CallerID>string</CallerID>
<CallerIDname>string</CallerIDname>
<VoiceID>string</VoiceID>
<LicenseKey>string</LicenseKey>
</NotifyMultiplePhoneBasic>
</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>
<NotifyMultiplePhoneBasicResponse xmlns="http://ws.esendex.us/NotifyWS/">
<NotifyMultiplePhoneBasicResult>
<NotifyReturn>
<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 xsi:nil="true" />
<Variable xsi:nil="true" />
</VariableArray>
</NotifyReturn>
<NotifyReturn>
<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 xsi:nil="true" />
<Variable xsi:nil="true" />
</VariableArray>
</NotifyReturn>
</NotifyMultiplePhoneBasicResult>
</NotifyMultiplePhoneBasicResponse>
</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>
<NotifyMultiplePhoneBasic xmlns="http://ws.esendex.us/NotifyWS/">
<PhoneNumbersToDial>string</PhoneNumbersToDial>
<TextToSay>string</TextToSay>
<CallerID>string</CallerID>
<CallerIDname>string</CallerIDname>
<VoiceID>string</VoiceID>
<LicenseKey>string</LicenseKey>
</NotifyMultiplePhoneBasic>
</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>
<NotifyMultiplePhoneBasicResponse xmlns="http://ws.esendex.us/NotifyWS/">
<NotifyMultiplePhoneBasicResult>
<NotifyReturn>
<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 xsi:nil="true" />
<Variable xsi:nil="true" />
</VariableArray>
</NotifyReturn>
<NotifyReturn>
<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 xsi:nil="true" />
<Variable xsi:nil="true" />
</VariableArray>
</NotifyReturn>
</NotifyMultiplePhoneBasicResult>
</NotifyMultiplePhoneBasicResponse>
</soap12:Body>
</soap12:Envelope>