LM_AddNewList
Use this method to create a list. Lists are used to store a list of contacts (members). Use the LM_DialList
method to send a message to all the members of a list.
Syntax
LM_AddNewList(ListName, ParentListID, LicenseKey)
Request Parameters
Parameter Name | Description | Data Type | Required | Sample Value |
---|---|---|---|---|
ListName |
The name you want to apply to the new list. |
String
|
True | List Three |
ParentListID |
The ID of a list which will be this list's parent. If you don't want your list to have a parent, set this value to |
Integer
|
True | 936 |
LicenseKey |
Your license key, which is required to invoke this web service. |
String
|
True | F01d89fd-5155-5455-5585-e84ab8de8591 |
Response
Returns: Integer
Description: The ID that the system assigned to the list. You will need this ID to alter or send messages to the list.
Sample:
937
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 System.Threading.Tasks;
using LM_AddNewList.WSDL;
namespace LM_AddNewList
{
class Program
{
static void Main(string[] args)
{
WSDL.PhoneNotify PN = new PhoneNotify();
int ListID = PN.LM_AddNewList("Test List", 0, "YOUR LICENSE KEY");
Console.WriteLine("List ID: " + ListID);
Console.ReadLine();
}
}
}
' https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Web Reference and given the name WSDL
Imports LM_AddNewList.WSDL
Module Module1
Sub Main()
Dim PN As New PhoneNotify
Dim List As Integer
List = PN.LM_AddNewList("Test List", 0, "YOUR LICENSE KEY")
Console.WriteLine("List ID: " & List)
Console.ReadLine()
End Sub
End Module
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_AddNewList {
public static void main(String[] args) throws Exception {
try {
URL url = new URL("http://ws.esendex.us/NotifyWS/PhoneNotify.asmx/LM_AddNewList?" + "&ListName=Customers"
+ "&ParentListID=0" + "&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_AddNewList?ListName=string&ParentListID=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us
POST /NotifyWS/PhoneNotify.asmx/LM_AddNewList HTTP/1.1
Host: ws.esendex.us
Content-Type: application/x-www-form-urlencoded
Content-Length: length
ListName=string&ParentListID=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"?>
<int xmlns="http://ws.esendex.us/NotifyWS/">int</int>HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://ws.esendex.us/NotifyWS/">int</int>HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://ws.esendex.us/NotifyWS/">int</int>HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://ws.esendex.us/NotifyWS/">int</int>HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<int xmlns="http://ws.esendex.us/NotifyWS/">int</int>
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_AddNewList"
<?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_AddNewList xmlns="http://ws.esendex.us/NotifyWS/">
<ListName>string</ListName>
<ParentListID>int</ParentListID>
<LicenseKey>string</LicenseKey>
</LM_AddNewList>
</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_AddNewListResponse xmlns="http://ws.esendex.us/NotifyWS/">
<LM_AddNewListResult>int</LM_AddNewListResult>
</LM_AddNewListResponse>
</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_AddNewList xmlns="http://ws.esendex.us/NotifyWS/">
<ListName>string</ListName>
<ParentListID>int</ParentListID>
<LicenseKey>string</LicenseKey>
</LM_AddNewList>
</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_AddNewListResponse xmlns="http://ws.esendex.us/NotifyWS/">
<LM_AddNewListResult>int</LM_AddNewListResult>
</LM_AddNewListResponse>
</soap12:Body>
</soap12:Envelope>