API for managing call forward selective entries, which are used to selectively call forward incoming calls to different destinations or selectively block incoming callers from dialing a user on the system.
GET /accounts/{AccountId}/services/callforwardselective
Return a list of call forward selective entries for the specified account.
GET /accounts/services/callforwardselective/{LookupValue}
Return a specific call forward selective entry by Id.
POST /accounts/services/callforwardselective
Create a new call forward selective entry.
PUT /accounts/services/callforwardselective
Update an existing call forward selective entry.
DELETE /accounts/services/callforwardselective/{Id}
Delete the specified call forward selective entry.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
{
"CallForwardSelectiveId": 0,
"Dnis": "",
"Number": "",
"Destination": "",
"Password": "",
"Account": "",
"ForwardType": 0,
"StartDate": "",
"EndDate": "",
"DayRange": "",
"StartTime": "",
"EndTime": "",
"Priority": 0,
"Enabled": false
}
This table is used to selectively call forward incoming calls to different destinations or selectively block incoming callers from dialing a user on the system.
| Field Name | Type | Size | Description |
|---|---|---|---|
| CALL_FORWARD_SELECTIVE_ID | bigint | 8 | Primary key. |
| DNIS | varchar | 40 | DNIS to match, or enter an asterisk (*) as a wildcard to apply across all DNIS numbers. |
| NUMBER | varchar | 40 | Number, IP address or partial IP address (e.g. 192...* to ALLOW an entire A class of IP addresses) to allow access. |
| DESTINATION | varchar | 40 | Destination to forward caller to on a matching entry. |
| PASSWORD | varchar | 20 | Password that the caller must enter in order to be transferred to the specified DESTINATION. |
| ACCOUNT | varchar | 40 | Account that this entry is associated with. |
| FORWARD_TYPE | tinyint | 1 | Determines the type of forwarding for this entry. 0 - Default, forward to DESTINATION 1 - Disconnect 2- Play or Send Busy 3- Play or Send FastBusy 4 - DND (Play called party is unavailable prompt) 5 - DND - Out of Service (Play out of service prompt) 6- Blocked (Play caller is blocked prompt) |
| START_DATE | smalldatetime | 4 | Specifies the start of the date range for which this entry is valid. |
| END_DATE | smalldatetime | 4 | Specifies the end of the date range for which this entry is valid. |
| DAY_RANGE | char | 7 | Specifies the day range for which this entry is valid. Days are specified as a bitmap, where the first bit represents Monday and the last bit represents Sunday (e.g. for week days you would enter 0111110). |
| START_TIME | varchar | 8 | Specifies the start of the time range for which this entry is valid. |
| END_TIME | varchar | 8 | Specifies the end of the time range for which this entry is valid. |
| PRIORITY | tinyint | 1 | When utilizing Call Forward Selective with more than one entry it is possible that two entries are active and valid at the same time. By assigning one entry a higher priority you can ensure that it will take precedence over an equally valid entry with a lower priority. |
| ENABLED | bit | 1 | Specifies whether or not this entry is active or should be temporarily ignored. 0 -Disabled 1- Enabled |