Back to top

Conventions

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.

Origination API 

The Origination resource lets you get DIDs or TFNs for use with your programs and manage DIDs/TFNs you already have.

State Availability
/availabilitystate

This request will return all States that has available DIDs in them.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "data": [
          "CA",
          "CO",
          "..."
       ]
    }
                        
                        
NPANXX Availability
/availabilitynpanxx

Get available NPANXX numbers by country, state/province, and NPANXX

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    state
    string (required)
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "data": [
          {
             "NPANXX": "206219",
             "NPA": "206",
             "RateCenter": "SEATTLE"
          },
          "............."
       ]
    }
                        
                        
DID Availability
/searchdid

This request will return the available TNs from business inventory.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    state
    string (required)
    NPANXX
    integer 6 digit {code}
    NPANXXYYYY
    integer complete 10 digit {number}
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "DIDs": [
          {
             "TN": "XXXXXXXXXX",
             "statusid": "0"
          },
          {
             "TN": "XXXXXXXXXX",
             "statusid": "0"
          }
       ]
    }
                        
                        
TFN Availability
/searchtfn

This request will return the available Toll Free Number from business inventory on selected Toll Free Prefix.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tfn_prefix
    integer (required)3 digit {code} e.g 866,877,800
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "TFNs": [
          {
             "TN": "XXXXXXXXXX",
             "statusid": "0"
          },
          {
             "TN": "XXXXXXXXXX",
             "statusid": "0"
          }
       ]
    }
                        
                        
Defint Trunk Group
/defineTrunk

Greate a New Trunk Group for calls Origination.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    title
    string (required)
    primaryTrunk
    string (required) Valid IP Address
    primaryPrefix
    integer 4 to 6 digit {code}
    primaryPort
    integer 4 digit {port}
    secondaryTrunk
    string valid IP address
    secondaryPrefix
    integer 4 to 6 digit {code}
    secondaryPort
    integer 4 digit {port}
    billingType
    string (required) "Metered" or "Unmetered"
    sessions
    integer Required if billingType = Unmetered
    mou
    integer Unlimited or {blank}
    call_forwarding
    integer 11 digit complete phone {number}
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "success": "Trunk group added successfully."
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Get Trunk Group
/get_trunk

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.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tg_id
    integer
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
          }
       ]
    }
                        
                        
Update Trunk Group
/update_trunk

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.)

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    trunkid
    integer (required)
    title
    string
    primaryTrunk
    string Valid IP Address
    primaryPrefix
    integer 4 to 6 digit {code}
    primaryPort
    integer 4 digit {port}
    secondaryTrunk
    string valid IP address
    secondaryPrefix
    integer 4 to 6 digit {code}
    secondaryPort
    integer 4 digit {port}
    call_forwarding
    integer 11 digit complete phone {number}
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "trunkid": "XXXXXX",
       "success": "Trunk successfully Updated."
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Reserve New Number
/reserve

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.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    category
    string (required)"landline" or "tollfree"
    state
    string require for DID number(s) only
    npanxx
    integer 6 digit {code}
    city
    string
    tfn_prefix
    integer require for TFN only
    number
    integer (required) 10 digit {number}
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "reserveId": "XXXXXX",
       "TNs": [
          "XXXXXXXXXX , XXXXXXXXXX"
       ]
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Bulk Reserve Number
/bulkreserve

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.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    category
    string (required)"landline" or "tollfree"
    state
    string
    npanxx
    integer 6 digit {code}
    city
    string
    tfn_prefix
    integer require for TFN only
    quantity
    integer (required) 1 to 1000
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "reserveId": "XXXXXX",
       "TNs": [
          "XXXXXXXXXX , XXXXXXXXXX"
       ]
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Remove Reserved Number
/remove_reserved

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.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    reserveId
    integer (required)
    number
    integer 10 digit {number} (comma separate for multiple numbers)
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "Removed TNs": [
          ""
       ],
       "TNs not available": [
          "XXXXXXXXXX , XXXXXXXXXX"
       ]
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Get My Numbers
/getnumbers

This request will return all Numbers under the provided account.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    category
    string "landline" or "tollfree"
    status
    integer "Active" = 1, "Inactive" = 0, "Cancelled" = 2
    trunkId
    integer
    orderno
    integer
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
          }
       ]
    }
                        
                        
Update My Number
/updatenumber

This request will help to update Number's Status, Trunk Group or CNAM etc.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    number
    integer (required) 10 digit {number} (comma separate for multiple numbers)
    trunkId
    integer Trunk Group ID
    status
    integer Active = 1, Inactive = 0, Cancel = 2
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "success": "Trunk successfully Updated."
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Generate New DID/TFN Order
/gen_order

All your reserved DIDs/TFNs in Order Cart will be pushed into and Order and returns the Order ID (orderId).

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    trunk_id
    integer (required) can get this id from "get_trunk" request.
    reserveId
    integer (required) reserve DIDs request will give this ID
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",.......
                
             ]
        
             
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Process New DID Order
/process_order

This request will deduct the Order Amount from customer's balance and Allocate all DIDs/TFNs in provided Order ID.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    orderId
    integer (required) this id is from "gen_did_order" request.
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "success": "Order Processed Successfully.",
       "orderId": "XXXXXX"
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Check DID Portability
/check_lnp

This request will check and verify the TNs for Portability and respond with "Accepted" or "Rejected" to port in .

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    numbers
    integer (required) 11 digit {did/tfn} (One or more numbers comma separated)
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "accepted": [
          {
             "XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX"
          }
       ],
    	"rejected": [
          {
             "XXXXXXXXXX","XXXXXXXXXX","XXXXXXXXXX"
          }
       	]
    }
                        
                        
