API for managing the destination, Class 5 settings and the account associated with each termination number.
GET /accounts/{AccountId}/services/termination
Return a list of Termination entries for the specified account.
GET /accounts/services/termination/{LookupValue}
Return a specific Termination entry by Id or DNIS.
If LookupValue is quoted, then it will be considered a DNIS, otherwise it will be assumed to be an Id.
POST /accounts/services/termination
Create a new Termination entry.
PUT /accounts/services/termination
Update an existing Termination entry.
DELETE /accounts/services/termination/{Id}
Delete the specified Termination entry.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
{
"TerminationId": 0,
"Dnis": "",
"Destination": "",
"Account": "",
"CallTimeout": 0,
"CallForwardAll": "",
"CallForwardAllActive": false,
"CallForwardBusy": "",
"CallForwardBusyActive": false,
"CallForwardNoAnswer": "",
"CallForwardNoAnswerActive": false,
"CallForwardFailure": "",
"CallForwardFailureActive": false,
"CallForwardDnd": 0,
"VoiceMailBox": "",
"VoiceMailBoxActive": false,
"EndpointType": "etNone",
"Realm": "",
"Description": "",
"Enabled": false,
"LastCalledDateTime": "",
"ExpirationDateTime": "",
"Parameters": ""
}
This table is used to hold the destination, Class 5 settings and the account associated with each termination number.
| Field Name | Type | Size | Description |
|---|---|---|---|
| TERMINATION_ID | bigint | 8 | Primary key. |
| DNIS | varchar | 40 | Specifies the DNIS number (the number the caller dialed to reach the system) that will be used to reference this entry whenever a call arrives on a given device that is processed by the 800 Termination module with a DNIS number equal to this entry. |
| DESTINATION | varchar | 40 | Specifies the actual destination number that callers will be transferred to whenever calls arrive for the given DNIS number. The destination number must be specified in E.164 format to be properly processed. |
| ACCOUNT | varchar | 40 | Foreign key into the ACCOUNTS table that specifies the default account that will be used to bill calls that are processed by this entry. |
| CALL_TIMEOUT | smallint | 2 | Call timeout of a placed call before a no answer condition is returned. If set to zero the Termination Module’s CALL_TIMEOUT setting will be used. |
| CALL_FORWARD_ALL | varchar | 40 | When a value is specified this is the destination number to forward all calls. |
| CALL_FORWARD_ALL_ACTIVE | bit | 1 | Determines whether CALL_FORWARD_ALL number is active. |
| CALL_FORWARD_BUSY | varchar | 40 | When a value is specified this is the destination number to forward calls when calls to the DESTINATION ring busy. |
| CALL_FORWARD_BUSY_ACTIVE | bit | 1 | Determines whether CALL_FORWARD_BUSY number is active. |
| CALL_FORWARD_NO_ANSWER | varchar | 40 | When a value is specified this is the destination number to forward calls when calls to the DESTINATION are not answered. |
| CALL_FORWARD_NO_ANSWER_ACTIVE | bit | 1 | Determines whether CALL_FORWARD_NO_ANSWER number is active. |
| CALL_FORWARD_FAILURE | varchar | 40 | When a value is specified this is the destination number to forward calls when calls to the DESTINATION result in a failure response (4XX, 5XX or 6XX - except 486 Busy) or when the destination is a registered endpoint and it is not registered. |
| CALL_FORWARD_FAILURE_ACTIVE | bit | 1 | Determines whether CALL_FORWARD_FAILURE number is active. |
| CALL_FORWARD_DND | tinyint | 1 | Status of Do Not Disturb 0 – Disabled 1 – Play “Please try again later…” message 2 – Play “Out of Service” message |
| VOICE_MAIL_BOX | varchar | 40 | Voice mail box associated with this entry. |
| VOICE_MAIL_BOX_ACTIVE | bit | 1 | Determines whether VOICE_MAIL_BOX is active. |
| ENDPOINT_TYPE | bit | 1 | Foreign key into the ENDPOINT_TYPES table. When set to one (1) indicates that the DESTINATION is a registered endpoint (i.e., an IP device that has registered with the system) such that if the endpoint is not registered (e.g. the registration has expired or the device has not registered because of a network failure or the device is off) the system will not attempt to place a call to the device but will automatically fail over to the CALL_FORWARD_FAILURE destination, and if not specified will fail over to the CALL_FORWARD_NO_ANSWER destination, and if not specified will reject the call. |
| REALM | varchar | 255 | When the REGISTERED_ENDPOINT column is set to one (1) the system will use this REALM column when trying to find the DESTINATION in the LOCATION_SERVICE and LOCATION_SERVICE_DETAILS table so that you can filter the lookup to one or more realms when searching for a matching entry for the DESTINATION when trying to determine if it is registered or not. This entry may be set to an asterisk (*) so that the system will not filter matching registration entries to a particular realm, it may be set to a specific realm, or it may be set to a comma delimited list of realms (e.g. proxy.abc.com,proxy.acme.com,proxy.xyz.com). |
| DESCRIPTION | varchar | 40 | Description of this entry for reference purposes. |
| ENABLED | bit | 1 | Indicates whether this entry is active (1) or not (0) |
| LAST_CALLED_DATE_TIME | datetime | 8 | Date/time of last call. |
| EXPIRATION_DATE_TIME | datetime | 8 | Date/time when this entry expires. |
| PARAMETERS | varchar | 1024 | Miscellaneous parameters for custom implementation purposes. |