Sidebar Menu

LM_DialList

Use this method to dial all the members of a list. Use the LM_DialListAdvanced method to specify advanced options for dialing a list.

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 937
DialRecursiveLists Boolean True False
CallerID

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

String False 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 False CDYNE Corporation
VoiceID

The text-to-speech voice ID.

UnsignedByte True 1
TextToSay

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

String False
LicenseKey

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

String True F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: LM_DialReturn object

Code Samples

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("http://ws.cdyne.com/NotifyWS/PhoneNotify.asmx/LM_DialList?" + "ListID=0000"
                            + "&DialRecursiveLists=false" + "&CallerID=18009843710" + "&CallerIDName=CDYNE"
                            + "&VoiceID=1" + "&TextToSay=This+is+a+test+call."
                            + "&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/LM_DialList?ListID=string&DialRecursiveLists=string&CallerID=string&CallerIDName=string&VoiceID=string&TextToSay=string&LicenseKey=string HTTP/1.1
Host: ws.cdyne.com
POST /NotifyWS/PhoneNotify.asmx/LM_DialList HTTP/1.1
Host: ws.cdyne.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ListID=string&DialRecursiveLists=string&CallerID=string&CallerIDName=string&VoiceID=string&TextToSay=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"?>
<LM_DialReturn xmlns="http://ws.cdyne.com/NotifyWS/">
  <Success>boolean</Success>
  <BatchID>int</BatchID>
  <ResponseCode>int</ResponseCode>
  <ErrorText>string</ErrorText>
</LM_DialReturn>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.cdyne.com/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="http://ws.cdyne.com/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>
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="http://ws.cdyne.com/NotifyWS/">
      <LM_DialListResult>
        <Success>boolean</Success>
        <BatchID>int</BatchID>
        <ResponseCode>int</ResponseCode>
        <ErrorText>string</ErrorText>
      </LM_DialListResult>
    </LM_DialListResponse>
  </soap:Body>
</soap:Envelope>
POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
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="http://ws.cdyne.com/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>
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="http://ws.cdyne.com/NotifyWS/">
      <LM_DialListResult>
        <Success>boolean</Success>
        <BatchID>int</BatchID>
        <ResponseCode>int</ResponseCode>
        <ErrorText>string</ErrorText>
      </LM_DialListResult>
    </LM_DialListResponse>
  </soap12:Body>
</soap12:Envelope>