Some of the URLs in this documentation contain placeholders for values that your API client program must provide. These placeholders are shown in curly braces, like {this}. When you construct the URL to access these resources, replace those placeholders with the values you want to use.
The Origination resource lets you get DIDs or TFNs for use with your programs and manage DIDs/TFNs you already have.
This request will return all States that has available DIDs in them.
string
(required)string
(required)200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
"CA",
"CO",
"..."
]
}
Get available NPANXX numbers by country, state/province, and NPANXX
string
(required)string
(required)string
(required)200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"NPANXX": "206219",
"NPA": "206",
"RateCenter": "SEATTLE"
},
"............."
]
}
This request will return the available TNs from business inventory.
string
(required)string
(required)string
(required)integer
6 digit {code}integer
complete 10 digit {number}200
ShowHide
Content-Type: application/json
{
"status": "200",
"DIDs": [
{
"TN": "XXXXXXXXXX",
"statusid": "0"
},
{
"TN": "XXXXXXXXXX",
"statusid": "0"
}
]
}
This request will return the available Toll Free Number from business inventory on selected Toll Free Prefix.
string
(required)string
(required)integer
(required)3 digit {code} e.g 866,877,800200
ShowHide
Content-Type: application/json
{
"status": "200",
"TFNs": [
{
"TN": "XXXXXXXXXX",
"statusid": "0"
},
{
"TN": "XXXXXXXXXX",
"statusid": "0"
}
]
}
Greate a New Trunk Group for calls Origination.
string
(required)string
(required)string
(required)string
(required) Valid IP Addressinteger
4 to 6 digit {code}integer
4 digit {port}string
valid IP addressinteger
4 to 6 digit {code}integer
4 digit {port}string
(required) "Metered" or "Unmetered"integer
Required if billingType = Unmeteredinteger
Unlimited or {blank}integer
11 digit complete phone {number}200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Trunk group added successfully."
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
By default this request will return all Trunk Groups added in an account for calls origination. If Trunk Group id (tg_id) is provided then only that Trunk Group details will be fetched in response.
string
(required)string
(required)integer
200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"id": "3",
"accountno": "XXXXXXX",
"title": "vitcoms",
"primaryIP": "XXX.XXX.XXX.XXX",
"primaryPort": "5060",
"prefix_1": "XXXX",
"secondaryIP": "XXX.XXX.XXX.XXX",
"secondaryPort": "5060",
"prefix_2": "XXXX",
"date": "2015-01-26 11:58:02",
"req_sessions": "XXX",
"alloc_sessions": "0",
"status": "1"
}
]
}
This API call will allow to update the Trunk Group values like IPs, ports, prefixes etc.
(This call will not effect any value in system who's parameter is not provided.)
string
(required)string
(required)integer
(required)string
string
Valid IP Addressinteger
4 to 6 digit {code}integer
4 digit {port}string
valid IP addressinteger
4 to 6 digit {code}integer
4 digit {port}integer
11 digit complete phone {number}200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"trunkid": "XXXXXX",
"success": "Trunk successfully Updated."
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will reserve DIDs before ordering. All reserved DIDs will be added in customer's Order Cart, so this feature will allow customers to keep reserving multiple DIDs and then Generate Order at once.
string
(required)string
(required)string
(required)"landline" or "tollfree"string
require for DID number(s) onlyinteger
6 digit {code}string
integer
require for TFN onlyinteger
(required) 10 digit {number}200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"reserveId": "XXXXXX",
"TNs": [
"XXXXXXXXXX , XXXXXXXXXX"
]
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will do the Bulk DIDs reservation before ordering. The bulk ordering works on selecting the DID Range on provided quantity. System will select available DIDs based on provided State, NPANXX, Quantity etc and reserve them in ascending order. All reserved DIDs will be added in customer's Order Cart, this feature will allow customers to keep reserving multiple Bulks DIDs and then Generate Order at once.
string
(required)string
(required)string
(required)"landline" or "tollfree"string
integer
6 digit {code}string
integer
require for TFN onlyinteger
(required) 1 to 1000200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"reserveId": "XXXXXX",
"TNs": [
"XXXXXXXXXX , XXXXXXXXXX"
]
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
By defualt this request will remove all reserved DIDs in customer's Order Cart unless specfic DIDs Number is provided as a parameter to this request.
string
(required)string
(required)integer
(required)integer
10 digit {number} (comma separate for multiple numbers)200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"Removed TNs": [
""
],
"TNs not available": [
"XXXXXXXXXX , XXXXXXXXXX"
]
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will return all Numbers under the provided account.
string
(required)string
(required)string
"landline" or "tollfree"integer
"Active" = 1, "Inactive" = 0, "Cancelled" = 2integer
integer
200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"didnumber": "XXXXXXXXXX",
"trunkGroup": "XXX.XXX.XXX.XXX",
"prefix1": "XXXX",
"trunkGroup2": "XXX.XXX.XXX.XXX",
"prefix2": "XXXX",
"didRate": "XX.XX",
"didType": "Unmetered",
"orderType": "New",
"status": "0",
"cnam": "MY_CNAME"
}
]
}
This request will help to update Number's Status, Trunk Group or CNAM etc.
string
(required)string
(required)integer
(required) 10 digit {number} (comma separate for multiple numbers)integer
Trunk Group IDinteger
Active = 1, Inactive = 0, Cancel = 2200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Trunk successfully Updated."
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
All your reserved DIDs/TFNs in Order Cart will be pushed into and Order and returns the Order ID (orderId).
string
(required)string
(required)integer
(required) can get this id from "get_trunk" request.integer
(required) reserve DIDs request will give this ID200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Order Generated successfully.",
"orderId": "XXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "New",
"didCategory": "Landline",
"didType": "Unmetered",
"sessions": "XXXX",
"status": "1",
"numbers":[
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX",.......
]
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will deduct the Order Amount from customer's balance and Allocate all DIDs/TFNs in provided Order ID.
string
(required)string
(required)integer
(required) this id is from "gen_did_order" request.200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Order Processed Successfully.",
"orderId": "XXXXXX"
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will check and verify the TNs for Portability and respond with "Accepted" or "Rejected" to port in .
string
(required)string
(required)integer
(required) 11 digit {did/tfn} (One or more numbers comma separated)200
ShowHide
Content-Type: application/json
{
"status": "200",
"accepted": [
{
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX"
}
],
"rejected": [
{
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX"
}
]
}
This request receives the LNP Numbers along with their busines/personal details and generated the order for "Accepted" numbers only.
string
(required)string
(required)integer
(required) 11 digit {did/tfn} (One or more numbers comma separated)string
(required) "landline" or "tollfree"string
(required) "residential" or "business"string
(required) The first and last name of person who authorized LOA.file
(required) Upload ZIP for multiple LOAsfile
(required) Upload ZIP for multiple docsstring
string
string
200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Order Generated Successfully.",
"orderNo": "XXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "New",
"didCategory": "Landline",
"didType": "Unmetered",
"sessions": "XXXX",
"status": "1",
"acceptedTns": [
{
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX"
}
],
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
Return all orders info in an account or return order detials of a specifically provided order number.
string
(required)string
(required)integer
200
ShowHide
Content-Type: application/json
{
"status": "200",
"Orders": [
{
"orderno": "2342343",
"accountno": "XXXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "New",
"didCategory": "Landline",
"didType": "Unmetered",
"sessions": "XXXX",
"status": "1",
"numbers":[
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX",.......
]
},
{
"orderno": "4353453",
"accountno": "XXXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "New",
"didCategory": "TollFree",
"didType": "Metered",
"sessions": "0",
"status": "1",
"numbers":[
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX",.......
]
},
...........
]
}
Return all LNP orders info in an account or return order detials of a specifically provided order number.
string
(required)string
(required)integer
200
ShowHide
Content-Type: application/json
{
"status": "200",
"Orders": [
{
"orderno": "2342343",
"accountno": "XXXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "Portin",
"didCategory": "Landline",
"didType": "Unmetered",
"sessions": "XXXX",
"status": "1",
"requestedFocDate": "2015-04-29 15:30:00",
"actualFocDate": "2015-04-29 03:31:03",
"billingNumber": "+14252707174",
"loaAuthorizingPerson": "Sunny Summertime",
"numbers":[
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX",.......
],
"subscriberType": "residential",
"subscriberFirstName": "Sunny",
"subscriberLastName": "Summertime",
"addressHouseNumber": "400",
"addressStreetName": "Green Road",
"addressStreetSuffix": "Dr",
"addressCity": "Portland",
"addressStateCode": "OR",
"addressZip": "97230",
"losingCarrierName": "Bandwidth",
"lastModifiedDate": "2015-04-29T03:31:05Z",
"lastModifiedBy": "System",
"immediately": false,
"triggered": false,
"loa": "{URL}/uploads/portin/{LOA}",
"carrier_doc": "{URL}/uploads/portin/{carrier_doc}",
},
{
"orderno": "34534544",
"accountno": "XXXXXXX",
"date": "2015-01-26 11:58:02",
"amount": "XX.XX",
"per_order_cost": "XX.XX",
"taxes": "XX.XX",
"other_charges": "XX.XX",
"discount": "XX.XX",
"tg_id": "XXXXXX",
"orderType": "Portin",
"didCategory": "Landline",
"didType": "Metered",
"sessions": "XXXX",
"status": "1",
"requestedFocDate": "2015-04-29 15:30:00",
"actualFocDate": "2015-04-29 03:31:03",
"billingNumber": "+14252707174",
"loaAuthorizingPerson": "Sunny Summertime",
"numbers":[
"XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX",.......
],
"subscriberType": "residential",
"subscriberFirstName": "Sunny",
"subscriberLastName": "Summertime",
"addressHouseNumber": "400",
"addressStreetName": "Green Road",
"addressStreetSuffix": "Dr",
"addressCity": "Portland",
"addressStateCode": "OR",
"addressZip": "97230",
"losingCarrierName": "Bandwidth",
"lastModifiedDate": "2015-04-29 03:31:05",
"lastModifiedBy": "System",
"immediately": false,
"triggered": false,
"loa": "{URL}/uploads/portin/{LOA}",
"carrier_doc": "{URL}/uploads/portin/{carrier_doc}",
},
...........
]
}
This request will return Overal Stats report on provided DIDs / TFNs
string
(required)string
(required)integer
(required) One or multiple numbers comma separated200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
.........
]
}
This request will return Daily CDR stats
string
(required)string
(required)date
Example: 2015-04-29date
Example: 2015-04-29200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"date": "2015-04-29 00:00:00",
"success": "URL/uploads/CDR_LOCATION/FILENAME.csv",
"failed": "URL/uploads/CDR_LOCATION/FILENAME.csv",
},
{
"date": "2015-04-28 00:00:00",
"success": "URL/uploads/CDR_LOCATION/FILENAME.csv",
"failed": "URL/uploads/CDR_LOCATION/FILENAME.csv",
},
..............
]
}
This request will return Overal Stats report on provided Trunk Group ID
string
(required)string
(required)integer
(required) One or multiple numbers comma separated200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
.........
]
}
This request returns Monthly Summary report on Origination
string
(required)string
(required)integer
(required) e.g. 2015integer
Optional 1 to 12200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"month": "2015-02-1",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"month": "2015-02-1",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
.........
]
}
The Termination resource lets you manage your calls routing instantly.
Greate a New Trunk Group for calls Termination.
string
(required)string
(required)string
(required)string
(required) Valid IP Addressinteger
(required) 1 to 1000 rangeinteger
request calls per second200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Trunk group added successfully."
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
By default this request will return all Trunk Groups added in an account for calls termination. If Trunk Group id (tg_id) is provided then only that Trunk Group details will be fetched in response.
string
(required)string
(required)integer
200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"id": "3",
"accountno": "XXXXXXX",
"ipaddress": "XXX.XXX.XXX.XXX",
"ports": "XXXX",
"cps": "XXX",
"ports_assigned": "XXXX",
"cps_assigned": "XXX",
"config": "{URL}/ajax/settings_pdf/{ipaddress}",
"status": "1"
}
]
}
Disable the Termination trunk of provided Trunk ID.
string
(required)string
(required)integer
(required)200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"Removed TNs": "Diabled Successfully"
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}
This request will return Daily CDR stats for calls Termination
string
(required)string
(required)date
Example: 2015-04-29date
Example: 2015-04-29200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"date": "2015-04-29 00:00:00",
"success": "URL/uploads/CDR_LOCATION/FILENAME.csv",
"failed": "URL/uploads/CDR_LOCATION/FILENAME.csv",
},
{
"date": "2015-04-28 00:00:00",
"success": "URL/uploads/CDR_LOCATION/FILENAME.csv",
"failed": "URL/uploads/CDR_LOCATION/FILENAME.csv",
},
..............
]
}
This request will return Overal Stats report on provided Trunk Group ID.
string
(required)string
(required)integer
(required) One or multiple numbers comma separated200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
.........
]
}
This request returns Monthly Summary report on Termination
string
(required)string
(required)integer
(required) e.g. 2015integer
Optional 1 to 12200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"month": "2015-02-1",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
{
"accountno": "XXXXXXX",
"number": "XXXXXXXXXX",
"month": "2015-02-1",
"processed": "XXXXX",
"completed": "XXXXX",
"acd": "XXXX",
"asr": "XX%",
"mou": "XXXXXX",
"peak": "XXXX",
},
.........
]
}
The Billing resource lets you manage your financial transactions.
This request will return customer's invoices
string
(required)string
(required)date
Example: 2015-04-29date
Example: 2015-04-29200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"date": "2015-04-29 00:00:00",
"file": "URL/downloads/INVOICE_LOCATION/FILENAME.pdf"
},
{
"date": "2015-05-29 00:00:00",
"file": "URL/downloads/INVOICE_LOCATION/FILENAME.pdf"
},
..............
]
}
This request will return all Financial Activities performed.
string
(required)string
(required)string
200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"date": "2015-04-29 00:00:00",
"activity": "Test Call Credit",
"debit": "0.00",
"credit": "2.00",
"balance": "2.00"
},
{
"accountno": "XXXXXXX",
"date": "2015-04-29 00:00:00",
"activity": "Order (New DIDs)",
"debit": "1.00",
"credit": "0.00",
"balance": "1.00"
},
.........
]
}
This request will return all Payment Transactions and their Statuses.
string
(required)string
(required)string
date
2015-04-29 00:00:00date
2015-04-29 00:00:00string
200
ShowHide
Content-Type: application/json
{
"status": "200",
"data": [
{
"accountno": "XXXXXXX",
"date": "2015-04-29 00:00:00",
"referenceno": "xxxxxx",
"funded_amount": "10.00",
"charges": "2.00",
"amount": "8.00",
"method": "paypal",
"status": "1"
},
{
"accountno": "XXXXXXX",
"date": "2015-04-29 00:00:00",
"referenceno": "xxxxxx",
"funded_amount": "200.00",
"charges": "12.00",
"amount": "188.00",
"method": "bank",
"status": "1"
},
.........
]
}
API request to push the Payments to Client's Merchant payment gateway processor and process the payment instantly. .
string
(required)string
(required)string
(required)string
(required) integer
(required) integer
(required) integer
(required) string
string
string
string
string
integer
(required) 200 / 201
ShowHide
Content-Type: application/json
{
"status": "200",
"success": "Payment added successfully."
}
404
ShowHide
Content-Type: application/json
{
"status": "404",
"error": "Invalid {parameter}"
}