GetAvailableIncomingNumbers

This method will list a random 10 lines available for incoming calls. You can assign these lines via the AssignIncomingNumber method to your license key. You can leave the area code field blank to get any available toll-free lines (888 and 877 numbers are currently the most common).

Syntax

GetAvailableIncomingNumbers(AreaCodeFilter)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
AreaCodeFilter		`String`	True

Response

Returns: Array of String values

Description: A list of incoming numbers.

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 Incoming_Numbers.WSDL;

namespace Incoming_Numbers
{
    class Program
    {
        static void Main(string[] args)
        {
            WSDL.PhoneNotify PN = new WSDL.PhoneNotify();

            Array Incoming = PN.GetAvailableIncomingNumbers("888");

            if (Incoming.Length > 0)
            {
                Console.WriteLine("Available Incoming Numbers:" + "\n");

                foreach (string Number in Incoming)
                {
                    Console.WriteLine(Number);
                }
            }
            else Console.WriteLine("No incoming numbers available.");

            Console.ReadLine();
        }
    }
}

' https://ws.esendex.us/notifyws/phonenotify.asmx?wsdl was added as a Web Reference and given the name WSDL

Imports GetAvailableIncomingNumbers.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim Incoming As Array

        Incoming = PN.GetAvailableIncomingNumbers("888")

        If (Incoming.Length > 0) Then

            Console.WriteLine("Available Incoming Numbers:" & vbLf)

            For Each Number In Incoming

                Console.WriteLine(Number)

            Next

        Else : Console.WriteLine("No incoming numbers available.")

        End If

        Console.ReadLine()

    End Sub

End Module

Dim request, oXMLHttp, url
url = "http://ws.esendex.us/NotifyWS/PhoneNotify.asmx"

request = "<?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=""http://ws.esendex.us/NotifyWS/"">" & _
"<AreaCodeFilter>757</AreaCodeFilter>" & _
"</GetAvailableIncomingNumbers>" & _
"</soap:Body>" & _
"</soap:Envelope>"

Set oXMLHttp = CreateObject("MSXML2.ServerXMLHTTP")
oXMLHttp.open "POST", url, False
oXMLHttp.setRequestHeader "Content-Type", "text/xml; charset=utf-8"
oXMLHttp.send request
response = oXMLHttp.responseText

MsgBox oXMLHTTP.responseText

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("http://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) {
        }
    }
}

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

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

AreaCodeFilter=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfString xmlns="http://ws.esendex.us/NotifyWS/">
  <string>string</string>
  <string>string</string>
</ArrayOfString>

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/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="http://ws.esendex.us/NotifyWS/">
      <AreaCodeFilter>string</AreaCodeFilter>
    </GetAvailableIncomingNumbers>
  </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>
    <GetAvailableIncomingNumbersResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <GetAvailableIncomingNumbersResult>
        <string>string</string>
        <string>string</string>
      </GetAvailableIncomingNumbersResult>
    </GetAvailableIncomingNumbersResponse>
  </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>
    <GetAvailableIncomingNumbers xmlns="http://ws.esendex.us/NotifyWS/">
      <AreaCodeFilter>string</AreaCodeFilter>
    </GetAvailableIncomingNumbers>
  </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>
    <GetAvailableIncomingNumbersResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <GetAvailableIncomingNumbersResult>
        <string>string</string>
        <string>string</string>
      </GetAvailableIncomingNumbersResult>
    </GetAvailableIncomingNumbersResponse>
  </soap12:Body>
</soap12:Envelope>