All API 3.0 Methods
- Tom Cavey
This article contains a listing of all available API 3.0 Methods. All methods require, at the very least, two parameters – Login (username) 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.
3.1 auditDIDs
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, DID, ConferenceLine
3.2 queryDID
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, DIs, ConferenceLine, (a dummy record with a “no records found” status will be returned if no records are found)
3.3 getDIDs
This method allows the user to search the inventory of available DIDs, 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:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
state | String | The two-letter abbreviation for the state. Use “TF” to browse toll-free DIDs. |
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, DIDLocator, ConferenceLine
3.4 assignDID
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 epg properties are required. Optional properties are cnam and refid. |
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DID, ConferenceLine
3.5 configDID
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 epg properties are required. Optional properties are cnam and refid. |
Returns: DIDResponse
Properties populated: responseCode, responseMessage, DID, ConferenceLine
3.6 releaseDID
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, DID, ConferenceLine
3.7 reserveDID
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.
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. |
3.8 getProvisioningHistory
This method gets the provisioning history for a DID. The records returned are from the 911 service provider.
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
did | String | The DID number for which you are retrieving the provisioning history |
Returns: Response911
Properties populated: responseCode, responseMessage, VILocation
3.9 audit911
This method returns the 911 information you have added/updated for all DIDs (including not currently owned a.k.a. off-net DIDs).
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
Returns: Response911
Properties populated: responseCode, responseMessage, DID911
3.10 query911
This method returns the 911 information for the provisioned location of the specified DID.
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
did | String | The DID number for which you wish to view 911 information |
Returns: Response911
Properties populated: responseCode, responseMessage, DID911, VILocation
3.11 remove911
This method removes the 911 information associated with a DID.
Parameters:
Name | Type | Description |
|---|---|---|
login | String | Your API username |
secret | String | Your API user password |
did | String | The DID number for which you are removing 911 information |
Returns: Response911
Properties populated: responseCode, responseMessage, Status911
3.12 insert911
This method adds and provisions a 911location for a DID that is currently registered with your account.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
did | String | The DID number for which you are updating 911 information |
address1 | String | The street and house number |
address2 | String | Additional information such as apartment or suite |
city | String | City or community |
state | String | The two-letter abbreviation for the state |
zip | String | The 5-digit ZIP code |
plusFour | String | The 4-digit ZIP code extension |
callerName | String | The caller name to be associated with the DID |
Returns: Response911
Properties populated: responseCode, responseMessage, Status911
3.13 update911
This method updates the provisioned 911location information for a DID that is currently registered with your account.
An INVALID location information will result in no provisioned location for the specified DID.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
did | String | The DID number for which you are updating 911 information |
address1 | String | The street and house number |
address2 | String | Additional information such as apartment or suite |
city | String | City or community |
state | String | The two-letter abbreviation for the state |
zip | String | The 5-digit ZIP code |
plusFour | String | The 4-digit ZIP code extension |
callerName | String | The caller name to be associated with the DID |
Return: Response911
Properties populated: responseCode, responseMessage, Status911
3.14 getDIDCount
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 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’ |
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) 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, DIDCount, ConferenceLine
3.15 isPortable
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.16 getPortDetails
Returns the details of a specified port ID.
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
portID | Integer | The port ID you would like to query |
Returns: PortResponse
Properties populated: responseCode, responseMessage, PortDetail, IsPortable
3.17 GetCountries (Not Currently In Use)
This method returns a list of available countries and city codes from which international DIDs can be selected.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
Returns: IntlResponse
Properties populated: responseCode, responseMessage, Country
3.18 AssignIntlDID (Currently Not in Use)
This method assigns an available International DID to a valid endpoint group on your account.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
cityID | Integer | The city ID from which you are assigning the international DID |
epgID | Integer | The endpoint group ID to assign the new international DID |
The endpoint group to which you are assigning this DID MUST have the Strip Country Code (Strip CC) disabled to assign an international DID.
This method will return a 900-error code if there are no DIDs currently available for the indicated city code.
Returns: IntlResponse
Properties populated: responseCode, responseMessage, Country, IntlDID
3.19 ReleaseIntlDID
This method removes an International DID from your account.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tn | String | The international DID to release from the account |
Returns: IntlResponse
Properties populated: responseCode and responseMessage
3.20 SetFaxToEmail
This method sets the fax to email feature on a DID.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tn | String | The DID to add this feature to |
String | The recipient email address |
Returns: FaxToEmailResponse
Properties populated: responseCode, responseMessage, Email
3.21 GetFaxToEmail
This method returns the fax to email recipient for a given DID.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tn | String | The DID to query |
Returns: FaxToEmailResponse
Properties populated: responseCode, responseMessage, Email
3.22 RemoveFaxToEmail
This method removes fax to email from a specific DID.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tn | String | The DID for which to remove the FaxToEmail feature |