Sidebar Menu

LM_AddNewList

This method creates a list. Lists are used to store a list of contacts (members). Use the LM_DialList or LM_DialListAdvanced methods 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 0.

 Integer True 1230
LicenseKey

Your license key.

 String True 00000000-0000-0000-0000-000000000000

Response

Returns: Integer

Description: If this operation succeeded, it returns a positive number that is the new list's ID. (You will need this ID to alter or send messages to the list.)

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.

/* 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 listName = "My List";
var parentListId = 0;
var listId = await client.LM_AddNewListAsync(
    listName, parentListId, YOUR_LICENSE_KEY);

Console.WriteLine("List ID: " + listId);

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("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/LM_AddNewList?" + "&ListName=Customers"
                            + "&ParentListID=0" + "&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) {
        }
    }
}

import zeep

client = zeep.Client(wsdl="https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl")
list_name = "My List"
parent_list_id = 0
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.LM_AddNewList(list_name, parent_list_id, license_key)

print(result)

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="https://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="https://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="https://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="https://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="https://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: "https://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="https://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="https://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="https://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="https://ws.esendex.us/NotifyWS/">
      <LM_AddNewListResult>int</LM_AddNewListResult>
    </LM_AddNewListResponse>
  </soap12:Body>
</soap12:Envelope>