Generate LNP Order
/generate_lnp_order

This request receives the LNP Numbers along with their busines/personal details and generated the order for "Accepted" numbers only.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    numbers
    integer (required) 11 digit {did/tfn} (One or more numbers comma separated)
    category
    string (required) "landline" or "tollfree"
    subscriberType
    string (required) "residential" or "business"
    loaAuthorizingPerson
    string (required) The first and last name of person who authorized LOA.
    loa_doc
    file (required) Upload ZIP for multiple LOAs
    carrier_doc
    file (required) Upload ZIP for multiple docs
    requestedFocDate
    string
    Recommended to leave blank when creating new port orders.

    "Firm Order Commitment", the date "Firm order commitment" date, also know as the the scheduled transfer date.

    If not entered, the next available FOC date will be used. It if is entered, order will be rejected if date is earlier than losing carriers minimum number of days to port-out or if date is a weekend or holiday. Format is ISO8601 encoding of ZULU/UTC/GMT such as “2015-05-14 16:33:24”. If the port is capable of on demand activation then the time value in the request considered to be the default activation time of the port.
    wirelessAccountNumber
    string
    Existing account number for authorizing a port for a wireless phone service.
    wirelessPin
    string
    PIN code for authorizing a port for a wireless phone service. Provided by wireless carrier to subscribers.
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
              }
           ],
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Get New Orders
/get_new_orders

Return all orders info in an account or return order detials of a specifically provided order number.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    orderId
    integer
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",.......
                
             ]
          },
    	...........
    
       ]
    }
                        
                        
Get LNP Orders
/get_lnp_orders

Return all LNP orders info in an account or return order detials of a specifically provided order number.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    orderId
    integer
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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}",
          },
    	...........
    
       ]
    }
                        
                        
DID/TFN Stats
/did_stats

This request will return Overal Stats report on provided DIDs / TFNs

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    number
    integer (required) One or multiple numbers comma separated
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    		.........
       ]
    }
                        
                        
Daily CDR Stats
/daily_cdrs

This request will return Daily CDR stats

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    from
    date Example: 2015-04-29
    to
    date Example: 2015-04-29
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    	..............
       ]
    }
                        
                        
Trunk Group Stats
/tg_stats

This request will return Overal Stats report on provided Trunk Group ID

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tg_id
    integer (required) One or multiple numbers comma separated
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    		.........
       ]
    }
                        
                        
Monthly Summary
/monthly_summary

This request returns Monthly Summary report on Origination

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    year
    integer (required) e.g. 2015
    month
    integer Optional 1 to 12
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    		.........
       ]
    }
                        
                        

Termiation 

The Termination resource lets you manage your calls routing instantly.

Defint Trunk Group
/defineTrunk_termination

Greate a New Trunk Group for calls Termination.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    title
    string (required)
    ipaddress
    string (required) Valid IP Address
    ports
    integer (required) 1 to 1000 range
    cps
    integer request calls per second
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "success": "Trunk group added successfully."
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Get Trunk Group
/get_trunk_termination

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.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tg_id
    integer
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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 Trunk
/disable_trunk_termination

Disable the Termination trunk of provided Trunk ID.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tg_id
    integer (required)
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "Removed TNs": "Diabled Successfully"
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }
                        
                        
Daily CDR Stats
/daily_cdrs_termination

This request will return Daily CDR stats for calls Termination

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    from
    date Example: 2015-04-29
    to
    date Example: 2015-04-29
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    	..............
       ]
    }
                        
                        
Trunk Group Stats
/tg_stats_termination

This request will return Overal Stats report on provided Trunk Group ID.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    tg_id
    integer (required) One or multiple numbers comma separated
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    		.........
       ]
    }
                        
                        
Monthly Summary
/monthly_summary_termination

This request returns Monthly Summary report on Termination

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    year
    integer (required) e.g. 2015
    month
    integer Optional 1 to 12
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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",
          },
    		.........
       ]
    }
                        
                        

Billing API 

The Billing resource lets you manage your financial transactions.

Get Invoices
/get_invoices

This request will return customer's invoices

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    from
    date Example: 2015-04-29
    to
    date Example: 2015-04-29
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
          },
    	..............
       ]
    }
                        
                        
Financial Summary
/financial_summary

This request will return all Financial Activities performed.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    activitytype
    string

    All Activity, Test Call Credit, Bank Transfer, Bank Fee, Paypal Transfer, Paypal Fee, USF Tax Deduction, Payment Cancelled, Payment Refund, Call Charges, Order (New DIDs), Order (LNP), Credit Card, Credit Card Fee
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
          },
    		.........
       ]
    }
                        
                        
Get Payment Details
/get_payments

This request will return all Payment Transactions and their Statuses.

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    referenceno
    string
    from
    date 2015-04-29 00:00:00
    to
    date 2015-04-29 00:00:00
    method
    string

    Paypal, Bank, Credit Card
  • Response  200
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "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"
             
          },
    		.........
       ]
    }
                        
                        
Make Payment
/make_payment

API request to push the Payments to Client's Merchant payment gateway processor and process the payment instantly. .

  • Parameters
  • token
    string (required)
    accountno
    string (required)
    firstname
    string (required)
    lastname
    string (required)
    cardnumber
    integer (required)
    expmonth
    integer (required)
    expyear
    integer (required)
    address
    string
    address2
    string
    state
    string
    city
    string
    zipcode
    string
    cvv
    integer (required)
  • Response  200 / 201
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "200",
       "success": "Payment added successfully."
    }
                        
                        
  • Response  404
  • Headers
    Content-Type: application/json
                        
    Body
    {
       "status": "404",
       "error": "Invalid {parameter}"
    }