Supported in Sandbox - Deprecated
- Tom Cavey
- Ian Hambelton (Unlicensed)
The API Sandbox environment has since been deprecated.
All methods require, at the very least, two parameters – Login and Password. These will be the first two parameters of every method call. Login/Password credentials can be managed in the Back Office at Add-Ons -> API Users. All methods will return a response object.
Supported in Sandbox
3.1 auditDIDs
3.2 queryDID
3.3 assignDID
3.4 getDIDs
3.5 configDID
3.6 releaseDID
3.7 reserveDID
3.8 isPortable
3.9 getDIDCount
3.10 getPortDetails
3.1 auditDIDs Top
This method returns all DIDs that the client currently owns, as well as key information regarding each of those DIDs.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DIDs, ConferenceLine
3.2 queryDID Top
This method returns key information regarding the DID being queried. If the DID is owned by the client, the function will return various parameters pertaining to the DID. If the DID is available to purchase or not available, the function will return such information instead.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
did | String | The telephone number or DID that you are querying |
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DIDs, ConferenceLine, (a dummy record with a "no records found" status will be returned if no records are found)
3.3 assignDID Top
This method assigns an available or reserved DID to a valid endpoint group on your account.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
DIDParam | List | Each DIDParam represents a DID to assign. The tn and endpointId properties are |
required. Optional properties are cnam and refid. | ||
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DIDs (one DID per param), ConferenceLine
3.4 getDIDs Top
This method allows the user to search the inventory of available DIDs by one or more, and returns all DIDs that meet the desired criteria. At least one search criteria must be passed. Pass an empty String or null for criteria not being searched on.
Parameters: At least one search criterion must be provided. However, we recommend passing as many fields as possible to reduce the search time.
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
state | String | The two-letter abbreviation for the state |
lata | String | The LATA in which you are searching |
rateCenter | String | The rate center in which you are searching |
npa | String | The NPA or area code |
nxx | String | The NXX or exchange |
tier | String | The tier in which you would like to search |
t38 | String | Indicates if the number/s should support T.38 faxing. Can be sent with '1/true' or |
'0/false' | ||
cnam | String | Indicates if the number/s should support outbound CNAM storage. Can be sent with |
'1/true' or '0/false' | ||
sms | String | Indicates if the number/s should support SMS messaging. Can be sent with '1/true' or |
'0/false' | ||
Network | String | Name of the network to filter. Ex: "Level 3", "Bandwidth" |
Returns: DIDresponse
Properties populated: responseCode, responseMessage, DIDLocators, ConferenceLine
3.5 configDID Top
This method configures the endpoint group and cnam for DIDs which are assigned to your account.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
DIDParam | List | Each DIDParam represents a DID to assign. The tn and endpointId properties are |
required. Optional properties are cnam and refid. | ||
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DIDs (one DID per param), ConferenceLine
3.6 releaseDID Top
This method is used to release DIDs from an account Parameters:
Name | Type | Description | |
login | String | Your API username | |
secret | String | Your API user password | |
DIDParam | List | Each DIDParam represents a DID to assign. The tn property is required. Optional | |
properties are cnam and refid. | |||
Returns: DIDResponse | |||
Properties populated: responseCode, responseMessage, DIDs (one DID per param), ConferenceLine |
3.7 reserveDID Top
This method will reserve an available DID for a maximum of 30 minutes. If the reserved DID is not assigned before the time expires, it will be released back into inventory.
Name
Type
Description
login
String
Your API username
secret | String | Your API user password | |
DIDParam | List | Each DIDParam represents a DID to assign. The tn property is required. Optional | |
properties are cnam and refid. | |||
Returns: DIDResponse |
Properties populated: responseCode, responseMessage, DIDs (one DID per param), ConferenceLine
3.8 isPortable Top
This method allows the user to determine if a telephone number is portable.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tn | String | A ten-digit telephone number for which you are checking portability |
Returns: PortResponse
Properties populated: responseCode, responseMessage, IsPortable
3.9 getDIDCount Top
This method allows the user to search the inventory of available DIDs by one or more, and returns the number of DIDs available at each rate center per ties. At least one search criteria must be passed. Pass an empty String or null for criteria not being searched on.
Parameters:
Name | Type | Description | |||
login | String | Your API username | |||
secret | String | Your API user password | |||
state | String | The two-letter abbreviation of the State in which you are searching | |||
lata | String | The LATA code in which you are searching |
rateCenter | String | The Rate Center in which you are searching |
npa | String | The NPA or area code in which you are searching |
nxx | String | The NXX or exchange in which you are searching *If this field is specified, NPA must also |
be specified | ||
tier | String | The tier in which you are searching |
t38 | Boolean | Indicates if the number/s support T.38 faxing. Can be sent with '1/true' or '0/false' |
cnam | Boolean | Indicates if the number/s support outbound CNAM Storage. Can be sent with '1/true' |
or '0/false' | ||
orderBy | String | The Field to order results by. The Default is 'state'. Other options are 'rc' for Rate |
Center, 'lata' for the lataid, or 'tier' for the number tier | ||
sms | String | Indicates if the number/s support SMS messaging. Can be sent with '1/true' or |
'0/false' | ||
Network | String | Name of the network to filter. Ex: "Level 3", "Bandwidth" |
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DIDCount, ConferenceLine
3.10 getPortDetails Top
Returns the details of a specified port ID.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
portID | Integer | The port ID you want details about |
Returns: PortResponse
Properties populated: responseCode, responseMessage, PortDetail, IsPortable