Data Objects

Table of contents:

2.1 DID

A DID is ‘Direct Inward Dial’ and is a telephone number.

Methods using DID object(s): auditDIDs, queryDID, assignDID, configDID, releaseDID, reserveDID, GetDIDFailover, GetDIDForward, AuditDIDGroup

Properties:

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.

2.2 DIDLocator

A DIDLocator is a representation of DID information in our database.

Methods using DIDLocator object(s): getDIDs

Properties:

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

2.3 DIDParam

A DIDParam defines values for modifying a DID

Methods using DIDParam object(s): assignDID, configDID, releaseDID, reserveDID, InventoryDIDs

Properties:

Name	Type	Description
tn	String	Telephone Number
locationId	String	ID generated by our 911 provider associated with the location
cnam	String	This is the bit value “0” or “1” for setting inbound CNAM dips inactive (0) or active (1)
refId	String	This is the customer-defined reference ID 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.

2.4 DID911

DID911 defines data stored in our database pertaining to a 911 registration for a DID

Methods using DID911 object(s): audit911, query911

Properties:

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

2.5 Status911

A Status911 defines the status code and status description of a modified 911 location or DID

Methods using Status911 object(s): provisionLocation, removeLocation, update911, insert911, remove911

Properties:

Name	Type	Description
statusCode	String	Used to determine the status of the database call
statusDescription	String	Describes the status of the database call

2.6 VILocation

A VILocation defines data that is stored in our database for a location registered to a DID

Methods using VILocation object(s): addLocation, getLocations, getProvisioningHistory, query911

Properties:

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

2.7 DIDCount

A DIDCount gives information about a Rate Center and the number of available DIDs by tier

Methods using DIDCount object(s): getDIDCount

Properties:

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

2.8 PortDetail

A PortDetail gives information about a port

Methods using PortDetail object(s): getPortDetails, GetPortHistory, getActivePorts

Properties:

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

2.9 Country

A Country contains general information regarding the country for international numbers. This is used to obtain a cityID so you can assign an international DID

Methods using Country object(s): getCountries, AssignIntlDID

Properties:

Name	Type	Description
name	String	The full name for the country
abbrev	String	The two-letter abbreviation for this country
cities	Array	Returns an ArrayOfCity

2.10 IntlDID

An IntlDID is returned after a successful assignIntlDID method call. This contains the assigned international DID along with the country and city in which is resides.

Methods using IntlDID object(s): AssignIntlDID, AuditIntlDIDs

Properties

Name	Type	Description
tn	String	The full telephone number that has been assigned
country	String	The full country name of the assigned DID
city	String	The full city name of the assigned DID
tier	String	The tier of the IntlDID
status	String	The status of the IntlDID
sms	Boolean	True or False if the DID has SMS capabilities