node-numbers
NodeJs Client library for Bandwidth Numbers API
Other Node SDKs
Supported Versions
This SDK stable for node versions 7 and above
Version | Support Level | |
---|
<7 | Unsupported | |
> 7 | | Supported |
Release Notes
Version | Notes |
---|
1.1.0 | Added import tn functionality, added promise based Async functions |
1.2.0 | Added CSR lookup functionality |
1.2.1 | Fixed Subscription List functionality. Example code at: examples/subscription_list_and_delete |
1.2.2 | Readme Typo for RemoveImportedTnOrder |
1.3.0 | Added Emergency Calling Notification endpoints |
Install
Run
npm install @bandwidth/numbers
Usage
var numbers = require("@bandwidth/numbers");
var client = new numbers.Client("accountId", "userName", "password");
numbers.Site.list(client, function(err, sites){...});
numbers.Client.globalOptions.accountId = "accountId";
numbers.Client.globalOptions.userName = "userName";
numbers.Client.globalOptions.password = "password";
numbers.Site.list(function(err, sites){
});
Async Methods
Each API Call also contains an async method that returns a promise for use with .then
or async
/await
.
The async method is the original method name with Async
added.
Some Examples
numbers.Site.create
: numbers.Site.createAsync
numbers.AvailableNumbers.list
: numbers.AvailableNumbers.listAsync
numbers.Order.create
: numbers.Order.createAsync
Example for listing Available Numbers
Callbacks
numbers.AvailableNumbers.list(query, (err, availableNumbers) => {
if (err) {
console.log(err);
}
else {
console.log(availableNumbers);
}
});
Promise Chaining
numbers.AvailableNumbers.listAsync(query)
.then(availableNumbers => {
console.log(availableNumbers);
})
.catch(e => {
console.log(e);
});
Async/Await
try {
const availableNumbers = await numbers.AvailableNumbers.listAsync(query);
console.log(availableNumbers);
}
catch (e) {
console.log(e)
}
Examples
There is an 'examples' folder in the source tree that shows how each of the API objects work with simple example code. To run the examples:
$ cd examples
$ cp config.js.example config.js
Edit the config.js to match your IRIS credentials and run the examples individually. e.g.
node coveredRateCenters-sample.js
If the examples take command line parameters, you will get the usage by just executing the individual script.
API Objects
General principles
When fetching objects from the API, it will always return an object that has the client
instantiated so that you can call dependent methods as well as update, delete.
Example:
numbers.Site.create({siteObject}, function(err,item){
console.log("the site ID is: " + item.id);
item.delete(function(err,res){
});
});
Each entity has a get, list, create, update and delete method if appropriate.
All properties are camel-cased for Javascript readability, and are converted on the fly to the proper
case by the internals of the API when converted to XML.
Available Numbers
numbers.AvailableNumbers.list(query, callback);
Available NpaNxx
numbers.AvailableNpaNxx.list({areaCode:"818", quantity:5}, callback);
Cities
numbers.City.list({"available":true, "state":"CA"}, callback);
Covered Rate Centers
numbers.CoveredRateCenter.list({"zip":"27601"}, callback);
Disconnected Numbers
Retrieves a list of disconnected numbers for an account
numbers.DiscNumber.list({"areaCode":"919"}, callback);
Disconnect Numbers
The Disconnect object is used to disconnect numbers from an account. Creates a disconnect order that can be tracked
Create Disconnect
numbers.Disconnect.create("Disconnect Order Name", ["9195551212", "9195551213"], callback);
Get Disconnect
numbers.Disconnect.get("orderId", {tnDetail:true}, callback);
Add Note to Disconnect
var note = {userId: "my id", description: "Test"};
numbers.Disconnect.get("orderId", {tnDetail:true}, function(err,order){
order.addNote(note, callback);
});
Get Notes for Disconnect
numbers.Disconnect.get("orderId", {tnDetail:true}, function(err,order){
order.getNotes(callback);
});
Dlda
Create Ddla
var dlda = {
customerOrderId:"Your Order Id",
dldaTnGroups: [
dldaTnGroup: {
telephoneNumbers: ["9195551212"],
subscriberType: "RESIDENTIAL",
listingType: "LISTED",
listingName:{
firstName:"John",
lastName:"Smith"
},
listAddress:true,
address:{
houseNumber: "123",
streetName: "Elm",
streetSuffix: "Ave",
city: "Carpinteria",
stateCode:"CA",
zip:"93013",
addressType: "DLDA"
}
}
]
}
numbers.Dlda.create(dlda, callback);
Get Dlda
numbers.Dlda.get(id, callback);
Get Dlda History
numbers.Dlda.get(id, function(err,dlda){
dlda.getHistory(callback);
});
List Dldas
numbers.Dlda.list({telephoneNumber:"9195551212"}, callback);
Import To Account
This path is generally not available to Bandwidth accounts, and as such is not documented in this API
In Service Numbers
List InService Numbers
numbers.InServiceNumber.list({"areaCode":"919"}, callback);
Get InService Number Detail
numbers.InServiceNumber.get("9195551212", callback);
Lidb
Create
var data = {
customerOrderId:"A test order",
lidbTnGroups:{
lidbTnGroup:{
telephoneNumbers:["8048030097", "8045030098"],
subscriberInformation:"Joes Grarage",
useType: "RESIDENTIAL",
visibility: "PUBLIC"
}
}
}
numbers.Lidbs.create(data, callback);
Get Lidb
numbers.Lidbs.get(id, callback);
List Lidbs
numbers.Lidbs.list({telephoneNumber:"9195551212"}, callback);
LNP Checker
Check LNP
var numbersList = ["9195551212", "9195551213"];
var fullCheck = true;
numbers.LnpChecker.check(numbersList, fullCheck, callback);
LSR Orders
Create LSR Order
var data = {
pon:"Some Pon",
customerOrderId: "MyId5",
sPID:"123C",
billingTelephoneNumber:"9192381468",
requestedFocDate: "2015-11-15",
authorizingPerson: "Jim Hopkins",
subscriber:{
subscriberType:"BUSINESS",
businessName:"BusinessName",
serviceAddress: {
houseNumber:"11",
streetName: "Park",
streetSuffix: "Ave",
city:"New York",
stateCode: "NY",
zip: "90025"
},
accountNumber:"123463",
pinNumber:"1231"
},
listOfTelephoneNumbers: {
telephoneNumber:["9192381848", "9192381467"]
}
};
numbers.LsrOrder.create(data, callback);
Get LSR Order
numbers.LsrOrder.get(id, callback);
List LSR Orders
numbers.LsrOrder.list({pon:"Some Pon"}, callback);
Update LSR Order
numbers.LsrOrder.get("id", function(err, order){
order.requestedFocDate = "2015-11-16";
numbers.LsrOrder.update(order, callback);
})
Get LSR Order History
numbers.LsrOrder.get("id", function(err, order){
order.getHistory(callback);
});
Get LSR Order Notes
numbers.LsrOrder.get("id", function(err,order){
order.getNotes(callback);
});
Add LSR Order Note
var note = {userId: "my id", description: "Test"};
numbers.LsrOrder.get("id", function(err, order){
order.addNote(note, callback);
});
Orders
Create Order
var order = {
name:"A Test Order",
siteId: 1111,
existingTelephoneNumberOrderType: {
telephoneNumberList:[
{
telephoneNumber:"9195551212"
}
]
}
};
numbers.Order.create(order, callback);
Get Order
numbers.Order.get(id, callback);
List Orders
numbers.Order.list(query, callback);
List Area Codes for Order
numbers.Order.get(id, function(err, order){
order.getAreaCodes(callback);
});
Order Instance Methods
order.getAreaCodes(callback);
var note = {userId: "my id", description: "Test"};
order.addNote(note,callback);
order.getNpaNxx(callback);
order.getTotals(callback);
order.getTns(callback)
order.getHistory(callback);
order.getNotes(callback);
Port Ins
Create PortIn
var data = {
siteId:1234,
peerId:5678,
billingTelephoneNumber: "9195551212",
subscriber: {
subscriberType: "BUSINESS",
businessName: "Company",
serviceAddress: {
houseNumber: "123",
streetName: "EZ Street",
city: "Raleigh",
stateCode: "NC",
county: "Wake"
}
},
loaAuthorizingPerson: "Joe Blow",
listOfPhoneNumbers: {
phoneNumber:["9195551212"]
},
billingType: "PORTIN"
};
numbers.PortIn.create(data, callback);
Get PortIn
numbers.PortIn.get("id", callback)
List PortIns
var query = {pon:"a pon"};
numbers.PortIn.list(query, function(err, list){
console.log(JSON.stringify(list));
});
PortIn Instance methods
portIn.update(data, callback);
portIn.delete(callback);
portIn.getAreaCodes(callback);
portIn.getNpaNxx(callback);
portIn.getTotals(callback);
portIn.getTns(callback);
portIn.getNotes(callback);
portIn.addNote(callback);
portIn.getActivationStatus(callback);
PortIn File Management
numbers.PortIn.get("id", function(err, portIn){
portIn.createFile(fs.createReadStream("myFile.txt"), callback);
portIn.updateFile("myFile.txt", fs.createReadStream("myFile.txt"), callback);
portIn.getFile("myFile.txt", callback);
portIn.getFileMetadata("myFile.txt", callback);
portIn.getFiles(callback);
});
Port Out
List PortOuts
var query = {"status":"complete"}
numbers.PortOut.list(query, callback);
Get PortOut
numbers.PortOut.get(id, callback);
Rate Centers
List Ratecenters
var query = {"available":true, "state":"CA"}
numbers.RateCenter.list(query, callback);
SIP Peers
Create SIP Peer
var data = {
peerName:"A New SIP Peer",
isDefaultPeer:false,
shortMessagingProtocol:"SMPP",
siteId:selectedSite,
voiceHosts:[
{
host:{
hostName:"1.1.1.1"
}
}
],
smsHosts:[
{
host:{
hostName:"1.1.1.1"
}
}
],
terminationHosts:[
{
terminationHost:{
hostName:"1.1.1.1",
port:5060,
}
}
]
};
numbers.SipPeer.create(data, callback);
Get SIP Peer
numbers.SipPeer.get("id", callback);
List SIP Peers
numbers.SipPeer.list(siteId, callback);
Delete SIP Peer
numbers.SipPeer.get(function(err, sipPeer){
sipPeer.delete(callback);
});
SipPeer TN Methods
numbers.SipPeer.get(function(err,sipPeer){
sipPeer.getTns(number, callback);
sipPeer.getTns(callback);
var tns = {fullNumber: "123456", rewriteUser: "test"};
sipPeer.updateTns(number, tns, callback);
var numbersToMove = ["9195551212", "9195551213"];
sipPeer.moveTns(numbersToMove, callback);
});
Sites
Create A Site
A site is what is called Location in the web UI.
var site = {
name:"A new site",
description:"A new description",
address:{
houseNumber: "123",
streetName: "Anywhere St",
city: "Raleigh",
stateCode:"NC",
zip: "27609",
addressType: "Service"
}
};
numbers.Site.create(site, callback);
Updating a Site
site.name = "Some new name";
site.update(site, callback);
Deleting a Site
site.delete(callback);
Listing All Sites
numbers.Site.list(callback);
Site Instance Methods
numbers.Site.get(id, function(err,site){
site.getInserviceNumbers(query, callback);
site.getOrders(query, callback);
site.getPortIns(query, callback);
site.getTotalTns(query, callback);
});
Site SipPeer Methods
numbers.Site.get(id, function(err,site){
site.getSipPeers(callback);
site.getSipPeer(id, callback);
var sipPeer = {name:"SIP Peer"};
site.createSipPeer(sipPeer, callback);
});
Subscriptions
Create Subscription
var subscription = {
orderType:"orders",
callbackSubscription: {
URL:"http://mycallbackurl.com",
user:"userid",
expiry: 12000
}
};
numbers.Subscription.create(subscription, callback);
Get Subscription
numbers.Subscription.get(id, callback);
List Subscriptions
numbers.Subscription.list(query, callback);
Subscription Instance Methods
numbers.Subscription.get(id, function(err, subscription){
var updatedData = {orderType:"portins"};
subscription.update(updatedData, callback)
subscription.delete(callback);
});
TNs
Get TN
numbers.Tn.get(fullNumber, callback);
List TNs
numbers.Tn.list(query, callback);
TN Instance Methods
numbers.Tn.get(fullNumber, function(err, tn){
tn.getTnDetails(callback);
tn.getSites(callback);
tn.getSipPeers(callback);
tn.getRateCenter(callback)
});
TN Reservation
Create TN Reservation
numbers.TnReservation.create({"reservedTn":"9195551212"}, callback);
Get TN Reservation
numbers.TnReservation.get(id, callback);
Delete TN Reservation
numbers.TnReservation.get(id, function(err, tn){
tn.delete(callback);
});
Hosted Messaging
Check importability
const numbers = ["1111", "2222"];
try {
const importResults = await ImportTnChecker.checkAsync(numbers);
console.log(importResults);
}
catch (e) {
console.log(e)
}
Create importTNOrder
const numbers = ["1111", "2222"];
const data = {
customerOrderId: "1111",
siteId: "222",
sipPeerId: "333",
loaAuthorizingPerson: "LoaAuthorizingPerson",
subscriber: {
name: "ABC Inc.",
serviceAddress: {
houseNumber: "11235",
streetName: "StreetName",
stateCode: "NC",
city: "City",
county: "county",
zip: "27606"
}
}
};
try {
const importTnOrder = await ImportTnOrder.createAsync(numbers);
console.log(importTnOrder);
}
catch (e) {
console.log(e)
}
Create removeImportedTnOrder
To restore the messaging functionality to the original owner, create a removeImportedTnOrder
order to remove the numbers from your account.
const numbers = ["1111", "2222"];
const customerOrderId = "customerOrderId"
try {
const importTnOrder = await RemoveImportedTnOrder.createAsync(customerOrderId, numbers);
console.log(importTnOrder);
}
catch (e) {
console.log(e)
}
CSR Lookup
Create CSR Order
const data = {
customerOrderId: "MyId5",
WorkingOrBillingTelephoneNumber:"9198675309",
accountNumber:"123463",
endUserPIN:"1231"
};
try {
const csrOrderResponse = await CsrOrder.createAsync(data);
console.log(csrOrderResponse.orderId);
}
catch (e) {
console.log(e);
}
Fetch Existing CSR Order
If the CSR order is in an FAILED state, the SDK will throw an error
COMPLETE or PROCESSING resposne
const csrOrderId = "1234-abc"
try {
const csrOrderData = await CsrOrder.getAsync(csrOrderId);
console.log(csrOrderData.status);
}
catch (e) {
console.log(e);
}
FAILED response
const csrOrderId = "1234-abc"
try {
const csrOrderData = await CsrOrder.getAsync(csrOrderId);
console.log(csrOrderData.status);
}
catch (e) {
console.log(e);
}
Emergency Notification
List Recipients
try {
const response = await EmergencyNotification.listRecipientsAsync(client, {"Size": "20"} );
console.log(response.emergencyNotificationRecipients.emergencyNotificationRecipient.length);
}
catch (e) {
console.log(e);
}
Get Recipient
try {
const response = await EmergencyNotification.getRecipientAsync(client, "enrid" );
console.log(response.emergencyNotificationRecipient.identifier);
}
catch (e) {
console.log(e);
}
Replace Recipient
var en = new EmergencyNotification();
en.enrid = 123;
try {
const response = await en.replaceRecipientAsync(client, recipient);
console.log(response.emergencyNotificationRecipient.identifier);
}
catch (e) {
console.log(e);
}
Create Recipient
try {
const response = await EmergencyNotification.createRecipientAsync(client, recipient);
console.log(response.emergencyNotificationRecipient.identifier);
}
catch (e) {
console.log(e);
}
Delete Recipient
var en = new EmergencyNotification();
en.enrid = 123;
try {
const response = await en.deleteRecipientAsync(client);
}
catch (e) {
console.log(e);
}
List Group Orders
try {
const response = await EmergencyNotification.listGroupOrdersAsync(helper.createClient(), {Size: "20"});
console.log(response.emergencyNotificationGroupOrders.emergencyNotificationGroupOrder.length);
}
catch (e) {
console.log(e);
}
Get Group Order
try {
const response = await EmergencyNotification.getGroupOrderAsync(helper.createClient(), "orderId");
console.log(response.emergencyNotificationGroup.orderId);
}
catch (e) {
console.log(e);
}
Create Group Order
try {
const response = EmergencyNotification.createGroupOrderAsync(helper.createClient(), groupOrder);
console.log(response.OrderId);
}
catch (e) {
console.log(e);
}
List Group
try {
const response = await EmergencyNotification.listGroupsAsync(client, {"Size": "20"} );
console.log(response.emergencyNotificationGroups.emergencyNotificationGroup.length);
}
catch (e) {
console.log(e);
}
Get Group
try {
const response = await EmergencyNotification.getGroupAsync(client, "engid");
console.log(response.emergencyNotificationGroup.identifier);
}
catch (e) {
console.log(e);
}
List Endpoint Orders
try {
const response = await EmergencyNotification.listEnpointOrdersAsync(client, {"Size": "20"} );
console.log(response.emergencyNotificationEndpointOrders.emergencyNotificationEndpointOrder.length);
}
catch (e) {
console.log(e);
}
Get Endpoint Order
try {
const response = await EmergencyNotification.getEndpointOrderAsync(client, "orderId" );
console.log(response.emergencyNotificationEndpointOrder.orderId);
}
catch (e) {
console.log(e);
}
Create Endpoint Orders
try {
const response = await EmergencyNotification.createEndpointOrderAsync(client, endpoint );
console.log(response.emergencyNotificationEndpointOrder.orderId);
}
catch (e) {
console.log(e);
}
Aeuis
List Aeuis's
try {
const response = await Aeuis.listAsync(client, {Size: 20} );
console.log(response.AlternateEndUserIdentifiers.AlternateEndUserIdentifier.length);
}
catch (e) {
console.log(e);
}
Get Aeuis's
try {
const response = await Aeuis.getAsync(client, "acid" );
console.log(response.AlternateEndUserIdentifier.Identifier);
}
catch (e) {
console.log(e);
}