GetAvailableIncomingNumbers

This method will retrieve 10 random lines available for incoming calls. You can assign these lines to your license key via the AssignIncomingNumber method.

Syntax

GetAvailableIncomingNumbers(AreaCodeFilter)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
AreaCodeFilter	Area code to search for. If fewer than 10 numbers are available for this area code, numbers with other area codes will be included in the results. Use an empty string to get any available toll-free lines.	String	False (may be an empty string)	877

Response

Returns: Array of String values

Description: A list of available incoming numbers.

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#
• Java
• Python
• GET Request
• POST Request
• SOAP 1.1 Request
• SOAP 1.1 Response
• SOAP 1.2 Request
• SOAP 1.2 Response
• XML Response

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 areaCodeFilter = "877";
var incomingNumbers = await client.GetAvailableIncomingNumbersAsync(areaCodeFilter);

Console.WriteLine(incomingNumbers.Length + " incoming numbers were found.");

foreach (var number in incomingNumbers)
{
    Console.WriteLine(number);
}

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 GetAvailableIncomingNumbers {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/GetAvailableIncomingNumbers?"
                            + "AreaCodeFilter=888");
            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")
area_code_filter = ""

result = client.service.GetAvailableIncomingNumbers(area_code_filter)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/GetAvailableIncomingNumbers?AreaCodeFilter=string HTTP/1.1
Host: ws.esendex.us

POST Request

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

AreaCodeFilter=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/GetAvailableIncomingNumbers"

<?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>
    <GetAvailableIncomingNumbers xmlns="https://ws.esendex.us/NotifyWS/">
      <AreaCodeFilter>string</AreaCodeFilter>
    </GetAvailableIncomingNumbers>
  </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>
    <GetAvailableIncomingNumbersResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <GetAvailableIncomingNumbersResult>
        <string>string</string>
        <string>string</string>
      </GetAvailableIncomingNumbersResult>
    </GetAvailableIncomingNumbersResponse>
  </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>
    <GetAvailableIncomingNumbers xmlns="https://ws.esendex.us/NotifyWS/">
      <AreaCodeFilter>string</AreaCodeFilter>
    </GetAvailableIncomingNumbers>
  </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>
    <GetAvailableIncomingNumbersResponse xmlns="https://ws.esendex.us/NotifyWS/">
      <GetAvailableIncomingNumbersResult>
        <string>string</string>
        <string>string</string>
      </GetAvailableIncomingNumbersResult>
    </GetAvailableIncomingNumbersResponse>
  </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"?>
<ArrayOfString xmlns="https://ws.esendex.us/NotifyWS/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>