API for browsing, adding, editing and deleting ANI Format entries.
GET /System/AniFormat
Return a list of ANI Format entries.
GET /System/AniFormat/{Id}
Return a specific ANI Format entry.
POST /System/AniFormat
Create a new ANI Format entry.
PUT /System/AniFormat/{Id}
Update an existing ANI Format entry.
DELETE /System/AniFormat/{Id}
Delete the specified ANI Format entry.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
DNIS Format API
Registration Origin Map API
{
"AniFormatId": 0,
"NodeName": "",
"DnisPrefix": "",
"AddDnisPrefix": "",
"StripDnisSuffix": "",
"AddDnisSuffix": "",
"TrimDnisDigits": 0,
"AniPrefix": "",
"AddAniPrefix": "",
"StripAniSuffix": "",
"AddAniSuffix": "",
"TrimAniDigits": 0,
"Origin": "",
"Description": "",
"Priority": 0,
"RemoveTags": false
}
This table is used to re-format incoming ANI numbers by applying a new prefix to them if the incoming DNIS and ANI_PREFIX match. Usage of this table is controlled by the SYS_ANI_FORMAT system setting, and is a good way to add a outing/mapping code that is used by Devices to identify callers and assign a different Origin and/or Gateway ID.
| Field Name | Type | Size | Description |
|---|---|---|---|
| ANI_FORMAT_ID | int | - | Primary key. |
| NODE_NAME | varchar | 25 | Node name to match. An asterisk (*) is a wildcard. |
| DNIS_PREFIX | varchar | 40 | DNIS (full or partial) to match. |
| ADD_DNIS_PREFIX | varchar | 40 | Prefix to add to the incoming DNIS |
| STRIP_DNIS_SUFFIX | varchar | 40 | Suffix to strip from the incoming DNIS |
| ADD_DNIS_SUFFIX | varchar | 40 | Suffix to add to the incoming DNIS |
| TRIM_DNIS_DIGITS | tinyint | - | Specifies the number of leading digits that should be trimmed from the incoming DNIS. |
| ANI_PREFIX | varchar | 40 | ANI (full or partial) prefix to match. |
| ADD_ANI_PREFIX | varchar | 40 | Prefix to add to the incoming ANI. |
| STRIP_ANI_SUFFIX | varchar | 40 | Suffix to strip from the incoming ANI. |
| ADD_ANI_SUFFIX | varchar | 40 | Suffix to add to incoming ANI. |
| TRIM_ANI_DIGITS | tinyint | - | Specifies the number of leading digits that should be trimmed from the incoming ANI when the ANI_PREFIX matches the incoming ANI. |
| ORIGIN | varchar | 40 | The new Origin to assign to the call. |
| DESCRIPTION | varchar | 40 | Description for this entry. |
| PRIORITY | tinyint | - | When utilizing multiple ANI_FORMAT entries it is possible that two or more 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. |
| REMOVE_TAGS | bit | - | Specifies whether or not tags associated with the incoming ANI should be removed. 0 – Disabled 1 – Enabled |