AssignIncomingNumber

Use this method to assign an incoming number to a license key. Numbers are billed at $5/month per number. Normal fees for transactions apply.

Syntax

AssignIncomingNumber(IncomingPhoneNumber, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
IncomingPhoneNumber	The incoming phone number.	`String`	True	15551234567
LicenseKey	Your license key, which is required to invoke this web service.	`String`	True	F01d89fd-5155-5455-5585-e84ab8de8591

Response

Returns: Boolean

Description: Returns true if assignment was successful. Returns false if the number is already claimed or otherwise unavailable.

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

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

            bool IncomingNumber = PN.AssignIncomingNumber("15551234567", "YOUR LICENSE KEY");

            Console.WriteLine("Incoming Number Assigned: " + IncomingNumber);

            Console.ReadLine();
        }
    }
}

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

Imports AssignIncomingNumber.WSDL
Module Module1

    Sub Main()

        Dim PN As New WSDL.PhoneNotify
        Dim IncomingNumber As Boolean

        IncomingNumber = PN.AssignIncomingNumber("15551234567", "YOUR LICENSE KEY")
        Console.WriteLine("Incoming Number Assigned: " & IncomingNumber)

        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>" & _
"<AssignIncomingNumber xmlns=""http://ws.esendex.us/NotifyWS/"">" & _
"<IncomingPhoneNumber>15551234567</IncomingPhoneNumber>" & _
"<LicenseKey>YOUR LICENSE KEY</LicenseKey>" & _
"</AssignIncomingNumber>" & _
"</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 AssignIncomingNumber {
    public static void main(String[] args) {
        try {
            URL url = new URL("http://ws.esendex.us/NotifyWS/PhoneNotify.asmx/AssignIncomingNumber?"
                            + "IncomingPhoneNumber=17575449510"
                            + "&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/AssignIncomingNumber?IncomingPhoneNumber=string&LicenseKey=string HTTP/1.1
Host: ws.esendex.us

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

IncomingPhoneNumber=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"?>
<boolean xmlns="http://ws.esendex.us/NotifyWS/">boolean</boolean>

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/AssignIncomingNumber"

<?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>
    <AssignIncomingNumber xmlns="http://ws.esendex.us/NotifyWS/">
      <IncomingPhoneNumber>string</IncomingPhoneNumber>
      <LicenseKey>string</LicenseKey>
    </AssignIncomingNumber>
  </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>
    <AssignIncomingNumberResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <AssignIncomingNumberResult>boolean</AssignIncomingNumberResult>
    </AssignIncomingNumberResponse>
  </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>
    <AssignIncomingNumber xmlns="http://ws.esendex.us/NotifyWS/">
      <IncomingPhoneNumber>string</IncomingPhoneNumber>
      <LicenseKey>string</LicenseKey>
    </AssignIncomingNumber>
  </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>
    <AssignIncomingNumberResponse xmlns="http://ws.esendex.us/NotifyWS/">
      <AssignIncomingNumberResult>boolean</AssignIncomingNumberResult>
    </AssignIncomingNumberResponse>
  </soap12:Body>
</soap12:Envelope>