API for browsing, adding, editing and deleting Registration Origin Map entries.
GET /System/RegistrationOriginMap
Return a list of Registration Origin Map entries.
GET /System/RegistrationOriginMap/{Id}
Return a specific Registration Origin Map entry.
POST /System/RegistrationOriginMap
Create a new Registration Origin Map entry.
PUT /System/RegistrationOriginMap/{Id}
Update an existing Registration Origin Map entry.
DELETE /System/RegistrationOriginMap/{Id}
Delete the specified Registration Origin Map entry.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
ANI Format API
DNIS Format API
{
"RegistrationOriginMapId": 0,
"NodeName": "",
"Origin": "",
"Prefix": "",
"CallerRegistered": false,
"Realm": "",
"TrimDigitsPrefix": 0,
"TrimDigitsSuffix": 0,
"AddPrefix": "",
"AddSuffix": "",
"OriginRegistered": "",
"OriginNotRegistered": "",
"Description": "",
"Priority": 0
}
This table is used to set the ORIGIN that can be used for rating and/or routing purposes based on the caller ID of the incoming party, whether or not the incoming caller/device is a registered endpoint and/or whether or not the terminating endpoint is a registered endpoint (looking up entries in the LOCATION_SERVICE table for registered endpoints). Usage of this table is controlled by the SYS_REGISTRATION_ORIGIN_MAP system setting and is typically used to facilitate on-net and off-net rating where on-net to on-net calling may be a different rate than on-net to off-net calling.
Field Name | Type | Size | Description |
---|---|---|---|
REGISTRATION_ORIGIN_MAP_ID | int | Primary key. | |
NODE_NAME | varchar | 25 | Node name to match. An asterisk (*) is a wildcard. |
ORIGIN | varchar | 40 | Origin of inbound call. |
PREFIX | varchar | 40 | Full or partial prefix to match for the dialed destination. |
CALLER_REGISTERED | bit | - | If checked (1) this entry applies if the calling party a registered endpoint. If unchecked (0) this entry applies if the calling party is not a registered endpoint. |
REALM | varchar | 255 | This column is used when trying to determine if the dialed destination is currently registered (i.e., off-net or on-net) by using this column to optionally filter matching entries in the LOCATION_SERVICE and LOCATION_SERVICE_DETAILS table to a particular realm or list of realms. 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). |
TRIM_DIGITS_PREFIX | tinyint | - | Specifies the number of leading digits that should be trimmed from the dialed destination when the TRIM_DIGITS_PREFIX matches the dialed destination. |
TRIM_DIGITS_SUFFIX | tinyint | - | Specifies the number of trailing digits that should be trimmed from the end of the dialed destination when the TRIM_DIGITS_SUFFIX matches the dialed destination. |
ADD_PREFIX | varchar | 40 | Prefix to add to the beginning of the dialed destination. |
ADD_SUFFIX | varchar | 40 | Suffix to add to the end of the dialed destination. |
ORIGIN_REGISTERED | varchar | 40 | The new origin to assign to the call if the dialed destination is a registered endpoint. |
ORIGIN_NOT_REGISTERED | varchar | 40 | The new origin to assign to the call if the dialed destination is not a registered endpoint. |
DESCRIPTION | varchar | 40 | Description for this entry. |
PRIORITY | tinyint | - | When utilizing multiple REGISTRATION_ORIGIN_MAP 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. |