Voice Broadcast API

Voice API
Quick Start Guides
Methods
Types
FAQ

LM_AddListMember

This method adds a contact (member) to a list. If you don’t have a list yet, create it first using the LM_AddNewList method.

Syntax

LM_AddListMember(ListID, LicenseKey, PhoneNumber, ClientID, FirstName, LastName)

Request Parameters

Parameter NameDescriptionData TypeRequiredSample Value
ListIDThe ID of the list that the new member will be added to.IntegerTrue1234
LicenseKeyYour license key.StringTrue00000000-0000-0000-0000-000000000000
PhoneNumberThe member’s phone number.StringTrue7575449510
ClientIDThe member’s business or consumer full name. This parameter can also be used to save additional information about the member.StringFalse (may be an empty string)client1
FirstNameThe member’s first name.StringFalse (may be an empty string)John
LastNameThe member’s last name.StringFalse (may be an empty string)Smith

Response

Returns: Integer

Description: If the operation succeeded, it returns a positive number that is the new member’s ID. (You will need this ID to alter the member.) If the operation failed, the operation returns -1 (the phone number might be invalid).

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#

/* 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 phoneNumber = "7575449510";
var clientId = "client1";
var firstName = "John";
var lastName = "Smith";
var memberId = await client.LM_AddListMemberAsync(
    listId, YOUR_LICENSE_KEY, phoneNumber, clientId, firstName, lastName);

Console.WriteLine("Member ID: " + memberId);

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_AddListMember {
    public static void main(String[] args) throws Exception {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/LM_AddListMember?" + "&ListID=00000"
                            + "&PhoneNumber=17575449510" + "&ClientID=1" + "&FirstName=Esendex" + "&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
license_key = "00000000-0000-0000-0000-000000000000"
phone_number = "7575449510"
client_id = "client1"
first_name = "John"
last_name = "Smith"

result = client.service.LM_AddListMember(
    list_id, license_key, phone_number, client_id, first_name, last_name
)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/LM_AddListMember?ListID=string&LicenseKey=string&PhoneNumber=string&ClientID=string&FirstName=string&LastName=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

ListID=string&LicenseKey=string&PhoneNumber=string&ClientID=string&FirstName=string&LastName=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_AddListMember"

<?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_AddListMember xmlns="https://ws.esendex.us/NotifyWS/">
      <ListID>int</ListID>
      <LicenseKey>string</LicenseKey>
      <PhoneNumber>string</PhoneNumber>
      <ClientID>string</ClientID>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
    </LM_AddListMember>
  </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_AddListMemberResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LM_AddListMemberResult>int</LM_AddListMemberResult>
    </LM_AddListMemberResponse>
  </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_AlterListMember xmlns="https://ws.esendex.us/NotifyWS/">
      <ListMemberID>int</ListMemberID>
      <licensekey>string</licensekey>
      <ClientID>string</ClientID>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <PhoneNumber>string</PhoneNumber>
    </LM_AlterListMember>
  </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_AddListMemberResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <LM_AddListMemberResult>int</LM_AddListMemberResult>
    </LM_AddListMemberResponse>
  </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"?>
<int xmlns="https://ws.esendex.us/NotifyWS/">int</int>

Let’s start sending, together.