...
| Expand | ||
|---|---|---|
| ||
|
2.1 DID
...
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.
...
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 |
2.11 DIDGroup
A DID group is a collection of DIDs. This feature is for your convenience to assist in tracking usage and spending for this collection of numbers on your account.
...
Name | Type |
| Description |
id | Int | Database ID of the group | |
name | String | Name of the group | |
2.12 ConferenceLine
A ConferenceLine object is returned along with a standard DIDResponse in response to a GetConferenceLine method call.
...