List of Reserved Words
The table below lists reserved, built-in variables for use in HMRs.
| $ORIGINAL,LOCAL | $TRUNK_GROUP | $TARGET_PORT |
| $IP,LOCAL_PORT | $TRUNK_GROUP_CONTEXT | $MANIP_STRING |
| $REMOTE_IP | $REPLY_IP | $CRLF |
| $REMOTE_PORT | $REPLY_PORT | $TO_USER |
| $REMOTE_VIA_HOST | $TARGET_IP | $TO_PHONE |
| $TO_HOST | $TO_PORT | $FROM_USER |
| $FROM_PHONE | $FROM_HOST | $FROM_PORT |
| $CONTACT_USER | $CONTACT_PHONE | $CONTACT_HOST |
| $CONTACT_PORT | $RURI_USER | $RURI_PHONE |
| $RURI_HOST | $RURI_PORT | $PAI_USER |
| $PAI_PHONE | $PAI_HOST | $PAI_PORT |
| $PPI_USER | $PPI_PHONE | $PPI_HOST |
| $PPI_PORT | $PCPID_USER | $PCPID_PHONE |
| $PCPID_HOST | $PCPID_PORT | $CALL_ID |
| $TIMESTAMP_UTC | $MANIP_PATTERN | $T_GROUP |
| $T_CONTEXT, | $M_STRING | $M_PATTERN |
Reserved words that do not use the referenced header name include:
- $TARGET_* references the To-URI hostname
- $REPLY_* references the FROM-URI hostname
Reserved word names that are equal, to support legacy version configurations, include:
- $T_GROUP is the same as TRUNK_GROUP
- $T_CONTEXT is the same as TRUNK_CONTEXT
- $M_STRING is the same as MANIP_STRING (and refers to another manipulation)
Reserved variables operate just like user-defined variables. The recommended usage syntax is "$variable.$0". Use of the $0 suffix causes the HMR to retrieve the value of the data. If the $0 is omitted then the resulting value would be <TRUE/FALSE>.
For example, "$PAI_USER" is a valid usage. In this case, the TRUE/FALSE result could be used to determine if there was not a username in the PAI header, or that no PAI header was present in the message.
