Page Comparison

Name

Type

Description

tn

String

Telephone number

availability

String

Defines the status of the returned TN

rewrite

String

Used in rewriting the DNIS for the TN if assigned to you or reserved by you

status

String

This is the status of a request, for example 'Success'

statusCode

String

Each status has a matching numerical value, for example, a 'Success' status has a

'100' statusCode

tier

String

Pricing tier on which the number resides

refId

String

This is the customer-defined Reference ID that is associated with this request. This

field is purely for the benefit of the API user, and could potentially be used to

associate a Customer ID, Order ID, or any other Reference ID to an API Request.

cnamName

String

CNAM Storage Display Name

state

String

State

rateCenter

String

Rate Center that services the DID

didGroupID

String

ID number of the DID Group as can be found in the Back Office under Groups -> DID

Groups

network

String

The network on which the DID resides

endpointId

Int

This will return an integer that defines which endpoint group ID this TN will route to

if the TN is assigned to you or reserved by you. This can be changed by performing a

configDID request

has411

String

Indicates if the DID currently has a 411-registered address

has911

String

Indicates if the DID currently has an e911 registered address

cnam

Boolean

Denotes whether inbound CNAM dip is or is not active for the DID

cnamStorageActive

Boolean

Denotes whether a CNAM Storage record is or is not on file in our database for the

DID

cnamStorageAvailablility

Boolean

Denotes if a DID supports CNAM Storage capability or not

t38

Boolean

Denotes if a DID is T38 capable

failover

String

Failover number (if set) on the DID. This field is only included with the GetDIDFailover

method.

forward

String

Forward number (if set) on the DID. This field is only included with the

GetDIDForward method.

Name

Type

Description

tn

String

Telephone number of the DID matching your search criteria

rateCenter

String

The name of the Rate Center that matches your search criteria

state

String

Two-letter state abbreviation that matches your search criteria

tier

String

Pricing tier on which the number in your search criteria

network

String

The ULC that the DID currently belongs with

lataId

Int

The LATA that matches your search criteria

outboundCNAM

Boolean

Denotes if the DID in your search criteria supports CNAM Storage

t38

Boolean

Denotes if the DID in your search criteria is T38 capable

sms

Boolean

Denotes if the DID in your search criteria supports SMS

Name

Type

Description

locationId

String

The location ID that is populated

tn

String

The tn that you are querying

callerName

String

The caller name that was entered for the e911 address

address1

String

Street and house number

address2

String

Any additional information such as "Apartment 1" or "Suite 100" etc.

city

String

City

state

String

State

zipCode

String

Zip code

latitude

String

Latitude coordinate of the address on file

longitude

String

Longitude coordinate of the address on file

statusCode

String

The status code provided for the query ran

statusDescription

String

The description associated with the status code

activatedTime

DateTime

The time the e911 address was activated or provisioned

dateAdded

DateTime

Date/Time the location was registered

Name

Type

Description

locationId

String

ID generated by 911 provider (DASH) associated with the location

address1

String

Street and house number

address2

String

Any additional address information such as "Apt 1" or "STE 100"

city

String

City or community name

state

String

Two letter state abbreviation

zipCode

String

5-digit zip code

plusFour

String

4-digit zip code extension

callerName

String

Caller Name

latitude

String

Latitudinal Coordinates

longitude

String

Longitudinal Coordinates

statusCode

String

GEOCODED or PROVISIONED. Old locations may be VERFIED or UNVERIFIED

statusDescription

String

Describes the statusCode

orderID

String

The order ID that was generated for the location.

activatedTime

DateTime

Date in which the location was provisioned

updateTime

DateTime

Date in which the location was last updated

Name

Type

Description

didCount

String

The number of available DIDs in a specified tier for a rate center

rateCenter

String

Name of the rate center matching the search criteria

state

String

Two letter state abbreviation matching the search criteria

tier

String

The tier in which the numbers reside

lataId

Int

The LATA matching the search criteria

cnam

Boolean

Returns TRUE or FALSE, indicates if the numbers have CNAM Storage

t38

Boolean

Returns TRUE or FALSE, indicates if the numbers are T.38 fax capable

sms

Boolean

Returns TRUE or FALSE, indicates if the numbers are capable of SMS messaging

Name

Type

Description

id

Integer

The port identification number

status

String

The status of the port

endUser

String

The end user associated with the port

billingTN

String

The BTN associated with this port

portingFrom

String

The carrier or network from which the port is taking place

salesRep

String

The account manager for the account

submittedDate

DateTime

The date and time that the port was submitted

focDate

DateTime

The date currently set for this port to FOC

requestedFocDate

DateTime

The requested FOC date for this port

dids

Array

Returns an ArrayOfPortDID

defaultEndpointGroup

Integer

The endpoint group to which the DIDs in this port will be assigned to upon

completion

Name

Type

Description

tn

String

The DID with SMS capability

forwardEmail

String

If the DID has Forward to Email enabled

editable

Boolean

Specifies if the DID is editable

enabled

Boolean

Specifies if the DID has SMS turned on/off

DestinationType

String

NONE, SIP, EMAIL, FORWARD, POST, GET, PROGTELCO, APPFONE

Destination

String

The destination we would send a SMS message to. This could be by API, Forward, etc.

APIAuthToken

String

If the destination type is API Get or Post, you are going to need an Authtoken.

Name

Type

Description

TN

String

A DID that has Fax to Email enabled

Email

String

The email that is associated with the TN

Name

Type

Description

ID

Int

The ID of the Client

Name

String

The name of the client

Note

String

Any notes entered for the client

HostedBillingCustomer

String

The associated Hosted Billing customer

EndpointGroups

nil

If an endpoint group is paired with this client then it will show the Endpoint Group ID

DIDGroups

nil

If a DID group is paired with this client then it will show the DID Group ID

E911Groups

nil

If an E911 group is paired with this client then it will show the E911 Group ID

Name

Type

Description

ID

Int

The ID of the endpoint group

Name

String

The name of the endpoint group

Client

String

The client that is associated with the endpoint group. (If there is one)

Port

String

The port number that you are requesting traffic to be sent to

Prepend

String

Any prepend digits you are looking for VI to send to your network on inbound calls

RateDeck

String

The rate deck that is assigned to the endpoint group

StripPlus

Boolean

True or False if Strip Plus is checked

StripCountryCode

Boolean

True or False if Strip Country Code is checked

International

Boolean

True or False if international termination is enabled.

OrigCallsMTD

Int

The total of Origination Calls month to date to your endpoint group

OrigMinutesMTD

Decimal

The total of Origination Minutes month to date to your endpoint group

OrigCostMTD

Decimal

The total cost for origination calls month to date to your endpoint group

TermCallsMTD

Int

The total of Termination Calls month to date from your endpoint group

TermMinutesMTD

Decimal

The total of Termination Minutes month to date from your endpoint group

TermCostMTD

Decimal

The total cost for termination calls month to date for your endpoint group

TotalCostMTD

Decimal

The total cost for both origination calls and termination calls for your endpoint group

month to date

IPs

nil

If there are IP addresses then it will list your IP addresses associated with your

endpoint group

Name

Type

Description

ScriptID

String

The ID for the programmable telco script

ScriptName

String

The name of the script

APIKey

String

The API key associated with the script

APISecret

String

The API secret that is associated with the script