Voice Broadcast API

AssignIncomingNumber

This method assigns an incoming number to a license key. You can get available incoming numbers with the GetAvailableIncomingNumbers method. (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	7575551111
LicenseKey	Your license key.	`String`	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if assignment was successful. False if the number is already claimed or otherwise unavailable.

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 incomingPhoneNumber = "18885550009";
var assigned = await client.AssignIncomingNumberAsync(incomingPhoneNumber, YOUR_LICENSE_KEY);

Console.WriteLine("Incoming number was assigned: " + assigned);

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 AssignIncomingNumber {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://ws.esendex.us/NotifyWS/PhoneNotify.asmx/AssignIncomingNumber?"
                            + "IncomingPhoneNumber=17575449510"
                            + "&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")
incoming_phone_number = "18885550009"
license_key = "00000000-0000-0000-0000-000000000000"

result = client.service.AssignIncomingNumber(incoming_phone_number, license_key)

print(result)

GET Request

GET /NotifyWS/PhoneNotify.asmx/AssignIncomingNumber?IncomingPhoneNumber=string&LicenseKey=string HTTP/1.1
Host: ws.cdyne.com

POST Request

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

IncomingPhoneNumber=string&LicenseKey=string

SOAP 1.1 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.cdyne.com/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.cdyne.com/NotifyWS/">
      <IncomingPhoneNumber>string</IncomingPhoneNumber>
      <LicenseKey>string</LicenseKey>
    </AssignIncomingNumber>
  </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>
    <AssignIncomingNumberResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <AssignIncomingNumberResult>boolean</AssignIncomingNumberResult>
    </AssignIncomingNumberResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Request

POST /NotifyWS/PhoneNotify.asmx HTTP/1.1
Host: ws.cdyne.com
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.cdyne.com/NotifyWS/">
      <IncomingPhoneNumber>string</IncomingPhoneNumber>
      <LicenseKey>string</LicenseKey>
    </AssignIncomingNumber>
  </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>
    <AssignIncomingNumberResponse xmlns="http://ws.cdyne.com/NotifyWS/">
      <AssignIncomingNumberResult>boolean</AssignIncomingNumberResult>
    </AssignIncomingNumberResponse>
  </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"?>
<boolean xmlns="http://ws.cdyne.com/NotifyWS/">boolean</boolean>

Let’s start sending, together.

Talk to an expert

Take a free trial