LM_DialListAdvanced
Use this method to dial all the members of a list. This method allows you to set advanced options, including the time to send. If you don't need advanced options, use the LM_DialList
method.
Syntax
LM_DialListAdvanced(CallerID, CallerIDName, VoiceID, TextToSay, TryCount, Licensekey, Extension, TransferNumber, NextTryInSeconds, TTSRate, TTSVolume, ScheduledUTCDatetime, ListID, DialRecursiveLists)
Request Parameters
Parameter Name | Description | Data Type | Required | Sample Value |
---|---|---|---|---|
CallerID |
The number to display on the receiving party's Caller ID. |
String
|
False | |
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 | Esendex Services |
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 | |
TryCount |
The number of times to attempt dialing if the initial call is unanswered or busy. |
UnsignedByte
|
True | 3 |
Licensekey |
Your license key, which is required to invoke this web service. |
String
|
True | F01d89fd-5155-5455-5585-e84ab8de8591 |
Extension |
String
|
False | ||
TransferNumber |
The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands. |
String
|
False | |
NextTryInSeconds |
The number of seconds to wait until the next retry is performed if the original call is unanswered or busy. We recommend waiting at least 60 seconds. |
String
|
True | 3600 |
TTSRate |
The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the |
UnsignedByte
|
True | 7 |
TTSVolume |
The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 is the default). This can also be controlled within the |
UnsignedByte
|
True | 90 |
ScheduledUTCDatetime |
The date and time at which to send the call. This is specified as Coordinated Universal Time (UTC). |
DateTime
|
True | 2020-11-17T08:25:08.336Z |
ListID |
The ID of the list to dial. |
Integer
|
True | 937 |
DialRecursiveLists |
Boolean
|
True | False |
Response
Returns: LM_DialReturn
object
Code Samples
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/LM_DialListAdvanced"
<?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_DialListAdvanced xmlns="http://ws.esendex.us/NotifyWS/">
<lmFunctions>
<CallerID>string</CallerID>
<CallerIDName>string</CallerIDName>
<VoiceID>unsignedByte</VoiceID>
<TextToSay>string</TextToSay>
<TryCount>unsignedByte</TryCount>
<Licensekey>string</Licensekey>
<Extension>string</Extension>
<TransferNumber>string</TransferNumber>
<NextTryInSeconds>short</NextTryInSeconds>
<TTSRate>unsignedByte</TTSRate>
<TTSVolume>unsignedByte</TTSVolume>
<ScheduledUTCDatetime>dateTime</ScheduledUTCDatetime>
<ListID>int</ListID>
<DialRecursiveLists>boolean</DialRecursiveLists>
</lmFunctions>
</LM_DialListAdvanced>
</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_DialListAdvancedResponse xmlns="http://ws.esendex.us/NotifyWS/">
<LM_DialListAdvancedResult>
<Success>boolean</Success>
<BatchID>int</BatchID>
<ResponseCode>int</ResponseCode>
<ErrorText>string</ErrorText>
</LM_DialListAdvancedResult>
</LM_DialListAdvancedResponse>
</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>
<LM_DialListAdvanced xmlns="http://ws.esendex.us/NotifyWS/">
<lmFunctions>
<CallerID>string</CallerID>
<CallerIDName>string</CallerIDName>
<VoiceID>unsignedByte</VoiceID>
<TextToSay>string</TextToSay>
<TryCount>unsignedByte</TryCount>
<Licensekey>string</Licensekey>
<Extension>string</Extension>
<TransferNumber>string</TransferNumber>
<NextTryInSeconds>short</NextTryInSeconds>
<TTSRate>unsignedByte</TTSRate>
<TTSVolume>unsignedByte</TTSVolume>
<ScheduledUTCDatetime>dateTime</ScheduledUTCDatetime>
<ListID>int</ListID>
<DialRecursiveLists>boolean</DialRecursiveLists>
</lmFunctions>
</LM_DialListAdvanced>
</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_DialListAdvancedResponse xmlns="http://ws.esendex.us/NotifyWS/">
<LM_DialListAdvancedResult>
<Success>boolean</Success>
<BatchID>int</BatchID>
<ResponseCode>int</ResponseCode>
<ErrorText>string</ErrorText>
</LM_DialListAdvancedResult>
</LM_DialListAdvancedResponse>
</soap12:Body>
</soap12:Envelope>