Voice Broadcast API

LM_DialList

This method dials all the members of a list and reads aloud the contents of TextToSay. Additional options are available in the LM_DialListAdvanced method.

Syntax

LM_DialList(ListID, DialRecursiveLists, CallerID, CallerIDName, VoiceID, TextToSay, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The ID of the list to dial.	`Integer`	True	1234
DialRecursiveLists	Whether to dial child lists.	`Boolean`	True	False
CallerID	The number to display on the receiving party’s Caller ID.	`String`	True	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	`String`	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	`Byte`	True	2
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: LM_DialReturn 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 listId = 1234;
var dialRecursiveLists = false;
var callerId = "7575550000";
var callerIdName = "Esendex Services";
byte voiceId = 1;
var textToSay = "Hello, this is a test.";
var response = await client.LM_DialListAsync(
    listId, dialRecursiveLists, callerId, callerIdName, voiceId, textToSay, YOUR_LICENSE_KEY);

Console.WriteLine(
    "Success: " + response.Success + Environment.NewLine +
    "Response Code: " + response.ResponseCode + Environment.NewLine +
    "Batch ID: " + response.BatchID);
listMemberId

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 LM_DialList {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/LM_DialList?" + "ListID=0000"
                            + "&DialRecursiveLists=false" + "&CallerID=18009843710" + "&CallerIDName=Esendex"
                            + "&VoiceID=1" + "&TextToSay=This+is+a+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")
list_id = 1234
dial_recursive_lists = False
caller_id = "7575550000"
caller_id_name = "Esendex Services"
voice_id = 1
text_to_say = "Hello, this is a test."
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.LM_DialList(
    list_id,
    dial_recursive_lists,
    caller_id,
    caller_id_name,
    voice_id,
    text_to_say,
    license_key,
)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/LM_DialList?ListID=string&DialRecursiveLists=string&CallerID=string&CallerIDName=string&VoiceID=string&TextToSay=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

ListID=string&DialRecursiveLists=string&CallerID=string&CallerIDName=string&VoiceID=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/LM_DialList"

<?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>
    <LM_DialList xmlns="https://ws.esendex.us/NotifyWS/">
      <ListID>int</ListID>
      <DialRecursiveLists>boolean</DialRecursiveLists>
      <CallerID>string</CallerID>
      <CallerIDName>string</CallerIDName>
      <VoiceID>unsignedByte</VoiceID>
      <TextToSay>string</TextToSay>
      <LicenseKey>string</LicenseKey>
    </LM_DialList>
  </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>
    <LM_DialListResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LM_DialListResult>
        <Success>boolean</Success>
        <BatchID>int</BatchID>
        <ResponseCode>int</ResponseCode>
        <ErrorText>string</ErrorText>
      </LM_DialListResult>
    </LM_DialListResponse>
  </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>
    <LM_DialList xmlns="https://ws.esendex.us/NotifyWS/">
      <ListID>int</ListID>
      <DialRecursiveLists>boolean</DialRecursiveLists>
      <CallerID>string</CallerID>
      <CallerIDName>string</CallerIDName>
      <VoiceID>unsignedByte</VoiceID>
      <TextToSay>string</TextToSay>
      <LicenseKey>string</LicenseKey>
    </LM_DialList>
  </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>
    <LM_DialListResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LM_DialListResult>
        <Success>boolean</Success>
        <BatchID>int</BatchID>
        <ResponseCode>int</ResponseCode>
        <ErrorText>string</ErrorText>
      </LM_DialListResult>
    </LM_DialListResponse>
  </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"?>
<LM_DialReturn xmlns="https://ws.esendex.us/NotifyWS/">
  <Success>boolean</Success>
  <BatchID>int</BatchID>
  <ResponseCode>int</ResponseCode>
  <ErrorText>string</ErrorText>
</LM_DialReturn>

Let’s start sending, together.

Talk to an expert

Take a free trial