Sip Message Manipulation Reference Guide Ver 72

Reference Guide
AudioCodes Media Gateways, Session Border Controllers & MSBRs
SIP Message Manipulation,

Conditions and Call Setup
Rules
Version 7.2
Reference Guide Contents
Table of Contents
1 Introduction ......................................................................................................... 9
2 Field Syntax ....................................................................................................... 11
2.1 Message Type Field ............................................................................................... 11
2.1.1 Message Type Examples ........................................................................................11
2.2 Condition Field ....................................................................................................... 12
2.2.1 Condition Field Operands ........................................................................................12
2.2.2 Condition Field Examples ........................................................................................12
2.3 Action Subject Field ............................................................................................... 13
2.3.1 Action Subject Field Examples ................................................................................13
2.4 Action Type Field ................................................................................................... 14
2.5 Action Value Field .................................................................................................. 14
2.5.1 Action Value Field Examples ...................................................................................14
3 Detailed Syntax ................................................................................................. 15
3.1 Strings .................................................................................................................... 15
3.1.1 String Examples.......................................................................................................16
3.2 Headers.................................................................................................................. 17
3.2.1 Detailed Header Syntax ...........................................................................................17
3.2.2 Header Examples ....................................................................................................27
3.3 Body ....................................................................................................................... 29
3.3.1 Body Examples ........................................................................................................29
3.4 Parameters............................................................................................................. 30
3.4.1 Message Parameter Syntax ....................................................................................30
3.4.2 IP Groups Table Parameter Syntax.........................................................................33
3.4.3 Call Parameter Syntax .............................................................................................35
3.4.4 Parameter Examples ...............................................................................................35
3.4.4.1 Example for IP Group Keep-Alive ............................................................37
4 Advanced Manipulation Features .................................................................... 39
4.1 Wildcards for Header Removal .............................................................................. 39
4.2 Random Characters ............................................................................................... 39
4.3 SDP Body Fields .................................................................................................... 40
4.3.1 Source IP Address ...................................................................................................40
4.3.2 RTP Mode ................................................................................................................41
4.3.3 Origin Username......................................................................................................41
4.3.4 Origin IP Address.....................................................................................................41
4.3.5 Port ..........................................................................................................................41
4.3.6 IP Address ...............................................................................................................42
4.3.7 SDP Examples.........................................................................................................42
4.4 Regular Expressions (Regex) ................................................................................ 44
4.4.1 Regex Basic Examples ............................................................................................45
4.4.2 Regex Detailed Examples .......................................................................................46
4.5 Variables for Copying Data between Messages .................................................... 49
4.5.1 Call Variable ............................................................................................................49
4.5.2 Global Variable ........................................................................................................50
4.5.3 Session Variable ......................................................................................................51
4.5.4 Registered User Variable.........................................................................................51
4.6 ISUP Body Manipulation ........................................................................................ 53
4.6.1 Attaching ISUP Body ...............................................................................................59
Version 7.2 3 MSBRs, Gateways & SBCs

SIP Message Manipulation, Conditions & CSRs
4.6.2 Removing Elements from ISUP Body......................................................................59

4.6.3 ISUP Examples........................................................................................................60
4.6.3.1 ISUP Deny Message Condition Rule .......................................................60
4.6.3.2 ISUP Message Manipulation Rules..........................................................61
4.7 Special Actions using X-AC-Action SIP Header..................................................... 62
4.8 SIP Message Normalization ................................................................................... 64
4.9 Source and Destination Dial Plan Tags ................................................................. 67
4.10 ENUM Queries ....................................................................................................... 67
4.11 SIP URIs and LDAP Queries for Microsoft Skype Presence Feature .................... 69
5 Typical Examples .............................................................................................. 71
A Message Manipulation Syntax Reference ....................................................... 73
A.1 Action Type ............................................................................................................ 73
A.2 Header Types......................................................................................................... 73
A.2.1 Accept ......................................................................................................................73
A.2.2 Accept-Language.....................................................................................................74
A.2.3 Allow ........................................................................................................................74
A.2.4 Call-Id.......................................................................................................................75
A.2.5 Contact.....................................................................................................................75
A.2.6 Cseq.........................................................................................................................76
A.2.7 Diversion ..................................................................................................................76
A.2.8 Event ........................................................................................................................77
A.2.9 From.........................................................................................................................78
A.2.10 History-Info ..............................................................................................................78
A.2.11 Min-Se and Min-Expires ..........................................................................................79
A.2.12 P-Asserted-Identity ..................................................................................................80
A.2.13 P-Associated-Uri ......................................................................................................80
A.2.14 P-Called-Party-Id .....................................................................................................81
A.2.15 P-Charging-Vector ...................................................................................................82
A.2.16 P-Preferred-Identity .................................................................................................82
A.2.17 Privacy .....................................................................................................................83
A.2.18 Proxy-Require ..........................................................................................................83
A.2.19 Reason.....................................................................................................................84
A.2.20 Referred-By .............................................................................................................85
A.2.21 Refer-To ...................................................................................................................85
A.2.22 Remote-Party-Id ......................................................................................................86
A.2.23 Request-Uri ..............................................................................................................87
A.2.24 Require ....................................................................................................................88
A.2.25 Resource-Priority .....................................................................................................89
A.2.26 Retry-After ...............................................................................................................89
A.2.27 Server or User-Agent ...............................................................................................90
A.2.28 Service-Route ..........................................................................................................90
A.2.29 Session-Expires .......................................................................................................91
A.2.30 Subject .....................................................................................................................92
A.2.31 Supported ................................................................................................................92
A.2.32 To .............................................................................................................................93
A.2.33 Unsupported ............................................................................................................94
A.2.34 Via ............................................................................................................................94
A.2.35 Warning ...................................................................................................................95
A.2.36 Unknown Header .....................................................................................................96
A.3 Structure Definitions ............................................................................................... 97
A.3.1 Event Structure ........................................................................................................97
A.3.2 Host..........................................................................................................................97
A.3.3 MLPP .......................................................................................................................97
A.3.4 Privacy Struct ...........................................................................................................98
A.3.5 Reason Structure .....................................................................................................98
Reference Guide 4 Document #: LTRT-29040

Reference Guide Contents
A.3.6 SIPCapabilities ........................................................................................................98

A.3.7 URL ..........................................................................................................................99
A.4 Random Type....................................................................................................... 100
A.4.1 Random Strings .....................................................................................................100
A.4.2 Random Integers ...................................................................................................100
A.5 Enum Definitions .................................................................................................. 101
A.5.1 AgentRole ..............................................................................................................101
A.5.2 Event Package.......................................................................................................101
A.5.3 MLPP Reason Type...............................................................................................102
A.5.4 Number Plan ..........................................................................................................102
A.5.5 Number Type .........................................................................................................102
A.5.6 Privacy ...................................................................................................................103
A.5.7 Reason (Diversion) ................................................................................................103
A.5.8 Reason (Reason Structure) ...................................................................................103
A.5.9 Reason (Remote-Party-Id).....................................................................................106
A.5.10 Refresher ...............................................................................................................106
A.5.11 Screen....................................................................................................................106
A.5.12 ScreenInd ..............................................................................................................106
A.5.13 TransportType .......................................................................................................107
A.5.14 Type .......................................................................................................................107
A.5.15 Address Presentation Restricted Indicator ............................................................107
A.5.16 Transmission Medium Requirement ......................................................................107
A.5.17 Charge Indicator ....................................................................................................108
A.5.18 Called Party Status Indicator .................................................................................108
A.5.19 Called Party Category Indicator .............................................................................108
A.5.20 Event Information...................................................................................................108
A.5.21 Cause Value ..........................................................................................................109
A.5.22 Cause Location ......................................................................................................111
A.5.23 Redirect Reason ....................................................................................................111
A.6 Actions and Types................................................................................................ 112
A.7 Syntax .................................................................................................................. 117
A.7.1 Message Type .......................................................................................................117
A.7.2 Condition ................................................................................................................117
A.7.3 Action Subject ........................................................................................................118
A.7.4 Action Type ............................................................................................................120
A.7.5 Action Value ...........................................................................................................121
List of Tables
Table 1-1: Configuration Tables and Relevant Fields ..............................................................................9
Table 2-1: Message Type Examples ......................................................................................................11
Table 2-2: Condition Operands ..............................................................................................................12
Table 2-3: Condition Examples ..............................................................................................................12
Table 2-4: Action Examples....................................................................................................................13
Table 2-5: Action Type Field Options .....................................................................................................14
Table 2-6: Action Examples....................................................................................................................14
Table 3-1: Configuration Tables and Relevant Fields for Strings...........................................................15
Table 3-2: Examples of Using Strings ....................................................................................................16
Table 3-3: Syntax for Manipulating SIP Headers ...................................................................................17
Table 3-4: Header Field Syntax Examples .............................................................................................27
Table 3-5: Header Field Manipulation Rules Examples .........................................................................27
Table 3-6: Message Body Syntax Examples..........................................................................................29
Table 3-7: Message Body Manipulation Rules Examples ......................................................................29
Table 3-8: Message Parameter Syntax ..................................................................................................30
Table 3-9: IP Group Parameter Syntax ..................................................................................................33

Table 3-10: Call Parameter Syntax ........................................................................................................35

Table 3-11: Parameter Examples ...........................................................................................................35
Table 4-1: Examples using Random Letters and Numeric Characters ..................................................40
Table 4-2: Examples using SDP Body Fields.........................................................................................42
Table 4-3: Configuration Tables and Relevant Fields ............................................................................44
Table 4-4: Regex Examples for Message Manipulation, Message Conditions and CSR ......................45
Table 4-5: Regex Examples for Pre-Parsing Manipulation Rules ..........................................................45
Table 4-6: Examples of Call Variables ...................................................................................................49
Table 4-7: Example of Global Variables .................................................................................................50
Table 4-8: Example of Session Variables ..............................................................................................51
Table 4-9: Example of User Variables....................................................................................................52
Table 4-10: ISUP Body Manipulation Rules Examples ..........................................................................61
Table 4-11: X-AC-Action Header Manipulation Rule Example...............................................................62
Table 4-12: Normalization Examples .....................................................................................................66
Table 4-13: Source and Destination Tags Examples .............................................................................67
Table 4-14: ENUM Query Example ........................................................................................................68
Table 4-15: Source and Destination SIP URIs for Skype for Business Presence .................................69
Table 5-1: Message Manipulation Examples .........................................................................................71
Table A-1: Action Types .........................................................................................................................73
Table A-2: Event Structure .....................................................................................................................97
Table A-3: Host Structure .......................................................................................................................97
Table A-4: MLPP Structure.....................................................................................................................97
Table A-5: Privacy Structure...................................................................................................................98
Table A-6: Reason Structure ..................................................................................................................98
Table A-7: SIPCapabilities Structure ......................................................................................................98
Table A-8: URL Structure .......................................................................................................................99
Table A-9: Enum Agent Role ................................................................................................................101
Table A-10: Enum Event Package .......................................................................................................101
Table A-11: Enum MLPP Reason Type ...............................................................................................102
Table A-12: Enum Number Plan ..........................................................................................................102
Table A-13: Enum Number Type ..........................................................................................................102
Table A-14: Enum Privacy ....................................................................................................................103
Table A-15: Enum Reason ...................................................................................................................103
Table A-16: Enum Reason (Reason Structure)....................................................................................103
Table A-17: Enum Reason (RPI) ..........................................................................................................106
Table A-18: Enum Refresher ................................................................................................................106
Table A-19: Enum Screen ....................................................................................................................106
Table A-20: Enum ScreenInd ...............................................................................................................106
Table A-21: Enum TransportType ........................................................................................................107
Table A-22: Enum Type........................................................................................................................107
Table A-23: Enum Presentation Restricted Indicator ...........................................................................107
Table A-24: Enum Transmission Medium Requirement ......................................................................107
Table A-25: Enum Charge Indicator .....................................................................................................108
Table A-26: Enum Called Party Status Indicator ..................................................................................108
Table A-27: Enum Called Party Category Indicator .............................................................................108
Table A-28: Enum Event Information ...................................................................................................108
Table A-29: Enum Cause Value ...........................................................................................................109
Table A-30: Enum Cause Location ......................................................................................................111
Table A-31: Enum Redirect Reason.....................................................................................................111
Table 5-32: Action and Types ..............................................................................................................112

Reference Guide Notices
Notice
Information contained in this document is believed to be accurate and reliable at the time of
printing. However, due to ongoing product improvements and revisions, AudioCodes cannot
guarantee accuracy of printed material after the Date Published nor can it accept responsibility
for errors or omissions. Updates to this document can be downloaded from
https://www.audiocodes.com/library/technical-documents.
This document is subject to change without notice.
Date Published: April-22-2018
WEEE EU Directive
Pursuant to the WEEE EU Directive, electronic and electrical waste must not be disposed
of with unsorted waste. Please contact your local recycling authority for disposal of this
product.
Customer Support
Customer technical support and services are provided by AudioCodes or by an authorized
AudioCodes Service Partner. For more information on how to buy technical support for
AudioCodes products and for contact information, please visit our Web site at
https://www.audiocodes.com/services-support/maintenance-and-support.
Abbreviations and Terminology

Each abbreviation, unless widely used, is spelled out in full when first used.
Document Revision Record
LTRT Description
28631 Initial document release for Version 7.2.

28632 Attaching ISUP to SIP message body; Additional ISUP Backward Call Indicator fields;
param.message.address.<src/dst>.sipinterface; Special Actions using X-AC-Action SIP
Header; Source and Destination Dial Plan Tags.
28633 ISUP syntax typos corrected ("body.isup" and "obci"); ISUP syntax added for SIP 200
OK (ANM) and INFO (FAC) messages; Attaching ISUP Body section updated with
"FAC"; new section, Removing Elements from ISUP Body; ISUP syntax typos corrected
in section, ISUP Examples; typo corrected in example for info.response.
28636 Updated sections: Action (example typo); Typical Examples (typo);
28637 Regex example; typo in example for 'early-session'.
28645 Concatenate strings (+ operand); Condition Field Examples; IP Group parameters
(param.ipg.src.tags, param.ipg.dst.tags, param.ipg.src.tags.<tag name>,
param.ipg.dst.tags.<tag name>, param.ipg.src.name, param.ipg.dst.name); Parameter
Examples; param.message.sdp.originusername; SDP Examples; Regex updated; ISUP
Body Manipulation (Access transport / User service information; SIP URIs for Microsoft
Skype Presence Feature

LTRT Description
28646  Updated sections: String Examples (description); Message Parameter Syntax

(descriptions); Special Actions using X-AC-Action SIP Header; Warning
 New syntax: message.incoming.remote-port; message.outgoing.remote-port;
message.incoming.local-port; message.outgoing.local-port
 Updated syntax: param.message.address.<src/dst>.port (removed)
28649  Updated with patch Version 7.20A.156.009
 Updated sections: SDP Examples (var.call.src); Regex Basic Examples (new
example); Call Variable (typo for var.call.src); Contact; P-Asserted-Identity; P-
Associated-Uri; P-Preferred-Identity; Proxy-Require ("capabilities"); Require
("capabilities"); Supported ("capabilities"); Warning; Detailed Header Syntax (new
headers: Content-Disposition; Content-Length; Content-Type; Date; Join; P-Charge-
Info; Priority; Proxy-Authenticate; Proxy-Authorization; Rack; Record-Route;
Replaces; RSEQ; SIP ETag; SIP If-Match; Subscription State; Target Dialog;
Unknown headers; WWW Authenticate; X-AC-Action; X-Channel; X-RTP-Stat);
Referred-By attributes; Refer-To attributes; Remote-Party-ID Reason types); IP
Group Table Parameter Syntax (param.ipg.src.user-defined)
 New sections: ENUM Queries
29040  Updated with patch Version 7.20A.200.019
 header.user-agent ("content" removed); capabilities syntax fixed; User-To-User and
X-UserToUser header syntax updated; syntax updated for IP Groups table
parameters; enum.result.url syntax updated and example; example added for
header.user-to-user.param.purpose; user variables; example for IP Group Keep-
Alive
Documentation Feedback
AudioCodes continually strives to produce high quality documentation. If you have any
comments (suggestions or errors) regarding this document, please fill out the
Documentation Feedback form on our Web site at at
https://online.audiocodes.com/documentation-feedback.

Reference Guide 1. Introduction
1 Introduction
This document describes the supported syntax for the configuration tables listed below.
Table 1-1: Configuration Tables and Relevant Fields
Table Fields
Message Manipulations Table  Message Type

 Condition
 Action Subject
 Action Type
 Action Value
Message Conditions Table  Condition
Pre-Parsing Manipulation Table  Message Type
 Pattern
 Replace-With
Call Setup Rules Table  Condition
 Action Subject
 Action Type
 Action Value

This page is intentionally left blank.

Reference Guide 2. Field Syntax
2 Field Syntax
2.1 Message Type Field
The 'Message Type' field defines the type of SIP message that you want to apply the
manipulation or condition rule.
Syntax:
<SIP-method/any>.<request/response/any>.<response-type>
where:
 <SIP-method/any> specifies the SIP method used with the option to specify requests
of all method types.
 <request/response/any> specifies the SIP request or SIP response type with the
option to specify any request or response type.
 <response-type> specifies the SIP response type. You can also use the 'x' wildcard
to denote multiple response types:
• To denote all SIP 18x responses (e.g., 180, 181, 182 and 183), use the following
syntax: 18x
• To denote all response types belonging to a specific response group (i.e., 1xx for
provisional, 2xx for successful, 3xx for redirection, 4xx for client failure, 5xx for
server failure, and 6xx for global failure responses), use two 'x' wildcards instead
of the last two digits of the response: <first digit of response
group>xx (e.g., 1xx)
2.1.1 Message Type Examples

The following table provides examples of different message types.
Table 2-1: Message Type Examples
Message Types Description
invite.request INVITE requests
invite.response.200 INVITE 200 responses only
register.response.2xx All 2xx responses for REGISTER
invite.response.18x All 18x responses for INVITE
subscribe.request All SUBSCRIBE requests
subscribe.response All SUBSCRIBE responses
reinvite.request re-INVITE requests
any.request Requests of all method types, where any is a keyword.
any.response.200 All 200 responses for all method types, where any is a
keyword.
invite Requests and responses of INVITE method.
<empty> All request and responses for all method types.
info.any All INFO requests and responses.
private1.request All requests with method 'private1'.

2.2 Condition Field

The 'Condition' field is used to test specific parts of the header in the message with
specified values. Conditions may be combined with other conditions using logical operators
(and/or).
Syntax:
<subject> <operand> <value>
where:
 <subject> specifies the subject of the condition using the following format:
header/body/parameter
 <operand> specifies the operand of the condition using the following format:
condition-operand
 <value> specifies the value of the condition using the following format:
string/header/body/parameter/random/variable/regex
2.2.1 Condition Field Operands

The following table describes the condition operands.
Table 2-2: Condition Operands
Condition Operand Description
== / != Tests for equivalent / not equivalent values.

>= / <= Tests for greater than or equal to / less than or equal to values.
>/< Tests for greater than / less than values.
contains / !contains Tests a string containing / not containing specified text.
exists / !exists Tests whether a parameter exists / does not exist.
suffix / prefix Tests whether a string has a particular suffix / prefix.
len> / len< / len== Tests whether the length of a string is greater than / less than / equal to a
specific value.
regex Tests whether a string matches the given regular expression.
+ Concatenates string values.
2.2.2 Condition Field Examples

The following table provides various examples of different conditions.
Table 2-3: Condition Examples
Condition Description
header.expires.time < '88888' Returns true if expires time is less than '88888'.
header.user-agent contains Returns true if the user agent is 'Android-VMAS' or

'Android-VMAS' 'MP252'.
OR header.user-agent contains
'MP252'

Reference Guide 2. Field Syntax
param.message.sdp.address == Returns true if the "c=" line contains the given IP

'10.132.10.101' address.
header.request- Returns true if the message method type is '415'.

uri.methodtype=='415'
header.diversion.0 regex Returns true if the REGEX engine matches
(<.*)(;urlparam=[a-z]*)(.*>) urlparam=<specific value>.
ldap.attr.msRTCSIP-Line contains LDAP Attribute contains three values, which are

'tel:'+param.call.dst.user+':ext=' separated by the "+" operator.
2.3 Action Subject Field

The 'Action Subject' field defines the message component upon which you wish to
manipulate.
The syntax can include the following:
 header
 body
 variable
2.3.1 Action Subject Field Examples

The following table provides various example actions.
Table 2-4: Action Examples
Action Subject Action Action Value Description

Type
header.cust Add 'Audiocode Adds the "customername" header to

omername s' the message with a value of
"Audiocodes".
header.cust Remove Deletes the header "customername"
omername from the message.
var.global. Modify header.use Stores the content of the User-agent

0 r-agent header in a global variable. Note, the
Modify action is executed on the
variables (not the Add action).
header.cont Add 'audiocode Adds a parameter "company" to a
act.param.c s' Contact header and assigns the value
"Audiocodes" to it.
ompany

2.4 Action Type Field

The 'Action Type' field specifies the type of action you wish to perform on the message
component:
Table 2-5: Action Type Field Options
Action Operand Description
Add Adds entities to a message.

Remove Removes entities from a message.
Modify Modifies parts of a header or SDP.
Add Prefix Adds a string prefix to part of a header.
Add Suffix Adds a string suffix to part of a header.
Remove Prefix Removes a string prefix from part of a header.
Remove Suffix Removes a string suffix to part of a header.
2.5 Action Value Field

The 'Action Value' field defines the value to assign to the 'Action Type' and 'Action Subject'.
The syntax can include the following:
 string
 header
 body
 parameter
 random
 variable
 regex
2.5.1 Action Value Field Examples

The following table provides various example actions.
Table 2-6: Action Examples
Action Subject Action Action Value Description

Type
header.custom Add 'ABCompany' Adds the "customername" header to the

ername message with the value "ABCompany".
header.custom Remove Deletes the header "customername" from

ername the message.
var.global.0 Modify header.user- Stores the content of the User-agent header

agent in a global variable. Note, the Modify action
is executed on the variables (not the Add
action).
header.contac Add 'ABCompany'+' Adds the parameter "company" to the
t.param.compa Sales' Contact header with the values
"ABCompany" and "Sales".
ny

Reference Guide 3. Detailed Syntax
3 Detailed Syntax
This section describes the detailed syntax usage of the fields in the Message
Manipulations table. The following syntax is described:
 Strings – see Section 3.1 on page 15
 Headers – see Section 3.2 on page 17
 Body – see Section 3.3 on page 29
 Parameters – see Section 3.4 on page 30
3.1 Strings
The string type is a series of characters and the most basic of all syntax types.
Syntax
 String enclosed by a single apostrophe:
'string'
 To concatenate strings, use the plus "+" operator:
'string' + 'string'
 To indicate carriage returns (new lines), use the double-backslash (\\):
'string\\string'
Strings can be used as the value in the following fields:

Table 3-1: Configuration Tables and Relevant Fields for Strings
Table Fields
Message Manipulations Table  Condition

 Action Value
Pre-Parsing Manipulation Table  Pattern
 Replace-With
 Action Value

3.1.1 String Examples

The following table provides configuration examples for using strings.
Table 3-2: Examples of Using Strings
Message Condition Action Action Action Description

Type Subject Type Value
invite.re header.user-agent header.user Modify 'anonymous If the INVITE's

quest contains 'X-Lite' -agent UA' User-Agent
header contains
"X-Lite", replace
it with
"anonymous
UA".
invite.re header.from.url.user header.user Modify 'anonymous If the INVITE's
quest =='101;ext=7166' -agent UA' From header
has the user
part as
"101;ext=7166",
replace it with
"anonymous
UA".
invite.re body.sdp contains header.user Modify 'anonymous If the INVITE's
quest 'a=bbb\\a=ccc' -agent UA' SDP contains
these two lines:
a=bbb
a=ccc
then change the
User-Agent
header value to
"anonymous
UA".

3.2 Headers
This section describes the syntax used for SIP headers in the Message Manipulations
table.
Syntax:
header.<header-name>.<header-index>.<sub-type>
where:
 <header-name> specifies the header name as it arrives in the message. For example:
From, To, Contact (not case sensitive).
 <header-index> refers to a specific header, in the event where more than one header
of the same type is present in the message (multiple header fields). The index starts at
0, therefore in order to refer to the first header in the list, the header-index value
should be 0. For example, header.contact.2 would refer to the third header in the list.
If <header-index> is not specified; however, a <sub-type> exists, then the sub-type
would reference the first header in the list, i.e. header.contact.url.user is identical to
header.contact.0.url.user.
If both <header-index> and <sub-type> are not specified, then the subject would refer
to all headers of this type. For example, to remove or modify all headers of a specific
type, refer to the header as header.contact.
 <sub-type> specifies a specific part of the message. For example, url.user, url.host
etc.
Note: The SIP Group Name (IPGroup_SIPGroupName) parameter of the IP Group

table overrides inbound message manipulation rules that manipulate the host name in
Request-URI, To, and/or From SIP headers. If you configure a SIP Group Name for
an IP Group and you want to manipulate the host name in these SIP headers, you
must apply your manipulation rule (Manipulation Set ID) to the IP Group as an
Outbound Message Manipulation Set (IPGroup_OutboundManSet), when the IP
Group is the destination of the call. If you apply the Manipulation Set as an Inbound
Message Manipulation Set (IPGroup_InboundManSet), when the IP Group is the
source of the call, the manipulation rule is overridden by the SIP Group Name.
3.2.1 Detailed Header Syntax

The table below describes the syntax to manipulate the various SIP headers:
Table 3-3: Syntax for Manipulating SIP Headers
SIP Attribute to Manipulation

Example
Header Manipulate Syntax
Accept Header itself header.accept

Accept-Language Header itself header.accept-language
Allow Header itself header.allow
Call-Id Header itself header.call-id
Specific ID header.call-id.id
Contact Header itself header.contact
Expires header.contact.expires


Example
Globally Routable header.contact.gruucontact

UA URI (GRUU)
contact
Enable GRUU header.contact.isgruu
Name header.contact.name
Parameter header.contact.param
Multiple Contact header.contact.<number of header.contac
header fields fields> t.3
URL header.contact.url.<url>
Where <url> can be:
 type: Defines the type of URL: header.contac
 1: Indicates a SIP URI (sip:) t.url.type ==
 2: Indicates a SIP Tel URI (tel:) '1'
 3: Indicates a fax URI (fax:)
 4: Indicates a SIPS URI (sips:)
 host: Indicates host part. The host by itself header.contac
includes both domain name/IP address and t.url.host.po
port, e.g., 10.33.2.6:5070. However, you can
indicate only the name/IP address or only the rt
port:
 name: Indicates the host name
 port: Indicates the port
 mhost: Indicates the SIP 'maddr' parameter
(see RFC 3261)
 userphone: Indicates the SIP 'user=phone' header.contac
parameter (the tel URI). (See Note below.) t.url.userpho
ne
 looseroute: Indicates loose routing parameter
('lr') according to the Record-Route set (see
Note below)
 user: Indicates the user part of the URI (string) header.contac
t.url.user=='
401'
 transporttype: header.contac
 0: UDP t.url.transpo
 1: TCP rttype == '0'
 2: TLS
 3: SCTP
 param: Indicates a SIP parameter for the URI header.contac
(can add, for example) t.url.param.s
ubject
Notes:
 For type, host, mhost, userphone, looseroute,
user, and transporttype, the 'Action Type' field
must be set to Modify.
 For userphone and looseroute, configure the
rule with the 'Action Value' field set to '0' (to
remove) or '1' (to add).
Content-Disposition Header itself header.content-disposition


Example
Type header.content-
disposition.type
Handling header.content-
disposition.handling
Content-Length Header itself header.content-length
Content-Type Header itself header.content-type
Type header.content-type.type
Param header.content-type.param
Boundary header.content-type.boundary
Cseq Header itself header.cseq
Number header.cseq.num header.cseq.n
um=='1'
Type header.cseq.type
Date Header itself header.date
Diversion Header itself header.diversion
Name header.diversion.name
Parameter header.diversion.param
Privacy - 1 (full) / header.diversion.privacy header.divers
2 (off) ion.privacy==
'1'
Reason (enum) header.diversion.reason
Screen – yes / no header.diversion.screen
URL (see URL for header.diversion.url
Contact header)
Event Header itself header.event
Event Key header.event.eventkey
ID header.event.eventkey.id
Event package
header.event.eventkey.eventpac
kage
Parameter header.event.param header.event.
param.itsp-
abc
Expires Header itself header.expires
Expiry time header.expires.time
From Header itself header.from
Name header.from.name
Remove header.from.quotecontrol
quotation marks
The 'Action Value' field must be set to '0'.


Example
surrounding
display name
Parameter header.from.param header.from.p
aram.p1
Tag header.from.tag
URL (see URL for header.from.url header.from.u
Contact header) rl.user !=
'654'
History-Info Header itself header.history-info
Join Header itself header.join
Max-Forwards Header itself header.max-forwards
Value header.max-forwards.val
Min-Se and Min- Header itself header.min-se
Expires
header.min-expires
Parameter header.min-expires.param
Time header.min-expires.time
P-Asserted-Identity Header itself header.p-asserted-identity
Name (string) header.p-asserted-
identity.name
URL (see URL for header.p-asserted-identity.url header.p-
Contact header) asserted-
identity.url.
host
P-Associated-URI Header itself header.p-associated-uri
Name (string) header.p-associated-uri.name
Parameter header.p-associated-uri.param
URL (see URL for header.p-associated-uri.url
Contact header)
P-Called-Party-ID Header itself header.p-called-party-id
Name (string header.p-called-party-id.name
Parameter header.p-called-party-id.param header.p-
called-party-
id.param.p1
URL (see URL for header.p-called-party-id.url
Contact header)
P-Charging-Vector Header itself header.p-charging-vector
P-Charge-Info Header itself header.p-charge-info
P-Preferred-Identity Header itself header.p-preferred-identity
Name (string) header.p-preferred-


Example
identity.name
URL (see URL for header.p-preferred-
Contact header) identity.url
Priority Header itself header.priority
Privacy Header itself header.privacy
Privacy types header.privacy.privacy.<type> header.privac
where <type> can be: y.privacy.use
 none r
 header
 session
 user
 critical
 identity
 history
Proxy-Authenticate Header itself header.proxy-authenticate
Proxy-Authorization Header itself header.proxy-authorization
Proxy-Require Header itself header.proxy-require
SIP Capabilities header.proxy- header.proxy-
require.capabilities.<capabili require.capab
ty> ilities.early
where <capability> can be: medi
 earlymedia
 reliableresponse
 timer
 earlysession
 privacy
 replaces
 history
 unknown
 gruu
 resourcepriority
 targetdialog
 sdpanat
RAck Header itself header.rack
Reason Header itself header.reason
Reason types header.reason.reason.<type> header.reason
where <type> can be: .reason.reaso
 reason n
 cause
 text
MLPP: header.reason.mlpp
Type: Preemption
(0), MLPP (1)
cause
Record-Route Header itself header.record-route


Example
Referred-By Header itself header.referred-by

Parameter header.referred-by.param header.referr
ed-
by.param.p1
URL (see URL for header.referred-by.url header.referr
Contact header) ed-
by.url.host
Display Name header.referred-by.name header.referr
ed-by.name ==
‘user1’
Original Referred- header.referred-by.original header.referr
By header value ed-
by.original
==
‘sip:referrer
@ref.example;
cid=X’
Refer-To Header itself header.refer-to
The From tag of header.refer-to.fromtag header.refer-
the call on the to.fromtag ==
device being
replaced; it is part
‘some_tag_val
of the value of the ue’
Replaces URI
header, in the
Refer-To header
of an outgoing
request
The To tag of the header.refer-to.totag header.refer-
call on the device to.totag ==
being replaced; it
is part of the
‘some_tag_val
value of the ue’
Replaces URI
header, in the
Refer-To header
of an outgoing
request
Represents header.refer-to.addparams header.refer-
XRawDataInfoHe to.addparams
ader as a URI
header, when the
len> 0
header is in an
outgoing Refer
request.
Note: Applicable
only to the
gateway
application.
Display Name header.refer-to.name header.refer-
to.name ==


Example
‘user1’
Parameter header.refer-to.param header.refer-
to.param.p1
A Boolean value header.refer-to.isreplacesused header.refer-
indicating to.isreplaces
whether the
Refer-To header
used == 1
in the outgoing
request has URI
header Replaces
with call
identifiers for a
call on the device
The Call-ID of the header.refer-to.replacedcallid header.refer-
call on the device to.replacedCa
being replaced; it
is part of the
llID len> 0
value of the
Replaces URI
header, in the
Refer-To header
of an outgoing
request
URL (see URL for header.refer-to.url header.refer-
Contact header) to.url.host
Remote-Party-ID Header itself header.remote-party-id
Counter header.remote-party-id.counter
Name header.remote-party-id.name
Number Plan header.remote-party-
id.numberplan
where <numberplan> can have the following
value:
 1: ISDN
 3: Data
 4: Telex
 8: National
 9: Private
 15: Reserved
Number Type header.remote-party-
id.numbertype
Parameter header.remote-party-id.param
Privacy (see header.remote-party-id.privacy
Privacy header
for description)
Reason types header.remote-party-id.reason header.remote
where reason can equal the following enumeration -party-
value: id.reason=='1
 1: busy '
 2: immediate


Example
 3: no answer
Screen – Yes / header.remote-party-id.screen
No
Screen Indicator header.remote-party- header.remote
types id.screening -party-
where screening can equal the following id.screening
enumeration value: == 0
 -1: Screening not included
 0: user provided
 1: user passed
 2: user failed
 3: network provided
URL (see URL for header.remote-party-id.url
Contact header)
Replaces Header itself header.replaces

Request-URI Header itself header.request-uri
Method header.request-uri.method
Method Type header.request-uri.methodtype header.reques
The following enumerations are used to represent t-
the SIP methods: uri.methodtyp
 5: INVITE e == '5'
 7: BYE (i.e., SIP method is
 8: OPTIONS INVITE message)
 9: ACK
 10: CANCEL
 11: REGISTER
 12: INFO
 13: MESSAGE
 14: NOTIFY
 15: REFER
 16: SUBSCRIBE
 17: PRACK
 18: UPDATE
 19: PUBLISH
 21: SERVICE
URI header.request-uri.uri
URL (see URL for header.request-uri.url header.reques
Contact header) t-
uri.url.user
== '101'
Require Header itself header.require
SIP Capabilities header.require header.requir
(see SIP e.earlymedia
Capabilities for
Proxy-Require
header)
Resource-Priority Header itself header.resource-priority


Example
Namespace header.resource-
priority.namespace
RPriority header.resource-
priority.rpriority
Retry-After Header itself header.retry-after
Time header.retry-after.time
RSEQ Header itself header.rseq
Server or User-Agent Header itself header.user-agent
header.server
Service-Route Header itself header.service-route
Service route list header.service- header.servic
entry route.<entry>.serviceroute eroute.1.serv
iceroute
Session-Expires Header itself header.session-expires
Parameter header.session-expires.param header.sessio
n-
expires.param
.longtimer
Refresher header.session- Note: The Action
expires.refresher Value '1' sets it to
"UAC"; the value '2'
sets it to "UAS" (i.e.,
UA type doing the
refreshing)
Time header.session-expires.time
SIP ETag Header itself header.sip-etag
SIP If-Match Header itself header.sip-if-match
Subject Header itself header.subject
Subject header.subject.subject
Subscription State Header itself header.subscription-state
Supported Header itself header.supported
SIP Capabilities header.supported.capabilities. header.suppor
(see SIP <capability> ted.capabilit
Capabilities for
Proxy-Require
ies.path
header)
Target Dialog Header itself header.target-dialog

To Header itself header.to
Display name header.to.name
Parameter header.to.param header.to.par
am.artist


Example
tag header.to.tag
URL (see URL for header.to.url header.to.url
Contact header) .userphone
Unknown headers Header itself header.<unknown header name> header.color
Unsupported Header itself header.unsupported

SIP Capabilities header.unsupported.capabilitie header.unsupp
(see SIP s.<capability> orted.capabil
Capabilities for
Proxy-Require
ities.path
header)
User-To-User and X- Header itself header.user-to-user
UserToUser
header.x-usertouser
User-to-User header.user-to-user.user2user
Descriptor
header.x-usertouser.user2user
Protocol header.user-to-user.pd
Descriptor (PD)
header.x-usertouser.pd
Data Type header.user-to-user.datatype header.userto
(enum) user.datatype
header.x-usertouser.datatype
== '1'
Parameter header.user-to-user.param
header.x-usertouser.param
Via Header itself header.via
Alias header.via.alias
Branch header.via.branch
Host name header.via.host
Via parameter header.via.maddrip
'maddr'
Parameter header.via.param
Port header.via.port
Transport type header.via.transporttype header.via.0.
where transporttype can have the following value: transporttype
 0: UDP == '0'
 1: TCP
 2: TLS
 3: SCTP
Warning Header itself header.warning
WWW Authenticate Header itself header.www-authenticate
X-AC-Action Header itself header.x-ac-action
Header itself header.x-channel
X-Channel
TrunkID header.x-channel.trunkid


Example
BChannel header.x-channel.bchannel
BoardIP header.x-channel.boardip
HeaderType header.x-channel.headertype
X-RTP-Stat Header itself header.x-rtp-stat
3.2.2 Header Examples

The following table provides examples of syntax for indicating header fields.
Table 3-4: Header Field Syntax Examples
Header Description
header.to Defines the top level of the To header.
header.to.url.user Defines the user part in the header SIP URL.
header.from.url.host Defines the host part in the From header.
header.from.name Defines the display name in the From header.
header.newheader Defines a header newheader.
header.contact.param.newparam Defines the parameter newparam of a Contact header.
header.refer-to.url.host Defines the host part of the Refer-To header.
header.diversion.reason Defines the Reason parameter in the Diversion header.
header.supported.capabilities.pa Defines the supported headers capabilities path.

th
header.supported.capabilities.re Defines the supported headers capabilities replaces.
places
header.max-forwards.val Defines the value of the Max-Forwards header.
header.request-uri.methodtype Defines the method in the Request-URI.
header.remote-party- Defines the party type in the first Remote-Party-ID

id.0.partytype header.
header.contact.3 Defines the third Contact header.
header.via.2.url.user Defines the user part of the second Via header.
The following table provides examples of manipulation rules for headers.

Table 3-5: Header Field Manipulation Rules Examples
Message Type Condition Action Action Action

Subject Type Value

Message Type Condition Action Action Action

Subject Type Value
register. header.from. header.from.url.u Modify '2000'

request url.user == ser
'101' OR
header.from.
url.user ==
'1000'
register header.to.url.hos Modify 'audiocodes.c
t.name om'
invite header.from.name Modify header.contac
t.
url.user
invite. header.newheader Add 'information
request to client'
subscribe header.via.t header.to.param Add 'TCP'
ransporttype .transporttype
=='1'

3.3 Body
This section describes the syntax used for the SIP body in the Message Manipulations
table.
Syntax:
body.<body-name>
where:
<body-name> specified the body name as it arrives in the message. For example,
'application/sdp' (case-insensitive).
3.3.1 Body Examples

The following table provides examples of the syntax for indicating the SIP message body.
Table 3-6: Message Body Syntax Examples
Subject Description
body.application/x-nt-mcdn-frag- Adds or removes this 'unknown' body type.

hex
body.sdp Defines the SDP in the body.
The following table provides configuration examples of manipulation rules for the message
body.
Table 3-7: Message Body Manipulation Rules Examples
Message Condition Action Action Action

invite body.sdp body.application Add 'a=0981233\\b=12

!exists / rew
x-nt-mcdn-frag- wer\\note=newlin
hex echaracter'
invite. body.mwi Add 'Messages-
request Waiting:
yes\\Message-
Account:
sip:alice@vmail.
example.com\\Voi
ce-Message: 2/8
(0/2)'
any body.mwi.summary Modify '23'
.newmsgs
invite body.mwi.summary Modify '18'
.oldmsgs
invite body.mwi.summary Modify '12'
.newurgentmsgs

Message Condition Action Action Action

any body.mwi.summary Modify '67'

.oldurgentmsgs
invite body.mwi.pending Modify '8'
invite body.mwi.message Modify '2'
waiting
3.4 Parameters
This section describes the syntax used for the following SIP parameter types in the
Message Manipulations table:
 Message Parameters
 IP Group Parameters
 Call Parameters
3.4.1 Message Parameter Syntax

The following table describes the syntax used for SIP message parameters.
Table 3-8: Message Parameter Syntax
Subject Description
param.message.sdp.address Specifies the address in the SDP.

Note: The parameter can be used for read-
write operations in all message-syntax
based tables.
param.message.sdp.rtpmode Specifies the RTP mode in the SDP.
based tables.
param.message.sdp.originaddress Specifies the origin address in the SDP.
based tables.
param.message.sdp.port Specifies the port in the SDP.
based tables.
message.incoming.remote-port Specifies the remote (peer) port for the
source of the message, as a string.
Note:
 The parameter replaces the old
"param.message.address.src.port"
parameter.
 The parameter can only be used for
read-only operations in the message-
syntax based tables.
message.outgoing.remote-port Specifies the remote (peer) port for the
destination of the message, as a string.
Note:

Subject Description
 The parameter replaces the old
"param.message.address.dst.port"
parameter.
 The parameter can only be used for
read-only operations in the message-
message.incoming.local-port Specifies the local port for the source of the
message, as a string (port on which the
message is received).
Note: The parameter can only be used for
read-only operations in the message-syntax
based tables.
message.outgoing.local-port Specifies the local port for the destination of
the message, as a string (port from which
the message is sent).
Note:
 The parameter can be used for write
operations in the Call Setup Rules table
and read-only operations in the other
message-syntax based tables.
 It has a non-zero value for the relevant
message only after being modified by
Call Setup Rules for that message.
param.message.address.src.addre Specifies the IP address as a string for the
ss source of the message.
based tables.
param.message.address.dst.addre Specifies the IP address as a string for the
ss destination of the message.
based tables.
param.message.address.src.<tran Specifies the transport type as a string for
sporttype> the source of the message, where
<transporttype> can be one of the
following:
 UDP
 TCP
 TLS
based tables.
param.message.address.dst.<tra Specifies the transport type as a string for
nsporttype> the destination of the message, where
<transporttype> can be one of the following:
 UDP
 TCP
 TLS
based tables.
param.message.address.src.sipin Specifies the SIP Interface ID on which the
terface message is received (source).

Subject Description
read-only operations ('Action Value' and
'Condition' fields only) in the message-
syntax based tables..
param.message.address.dst.sipin Specifies the SIP Interface ID on which the
terface message is sent (destination).
read-only operations ('Action Value' and
'Condition' fields only) in the message-

3.4.2 IP Groups Table Parameter Syntax

The following table describes the syntax for representing parameters of the IP Groups
table. The parameters are read-only and can be used in the following tables and
corresponding fields:
 Message Manipulations Table: Condition and Action Value fields
 Message Conditions Table: Condition field
 Call Setup Rules Table: Search Key, Condition, and Action Value fields
Syntax
param.ipg.src|dst|<ID>|<Name>.host|id|is-alive|name|tags|type|
user|user-defined
Where:
 src specifies source IP Groups
 dst specifies destination IP Groups
 <ID> defines a specific IP Group by table row index
 <Name> defines a specific IP Group by name
Note:
• Use the 'src' and 'dst' keywords only for Message Condition rules that are
assigned to Classification rules in the Classification table. For all other
configurations, use the <ID> or <Name> keywords.
• When using the syntax, param.ipg.<Name>, the IP Group name is case-sensitive
and cannot contain spaces or dots (.).
The specific parameters -- fourth-level in the syntax above -- (host|id|is-

alive|name|tags|type|user|user-defined) are described in the following table:
Table 3-9: IP Group Parameter Syntax
IP Group Parameter Description

SIP Group Name
host Specifies the IP Group's host name.
Index
id Specifies the table row index (ID) of the given IP Group.
For example, the following checks if the index of the
source IP Group is 5:
param.ipg.src.id=='5'
Keep-Alive
is-alive Specifies the IP Group's connectivity status, using the
keywords 'true' or 'false' (online or offline, respectively).
For example, the following specifies a condition checking if
IP Group at index 5 is online:
param.ipg.5.is-alive=='true'
Note:
 User-type IP Groups are always online.

IP Group Parameter Description

 A Gateway-type IP Group is online when it is registered
with the device.
 A Server-type IP Group is online when its' associated
Proxy Set has at least one valid IP address and either
has keep-alive disabled or has keep-alive enabled and
keep-alive transactions with the proxy server(s) are
successful
Name
name Specifies the name of the given IP Group. For example,
the following condition checks if the name of the source IP
Group is "ITSP-Site1":
param.ipg.src.name=='ITSP-Site1'
Tags
tags.<Tag Name> Specifies the value of an IP Group's tag. By not specifying
a tag name, you can refer to all the tags and their values
associated with the IP Group. For example, the following
specifies the value of tag, "city" for source IP Groups:
param.ipg.src.tags.city
Type
type Specifies the IP Group's type (server, user, and gateway).
For example, the following condition checks if the source
IP Group is of type server:
param.ipg.src.type=='server'
Contact User
user Specifies the IP Group's user part of the From, To, and
Contact headers of SIP REGISTER messages, and the
user part of the Contact header of INVITE messages (in
other words, it specifies the value of the 'Contact User'
parameter for the IP Group). For example, the following
condition checks if the source IP Group has Contact
"jdoe":
param.ipg.src.user=='jdoe'
Message Manipulation User-Defined String 1 / 2
user-defined.0|1 Specifies the IP Group's user-defined string for
manipulation rules in the IP Group table, where:
 0 uses the string configured for the 'Message
Manipulation User-Defined String 1' parameter in the IP
Group table
 1 uses the string configured for the 'Message
Manipulation User-Defined String 2' parameter in the
IP Group table
For example, the following specifies the 'Message
Manipulation User-Defined String 2' parameter of the
source IP Group:
param.ipg.src.user-defined.1

3.4.3 Call Parameter Syntax

The following table describes the syntax used for Call parameters in the Message
Manipulations table.
Table 3-10: Call Parameter Syntax
Subject Description
param.call.<src/ds Specifies the source or destination username during run-time.

t>.user
param.call.<src/ds Enables manipulation of a SIP message depending on whether
t>.nat (=='true') or not (=='false') the source or destination of the
message is located behind NAT. The keywords can be used in
the 'Condition' or 'Action Value' parameters in the Message
Manipulations table. Message Manipulation rules using the
keywords are applicable only to message manipulation on the
outbound leg (i.e., the rules can only be assigned to the
'Outbound Message Manipulation Set' parameter in the IP Group
table.
3.4.4 Parameter Examples

The following table provides configuration examples using parameters.
Table 3-11: Parameter Examples

header.cont Modif param.messag Adds the ID number
act.url.ac- y e.address.sr of the SIP Interface
on which the
int c.sipinterfa message is received,
ce to the value of the
"ac-int" parameter in
the URL of the
Contact header.
param.message.sd header.IPSo Add param.ipg.sr If the address in the
p. urce c.id SDP is
10.132.10.101, the
address == SIP header
'10.132.10.101' "IPSource" is added
and set to the value of
the Index of the
source IP Group.
invite.re param.message.sd header.orig Add param.messag In 200 OK messages,
sponse.20 p. in e. if the RTP mode is
inactive, add a new
0 rtpmode=='inacti sdp.originad header, "origin"
ve' dress whose value is set to
the address in the
origin ('o=') SDP
param.message.sd header.from Add param.messag If the RTP mode is
p. .param.orig e.sdp.origin inactive, add a new
parameter, "origin" to
rtpmode== in address the From header. The
'inactive' value of the
parameter is set to
the 'o=' address in the


SDP.
subscribe header.to.p Add param.call.s In SUBSCRIBE
. aram.user rc.user messages, add the
parameter, "user" to
request the To header. The
value is set to the
source username.
invite.re header.requ Add param.ipg.sr For INVITE
sponse est- c.host responses, adds the
"myname" parameter
uri.url.par to the Request-URI.
am.myname The parameter value
is taken from the 'SIP
Group Name' field of
the source IP Group.
invite header.MyCu Add param.ipg.ds For INVITE
stomHeader t.user- messages, add a
header called
defined.0 "MyCustomHeader"
and whose value is
taken from the
IPGroup_MsgManUs
erDef1 field of the
destination IP Group.
any.reque header.sess Modif '1' Manipulates the
st ion- y 'refresher' parameter
to "UAC" in the
expires.ref Session-Expires
resher header (i.e., UAC is
doing the refreshing).
For example:
Session-Expires:
180;refresher=uac
invite param.message.sd param.messa Modif 'sendrecv' If the device
p.rtpmode=='send ge.sdp.rtpm y determines that the
destination of the
only' and ode INVITE message is
param.call.dst.n located behind NAT
at=='true' (param.call.dst.nat=='
true'), and the RTP
mode in the SDP of
the incoming INVITE
is 'sendonly'
(param.message.sdp.
rtpmode=='sendonly'),
it changes the RTP
mode to 'sendrecv' in
the SDP of the
outgoing INVITE.
invite param.ipg.src.ta header.City Add param.ipg.sr For INVITE
gs.city exists c.tags.city messages, if the
source IP Group has
the tag "city", add a
header called "City"
and set its value to
the value of the tag
"city".


invite param.ipg.src.id header.X-ID Add param.ipg.sr For INVITE
=='34' c.id messages, if the
source IP Group ID is
34, add a header
called "X-ID" and set
its value to the ID of
the source IP Group.
invite param.ipg.src.ty header.X- Add param.ipg.sr For INVITE
pe=='server' Type c.type messages, if the
source IP Group ID
type is Server, add a
header called "X-
Type" and set its
value to the Type
(i.e., "Server") of the
source IP Group.
3.4.4.1 Example for IP Group Keep-Alive

This example uses a Message Condition rule based on IP Group connectivity status
(param.ipg.<Name>.is-alive) to determine the destination of the call. The device routes the
calls between IP Groups "ITSP" and "MainServer". "MainServer" is always accessible to
the device, but it in turn routes calls to the "Cloud" IP Group, which may not always be
accessible(for whatever reason). If "Cloud" is inaccessible (offline), the device routes the
call to an alternative server ("AltServer").
1. Proxy Sets table configuration:
Index Name Proxy Keep-Alive

1 ITSP Disable
2 Cloud Using OPTIONS
3 Main-Server Disable
Alt-Server Disable
2. IP Groups table configuration:
Index Name Proxy Set

1 ITSP ITSP
2 Cloud Cloud
3 Main-Server Main-Server
Alt-Server Alt-Server
3. Message Conditions table configuration:
Index Name Condition

1 Cloud-Status param.ipg.Cloud.is-alive == 'true'
4. IP-to-IP Routing table configuration:
Index Source IP Alternative Message Destination

Group Route Options Condition IP Group

Index Source IP Alternative Message Destination

Group Route Options Condition IP Group
1 ITSP Route Row Cloud-Status Main-Server
2 ITSP Route Row Alt-Server

Reference Guide 4. Advanced Manipulation Features
4 Advanced Manipulation Features

This chapter describes advanced features that you can use for manipulating SIP
messages.
4.1 Wildcards for Header Removal

The device supports the use of the "*" wildcard character to remove headers. The "*"
character may only appear at the end of a string. For example, "X-*" is a valid wildcard
request, but "X-*ID" is not.
Below are examples of using the wildcard:
 header.p-* - removes all headers that have the prefix "p-"
 header.x-vendor* - removes all headers that start with "x-vendor"
Note: The wildcard does not remove the following headers:

• Request-Uri
• Via
• From
• To
• Callid
• Cseq
• Contact
4.2 Random Characters

The following syntax shows how to specify random letter characters in the range a to z in
Message Manipulation rules.
Syntax:
rand.string.<n>.a.z
where:
 <n> is the number of random letter characters you wish to specify in the range a to z.
The following syntax shows how to specify random letter and/or numeric characters in the
range 0 to z in the Message Manipulations table.
Syntax:
Rand.string.<n>.0.z
where:
 <n> is the number of random letter and/or numeric characters you wish to specify in
the range 0 to z.

The following syntax shows how to specify random numbers between n and m in the
Message Manipulations table.
Syntax
Rand.number.<n>.<m>
where:
 <n> specifies the start value of the range of the random numbers that you wish to
specify.
 <m> specifies the end value of the range of the random numbers that you wish to
specify.
The following table provides configuration examples for using random letters and numeric
characters in the Message Manipulations table.
Table 4-1: Examples using Random Letters and Numeric Characters
Message Type Action Subject Action Action Value

Type
invite.request header.myrandomStri Add Rand.string.56.A.Z

ng
invite.response header.NumberaAndCh Add Rand.string.12.0.z
ars
invite.response header.myrandomNmbe Add Rand.number.50.100
.4xx r
4.3 SDP Body Fields

You can configure message manipulation based on the SDP body fields for read and/or
write operations on the SDP. This can be done in the following tables and corresponding
fields:
 Message Manipulations Table: Condition, Action Subject, and Action Value fields.
 Message Conditions Table: Condition field.
 Call Setup Rules Table: Search Key, Condition, Action Subject, and Action Value
fields.
4.3.1 Source IP Address

You can use the source IP address in the SDP body for message manipulation. For
example, you can configure a manipulation rule to add a SIP Diversion header to incoming
INVITE messages if the SDP contains a specific IP address, or a prefix or suffix of this IP
address.
Syntax
 Specific IP address:
param.message.sdp.ip
For example:
param.message.sdp.ip=='10.33.37.78’

 IP address suffix:
param.message.sdp.ip suffix
For example:
param.message.sdp.ip suffix '10.10'
 IP address prefix:
param.message.sdp.ip prefix
For example:
param.message.sdp.ip prefix '10.132'
4.3.2 RTP Mode

You can use the RTP mode in the SDP body for message manipulation.
Syntax
param.message.sdp.rtpmode
Possible values include the following:
 sendonly
 sendrecv
 inactive
For example:
param.message.sdp.rtpmode=='sendrecv'
4.3.3 Origin Username

You can use the username in the "o=" field of the SDP body for message manipulation.
Syntax
param.message.sdp.originusername
4.3.4 Origin IP Address

You can use the IP address in the "o=" field of the SDP body for message manipulation.
Syntax
param.message.sdp.originaddress
Possible values include any IP address.
4.3.5 Port
You can use the first audio active media port number (i.e., port number greater than 0) in
the "m=" field of the SDP body for message manipulation.
Syntax
sdp.port

4.3.6 IP Address
You can use the IP address of the first active media (port greater than 0) for message
manipulation. The IP address is taken from the media "c=" field (the "c=" field below the
"m=" field) of the SDP body. Note that if the "m=" field doesn't contain a "c=" field, the IP
address is taken from the global "c=" field (the "c=" field at the top of the SDP).
Syntax
sdp.address
4.3.7 SDP Examples

Below are manipulation examples using the SDP body:
Table 4-2: Examples using SDP Body Fields
Action
Message Type Condition Action Subject Action Value Description
Type
invite.reques header.custom- Add param.message.sdp. Copies the port and IP
t rtp-address ip address in the SDP
body to a customized
invite.reques header.custom- Add param.message.sdp.
SIP header (e.g.,
t rtp-port port
Custom-RTP-
Address/Port) in the
outgoing INVITE
message.
reinvite. param.message. param.message. Modify 'sendonly' Changes the RTP mode
request sdp.ip == sdp.rtpmode to sendonly if the SDP
'0.0.0.0' "c=" field's address is
0.0.0.0.
param.message. Modify param.message.sdp. Changes the SDP "c="
sdp.ip originaddress field to the same
address as the "o="
field.
invite param.message. var.call.src.0 Modify '1' Uses the RTP mode as
sdp.rtpmode==' a condition.
sendrecv'
invite. var.call.dst.0 param.message. Modify 'sendonly'
response.200 =='1' sdp.rtpmode
invite param.message. header.diversi Add <sip:12345@p4.isp. Adds a Diversion header
sdp.ip=='10.33 on com>;reason=no- ("Diversion:
.37.78' answer <sip:12345@p4.isp.com
>;reason=no-answer") to
invite param.message. header.diversi Add <sip:12345@p4.isp.
sdp.ip prefix on com>;reason=no- incoming INVITE
'10.33' answer messages if the SDP
contains the IP address
10.33.37.78 or the prefix
of this IP address
(10.33). The IP address
is contained in the "c="
field of the SDP (e.g.,
"c=IN IP4 10.33.37.75").
invite.reques body.sdp Header.SDP- Add param.message.sdp. Adds a customized
t exists Origin- originusername header “SDP-Origin-

Action
Message Type Condition Action Subject Action Value Description
Type
UserName UserName”, where the
username is obtained
from the “o=” field in the
SDP body, if the INVITE
message contains an
SDP body.
invite.reques body.sdp param.message. Modify 'myname' Changes the username
t exists sdp.originuser in the “o=” field in the
name SDP body to "myname",
if the INVITE message
contains an SDP body:

4.4 Regular Expressions (Regex)

You can configure SIP header manipulation rules using regular expressions (regex). Regex
is a special text string pattern matching engine which is used to define the condition that
must exist in order to use a specific manipulation rule. If the SIP header matches the regex
pattern, then the "action" of the manipulation rule is applied to the SIP message. Executing
a regex pattern also creates sub-expressions. The sub-expressions are referenced using
the $n syntax, where n is a digit in the range of 1 to 13 (e.g., $3). Expressions enclosed by
parenthesis (…) are stored in the variables $1, $2 … $n.
Note that spaces within a regular expression must be enclosed by parenthesis, as shown
in the first example below:
body.sdp regex (AVP 8)
body.sdp regex avp
This feature provides the following main benefits:
 The device does not need to know the SIP header name or structure.
 The sub-expressions can be used in the manipulation action. All that is required is to
set the action (for example, add, modify, etc.) and then reference the sub-expression
you want to use as the value.
Regex is supported in the following tables and corresponding fields:
Table 4-3: Configuration Tables and Relevant Fields
Table Fields
Message Manipulations Table  Condition

 Action Value
Pre-Parsing Manipulation Table  Pattern
 Replace-With
 Action Value
Syntax:
<$n>
where: <$n> is used to reference a resulting sub-expression after executing a regex in a
condition; where n is an integer referencing the sub-expression.
Note:
 The regex pattern ".*" for multi-line match is supported.
 To concatenate, use the + operator, e.g., $1 + ‘some text’ + $3
 Rand function can be used in the 'Replace-With' field (as a sub-value), for example,
$1 + rand.number.1.10.
 Double backslash \\ can be used to state a new line (in 'Replace-With' field), for
example, to replace a pattern with multi-line text.

4.4.1 Regex Basic Examples

The following table provides configuration examples for using regular expressions in the
Message Manipulations table.
Table 4-4: Regex Examples for Message Manipulation, Message Conditions and CSR
Message Type Condition Action Subject Action Action Value

Type
invite.reque header.diversion. header. Modi $1+$3

st 0 regex diversion.0 fy
(<.*)(;urlparam=
[a-z]*)(.*>)
invite.reque header.diversion. header. Add $1 +
st 0 regex diversion.0 ';mynewparam=
(<.*)(;urlparam= good' + $3
[a-z]*)(.*>)
invite.respo header.via regex header. Add $3
nse.100 (SIP/2.0/UDP)(.*) thebranch
;
branch=(.*)
subscribe header.to regex header.to Modi $1+$3+'8@'+$4
(.*)(1001)(.*)@(. fy
*)>
Table 4-5: Regex Examples for Pre-Parsing Manipulation Rules
Message Type Pattern Replace-With Explanation
invite.reque From: ‘From: Replaces user part (if

st *<sip:([^@]+)(@\S <sip:’ + exists) in From header URL
*) ‘1000’ + $2 with 1000, for INVITE only.
invite.reque (From: $1 + ‘1000’ Same as above.
st *<sip:)([^@]+)(@\ + $3
S*)
any.response Refer-To: ‘Refer-To: Encloses Refer-To header
*(sip:\S*) <’ + $1 + value with angled brackets
‘>’ <…>, for responses only.
From: ‘From: “’ + Adds quotes to the From
*([^"\r\n]*) $1 + ‘” ’ + header's display name (if
(<sip:\S*) $2 exists).
cancel.reque (CANCEL $1+$6+$3+$4 Replaces the user part of
st sip:)(\d*)(@)(.*) +$5+$6+$7+$ the Request-Uri header
(To: 8 URL with user part of the
<sip:)(\d*)(@)(.* To header URL, for SIP
) CANCEL messages only.

4.4.2 Regex Detailed Examples

Below are detailed examples of using regex for SIP message manipulation:
 Example 1 - Number range matching and manipulation:
• Required manipulation: When the source number has prefix 30 to 40 and a digit
(e.g., 3122), it needs to be changed to 2312. The last digit of the original phone
number is removed (i.e., 2, leaving the number as 312) and the result is prefixed
with 2.
♦ Old header:
To: <sip:3122@10.132.10.100;user=phone
♦ New header:
To: sip:2312@company244.com
• Manipulation rule:
Action Action Action
Index Condition
Subject Type Value
1 header.to regex header.to Modify $1+'2'+$2
(<.*)([3-4][0- +$3+'@'+$
9])(.*)(\d)@(.*>) 5
• Explanation: Dialing 3122 creates the following sub-expressions:

♦ 1: <sip:
♦ 2: 31
♦ 3: 2
♦ 4: 2
♦ 5: 10.132.10.100;user=phone>
 Example 2 - Manipulation based on source and destination number:
• Required manipulation: If the destination number has prefix 6, 7, or 8 (e.g.,
85262146) and the source number has prefix 2001, then remove the first five
digits (e.g., 85262) from the destination number and add 3 as the prefix (e.g.,
3146).
♦ Old header:
From:
<sip:20011234@10.132.10.100;user=phone>;tag=XINPYDPROEOREGE
IHUHF
To: sip:85262146@10.132.10.100;user=phone
♦ New header:
From: <sip:20011234@company246.com;user=phone>;tag=1c13519
To: sip:3146@company244.com
• Manipulation rules:
Index Condition
Subject Type Value
1 header.to regex var.call.dst. Modify '3'+$2
<sip:([6-8][1- 0
9]{4})(.*)@(.*>)
2 header.from regex 2001 header.to.url Modify var.call
.user .dst.0

• Explanation: These rules are slightly complex as both the To and From headers
are inspected. This rule executes
♦ If the dialed number is prefixed with a number 6-8 (inclusive)
♦ If the calling party number is prefixed with 2001
If these conditions exist, then:
♦ Remove the first five digits of the dialled string.
♦ Prefix the result with the digit 3.
The first rule matches a dialled number that occurs in the To header (e.g.,
85262146). If a match occurs, it uses a variable to store the remaining three digits
and adds the digit 3 as the prefix. The second rule inspects the From header. If it
contains the string 2001, then the user part of the To header is modified with the
prepared variable. For example, the user (at 20011234) dials 85262146, which
generates the following substring from the first rule:
♦ $1 85262
♦ $2 146
♦ $3 10.132.10.100;user=phone>
Note: This configuration isolates the last three digits in the dialed number and
prefixes them with '3'. The variable now is set to '3146'. The second rule does not use
sub-expressions. It simply searches for 2001 in the From header and if there is a
match the user part of the To header is manipulated using the standard manipulation
syntax.
 Example 3 - Manipulation of SDP:

• Manipulation required: To change the packet period in the SDP.
• Manipulation rule:
Index Condition
Subject Type Value
1 body.sdp regex body.sdp Modify $1+'a=ptim
(.*)(a=ptime:20)(.*) e:10'+$3
• Explanation: This rule matches everything up to the a=ptime in the SDP body as
$1, and stores as $3 everything after the 0 in the ptime attribute line. This is used
as the closing \r\n in the SDP body. The modify action then refers to the sub-
expressions $1 and $3, but does not make use of $2, instead replacing it with
a=ptime:10.
 Example 4 – Manipulation of SDP:

Index Condition
Subject Type Value
1 body.sdp regex body.sdp Modify $1+$2+$3
(.*)(m=audio)(.*)(m=au
dio)(.*)
• Explanation: The dollar "$" values represent each condition that is enclosed by
parentheses:
♦ (.*) = $1
♦ (m=audio) = $2
♦ (.*) = $3
♦ (m=audio) = $4

♦ (.*) = $5
The 'Value' field means keep $1, $2, and $3 (and remove $4 and $5). The lines in
the SDP represented by each $ is shown below:
Original SDP (color-coded to denote $ values):
v=0
o=mv 1980150132 244692855 IN IP6
2600:1f16:c96:aa00:951f:f946:4ebf:ef8c
s=-
c=IN IP6 2600:1f16:c96:aa00:951f:f946:4ebf:ef8c
t=0 0
a=group:ANAT 1 2
m=audio 11090 RTP/AVP 0 8 101
c=IN IP6 ::
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=mid:1
c=IN IP4 0.0.0.0
a=fmtp:101 0-15
a=mid:2
SDP after Manipulation:
v=0
o=mv 1980150132 244692855 IN IP6
2600:1f16:c96:aa00:951f:f946:4ebf:ef8c
s=-
c=IN IP6 2600:1f16:c96:aa00:951f:f946:4ebf:ef8c
t=0 0
a=group:ANAT 1 2
c=IN IP6 ::
a=fmtp:101 0-15
a=mid:1

4.5 Variables for Copying Data between Messages

You can use variables in SIP message manipulation rules to copy specific information
(data) from one message to another. Information from one message is copied to a variable
and then information from that variable is copied to any subsequent message. The device
can store information in local (call) or global variables.
To store data in a variable, add the name of the variable in the 'Action Subject' field and set
the 'Action Type' to Modify. To retrieve data from a variable, add it in the 'Action Value'
field, or use it as a condition value in the 'Condition' field.
Note:
• All variable types described in this section support up to 10 variables per entity.
For each variable type per entity, the 10 variables can together have up to 690
characters.
• Variable names can include alphanumeric and hyphens (-).
• Variable values can be any string.
4.5.1 Call Variable

The call variable stores information on a per call basis and changes when a new call is
made (i.e., stored only throughout the lifetime of a specific call). Local variables can be
used per call: src (source) or dst (destination) references which can be stored in the call
leg. Note that information stored in the call variables is only valid for the duration of the call.
Call variables use the following syntax:
var.call.src|dst.<Variable Name>
where:
 src denotes the call source variable.
 dst denotes the call destination variable
 <Variable Name> specifies the name of the variable
For example:
1. Store a value in a call variable: Stores the subject URI parameter from the To header:
MessageManipulations 0 = 0, Invite.Request, , var.call.dst.My-
Call, 2, header.to.url.param.subject, 0;
2. Use the stored value: Allocates a Subject header for the 200 OK response for the
same call and assigns it the stored value:
MessageManipulations 0 = 0, Invite.response.200, ,
header.subject, 0, var.call.dst.My-Call, 0;
The following table provides additional configuration examples of using call variables in
Table 4-6: Examples of Call Variables
Message Condition Action Action Action Value

Type Subject Type
invite param.message.sdp. var.call.src.My Modify '1'

rtpmode=='sendrecv -Call
'


Type Subject Type
invite var.call.dst.My- param.message.s Modify 'sendonly

.respons Call=='1' dp.rtpmode '
e.200
4.5.2 Global Variable

Global variables are similar to call variables, but they do not change as new calls are made
(i.e., their lifetime is not restricted to the duration of a call).
Global variables use the following syntax:
var.global.<Variable Name>
where, <Variable Name> specifies the name of the global variable.
For example:
 Store a value in a global variable: Stores the Priority header of the INVITE with
‘company’ in the host part of the From header:
MessageManipulations 0 = 0, Invite.Request,
header.from.url.host == ‘company’, var.global.My-Global, 2,
header.priority, 0;
 Use the stored value: Assigns the same priority as the INVITE request to SUBSCRIBE
requests arriving with 'company' in the host part of the From header:
MessageManipulations 0 = 0, Subscribe.request,
header.from.url.host == ‘company’, header.priority, 0,
var.global.My-Global, 0;
The following table provides additional configuration examples of using variables in

Table 4-7: Example of Global Variables

Type Subject Type
invite var.global.My- Modify 'Custom

Global UA'

4.5.3 Session Variable

Session variables can be preserved in any ongoing leg in the session, for example, in an
call session with forking calls, in a call which had a locally handled blind transfer, etc. The
value of the variable remains the same in all existing legs and in new legs of the session
context.
Session variables use the following syntax:
var.session.<Variable Name>
where, <Variable Name> specifies the name of the variable.
For example (using SIPRec):
For an IP-to-Tel call, the INVITE message of the recorded IP call contains the header, X-
credit-card (e.g., X-credit-card: 123456789). When the device sends an INVITE to
the SIPRec server (SRS), it is required to include the content (value) of this header (e.g.,
123456789). To do this, you need to configure two Message Manipulation rules:
1. For the recorded call: This rule stores the content of the X-credit-card header in the
variable, var.session.SIPRec.
2. For the SRS leg: This rule adds a new header, X-credit-card with the contents of the
variable (var.session.SIPRec) to the INVITE sent to the SRS.
Table 4-8: Example of Session Variables

invite. header.X- var.session. Modify header. For the

request credit-card SIPRec X- recorded call
exists credit-
card
invite. var.session.SIP header.X- Add var.ses For the SRS
request Rec != '' credit-card sion.SI leg
PRec
4.5.4 Registered User Variable

The user variable stores information for each registered far-end user and maintains it as
long as the user is registered. The user variables can be accessed from all SIP dialogs
which the user is involved in.
The variable uses the following syntax:
var.user|peer-user.<Variable Name>
where:
 user denotes the user of the current leg
 peer-user denotes the user of the peer leg
 <Variable Name> specifies the name of the variable
Usages:
 Inbound and outbound message manipulation
 Call Setup Rules (only var.user)
 IP-to-IP Routing table:
• 'Message Condition' field (only var.user and read-only)
• 'Internal Action' field (only var.user and read-only)

Note:
• The user variable cannot be used in Outbound Manipulation for operations that
are terminated before Classification, Manipulation and Routing (responses for
REGISTER termination, Reply internal action, CMR failure).
• When a registered user expires and the device generates and sends an un-
REGISTER to the proxy, you can configure outbound manipulation for the Server-
type IP Group (i.e., proxy) using the param.ipg.src|dst.<x> syntax. For this stage,
you can also use the var.peer-user variable.
The following table provides a configuration example of user variables in Message

Manipulation rules.
 Index 1: When the REGISTER response (200 OK) contains the Proprietary-Header
header, the device stores it in a user variable ("myheader").
 Index 2: This variable ("myheader") is later used to add a Proprietary-Header header
to subsequent 200 OK responses for REGISTER messages (that do not contain the
header) sent to that user, without requiring it to be re-sent by the registrar.
Table 4-9: Example of User Variables
Index Message Type Condition Action Action Action Value

Subject Type
1 register.resp header.proprietary var.user.myhea Modify header.p

onse.200 -header exists der roprieta
ry-
header
2 register.resp header.proprietary header.proprie Add var.user
onse.200 -header !exists tary-header .myheade
r

4.6 ISUP Body Manipulation
Note: For certain ISUP call actions, see also Section 4.7 on page 62.
ISUP
SIP
Message Parameter Field Syntax
Method
Type
INVITE IAM Called party Number Plan (see Section body.isup.iam.call

number A.5.4) ed_num.plan
Number Type (see body.isup.iam.call
Section A.5.5) ed_num.type
Address signal (string of body.isup.iam.call
up to 50 characters) ed_num.digits
Internal Network Number body.isup.iam.call
indicator (INN) ed_num.inn
 0: routing to internal
number allowed
 1: (default) routing to
internal number not
allowed
Calling party Number Plan (see Section body.isup.iam.call
number A.5.4) ing_num.plan
Number Type (see body.isup.iam.call
Section A.5.5) ing_num.type
Address presentation body.isup.iam.call
restricted indicator (see ing_num.presentati
Section A.5.15) on
Screening indicator (see body.isup.iam.call
Section A.5.11) ing_num.screening
Address signal (string of body.isup.iam.call
up to 50 characters) ing_num.digits
Original Called Number Plan (see Section body.isup.iam.
Number A.5.4) original_called_nu
m.plan
Number Type (see body.isup.iam.
Section A.5.5) original_called_nu
m.type
Address presentation body.isup.iam.orig
restricted indicator (see inal_called_num.pr
Section A.5.15) esentation
Address signal (string of body.isup.iam.orig
up to 50 characters) inal_called_num.di

ISUP
SIP
Method
Type
gits
Generic Number Number qualifier indicator body.isup.iam.gene
(see Q.763.3.26) ric_num.qualifier
Number Plan (see Section body.isup.iam.gene
A.5.4) ric_num.plan
Number Type (see body.isup.iam.gene
Section A.5.5) ric_num.type
Address presentation body.isup.iam.gene
restricted indicator (see ric_num.presentati
Section A.5.15) on
Screening indicator (see body.isup.iam.gene
Section A.5.11) ric_num.screening
Address signal (string of body.isup.iam.gene
up to 50 characters) ric_num.digits
Location Number Number Plan (see Section body.isup.iam.loca
A.5.4) tion_num.plan
Number Type (see body.isup.iam.loca
Section A.5.5) tion_num.type
Address presentation body.isup.iam.loca
restricted indicator (see tion_num.presentat
Section A.5.15) ion
Screening indicator (see body.isup.iam.loca
Section A.5.11) tion_num.screening
Address signal (string of body.isup.iam.loca
up to 50 characters) tion_num.digits
Internal Network Number body.isup.iam.loca
indicator (INN) tion_num.inn
 0: routing to internal
number allowed
 1: (default) routing to
internal number not
allowed
Redirecting Number Plan (see Section body.isup.iam.redi
number A.5.4) recting_num.plan
Number Type (see body.isup.iam.redi
Section A.5.5) recting_num.type
Address presentation body.isup.iam.redi
restricted (see Section recting_num.presen
A.5.15) tation
Address signal (string of body.isup.iam.redi
up to 50 characters) recting_num.digits
Redirection Redirecting reason (see body.isup.iam.redi

ISUP
SIP
Method
Type
information Section A.5.7) rect.info.reason
Original Redirect reason - body.isup.iam.redi
values 1, 2, and 3 (see rect_info.orig_rea
Section A.5.23) son
Redirection Counter body.isup.iam.redi
Number of redirections the rect_info.counter
call has undergone
expressed as a number
from 1 to 5.
Redirecting Indicator (see body.isup.iam.redi
Q.763.3.45) rect_info.indicato
r
Forward call National/international call body.isup.iam.fci.
indicator (see indicator InterationalInd
Q.763 3.23)
End-to-end method body.isup.iam.fci.
indicator End2EndMethod
Interworking indicator body.isup.iam.fci.
Interworking
End-to-end information body.isup.iam.fci.
indicator End2EndInformation
ISDN user part indicator body.isup.iam.fci.
IsdnUserPartIndica
tor
ISDN user part preference body.isup.iam.fci.
indicator IsdnUserPartPrefer
ence
ISDN access indicator body.isup.iam.fci.
IsdnAccess
SCCP method indicator body.isup.iam.fci.
SCCP
Transmission body.isup.iam.tmr
medium
requirement (see
Section A.5.16)
Calling party's body.isup.iam.cpc
category (see
Section A.5.19)
Hop Counter (1 to body.isup.iam.hop_
31) counter
Access transport Information transfer rate body.isup.iam.acce
Low layer ss_transport.trans
compatibility fer_rate
information
element (see User information layer 1 body.isup.iam.acce
4.5.19 of protocol ss_transport.

ISUP
SIP
Method
Type
Recommendation layer1_protocol
Q.931)
User rate body.isup.iam.acce
ss_transport.user_
rate
User service Information transfer body.isup.iam.user
information capability _service.
(see 3.57 of transfer_capabilit
Q.763) y
Information transfer rate body.isup.iam.user
_service.transfer_
rate
User information Layer 1 body.isup.iam.user
protocol (usually used for _service.user_info
analogue modem calls)
_l1
Layer ident (usually used body.isup.iam.user
for analogue modem _service.layer_id
calls)
First 18x ACM Backward call Charge indicator (see body.isup.acm.bci.
indicator Section A.5.17) charge
Called party's status body.isup.acm.bci.
indicator (see Section status
A.5.18)
Called party's category body.isup.acm.bci.
indicator (see Section cpc
A.5.19)
End-to-end method body.isup.acm.bci.

indicator (see Q.763.3.5) End2EndMethod
Interworking indicator (see body.isup.acm.bci.

Q.763.3.5) Interworking
End-to-end information body.isup.acm.bci.
indicator (see Q.763.3.5) End2EndInformation
ISDN user part indicator body.isup.acm.bci.
(see Q.763.3.5) IsdnUserPartIndica
tor
Holding indicator body.isup.acm.bci.
(see Q.763.3.5) HoldingIndicator
ISDN access indicator body.isup.acm.bci.
(see Q.763.3.5) IsdnAccess
Echo control device body.isup.acm.bci.
indicator (see Q.763.3.5) Echo
SCCP method indicator body.isup.acm.bci.
(see Q.763.3.5)

ISUP
SIP
Method
Type
SCCP
Optional Backward In-band information Body.isup.acm.obci
Call indicators indicator (see Q.763.3.37) .Inband
Call diversion may occur body.isup.acm.obci
indicator (see Q.763.3.37) .diversion
Simple segmentation body.isup.acm.obci
indicator (see Q.763.3.37) .segmentation
MLPP user indicator (see body.isup.acm.obci
Q.763.3.37) .MLPP
Not First CPG Event Information, body.isup.cpg.even
18x can be used only t_info
in condition, (see
Section A.5.20)
Backward Call Charge indicator (see body.isup.cpg.bci.
Indicator (to send it Section A.5.17) charge
cpc, must be set
manually by Called party's status body.isup.cpg.bci.
message indicator (see Section status
manipulation) A.5.18)
Called party's category body.isup.cpg.bci.
indicator (see Section cpc
A.5.19)
End-to-end method body.isup.cpg.bci.
indicator (see Q.763.3.5) End2EndMethod
Interworking indicator (see body.isup.cpg.bci.
Q.763.3.5) Interworking
End-to-end information body.isup.cpg.bci.
indicator (see Q.763.3.5) End2EndInformation
ISDN user part indicator body.isup.cpg.bci.
(see Q.763.3.5) IsdnUserPartIndica
tor
Holding indicator (see body.isup.cpg.bci.
Q.763.3.5) HoldingIndicator
ISDN access indicator body.isup.cpg.bci.
(see Q.763.3.5) IsdnAccess
Echo control device body.isup.cpg.bci.
indicator (see Q.763.3.5) Echo
SCCP method indicator body.isup.cpg.bci.
(see Q.763.3.5) SCCP
Optional Backward In-band information body.isup.cpg.obci
Call Indicators indicator (see Q.763.3.37) .inband
(sent only if at
least one of the Call diversion may occur body.isup.cpg.obci
fields is explicitly indicator (see Q.763.3.37) .diversion

ISUP
SIP
Method
Type
set by a message Simple segmentation body.isup.cpg.obci
manipulation rule) indicator (see Q.763.3.37) .segmentation
MLPP user indicator (see body.isup.cpg.obci
Q.763.3.37) .mlpp
200 OK on ANM Connected number Number Plan (see Section body.isup.iam.conn
INVITE A.5.4) ected_num.plan
Number Type (see body.isup.iam.conn
Section A.5.5) ected_num.type
Address presentation body.isup.iam.conn
restricted (see Section ected_num.presenta
A.5.15) tion
Address signal (string of body.isup.iam.conn
up to 50 characters) ected_num.digits
200 OK on CON (for Backward call Charge indicator (see body.isup.con.bci.
INVITE Spirou indicator Section A.5.17) charge
variant
only, sent Called party's status body.isup.con.bci.
if SIP 18x indicator (see Section status
wasn’t A.5.18)
sent
before 200 Called party's category body.isup.con.bci.
reply) indicator (see Section cpc
A.5.19)
End-to-end method body.isup.con.bci.
indicator (see Q.763.3.5) end2endmethod
Interworking indicator (see body.isup.con.bci.
Q.763.3.5) interworking
End-to-end information body.isup.con.bci.
indicator (see Q.763.3.5) end2endinformation
ISDN user part indicator body.isup.con.bci.
(see Q.763.3.5) isdnuserpartindica
tor
Holding indicator body.isup.con.bci.
(see Q.763.3.5) holdingindicator
ISDN access indicator body.isup.con.bci.
(see Q.763.3.5) isdnaccess
Echo control device body.isup.con.bci.
indicator (see Q.763.3.5) echo
SCCP method indicator body.isup.con.bci.
(see Q.763.3.5) sccp
INFO FAC Transfer number Number Plan (see Section body.isup.fac.conn
A.5.4) ected_num.plan
Number Type (see body.isup.fac.conn

ISUP
SIP
Method
Type
Section A.5.5) ected_num.type
Address presentation body.isup.fac.conn
restricted (see Section ected_num.presenta
A.5.15) tion
Address signal (string of body.isup.fac.conn
up to 50 characters) ected_num.digits
BYE, 4xx REL Cause value (see body.isup.rel.caus
Section A.5.21) e
Cause location body.isup.rel.loca
(see Section tion
A.5.22)
4.6.1 Attaching ISUP Body

The syntax of message manipulation for attaching ISUP body to a SIP message is as
follows:
 Action Subject: body.isup.xxx
Where xxx can be one of the following:
• IAM
• ACM
• CPG
• ANM
• SUS
• RES
• REL
• RLC
• FAC
 Action Type: Add
Below is an example of a message manipulate rule that adds the ISUP Release message
to the body of SIP CANCEL request:
MessageManipulations 8 = "Cancel add ISUP", 1, "cancel.request",
"body.isup.rel !exists", "body.isup.rel", 0, "", 0;
4.6.2 Removing Elements from ISUP Body

All optional "number" elements (connected number, transferred number, etc.) can be
removed by setting the address signal to an empty string (see the example in Section
4.6.3.2).

4.6.3 ISUP Examples
4.6.3.1 ISUP Deny Message Condition Rule

The example describes how to deny INVITE messages received from IP address
10.33.7.20 if the message contains ISUP data whose Initial Address Message (IAM)
section includes a Called Party Number that begins with "200".
1. Configure a Message Condition rule in the Message Conditions table with the
condition, body.isup.iam.called_party_number isprefix '200':
2. Assign the Message Condition rule to the Classification rule associated with the
source of the INVITE:

4.6.3.2 ISUP Message Manipulation Rules

The example manipulates the SIP message if the incoming INVITE message includes
ISUP data that contains an IAM with Calling Party Number whose Presentation is set to
restricted and:
 If P-Asserted-Identity header is absent: Add P-Asserted-Identity header with value
"tel:+<IAM Calling Party Number>"
 If From header is absent: Add the From header with value to "Anonymous"
<sip:anonymous@anonymous.invalid>;tag=9802748
 If Privacy header is absent: Add Privacy header with value "id"
INVITE sip:+14085551212@gw.pstn.net SIP/2.0
Via: SIP/2.0/TCP useragent.audiocode.com;branch=z9hG4bK-124
To: <sip:+14085551212@audiocodes.com>
From: "Anonymous" <sip:anonymous@anonymous.invalid>;tag=9802748
Call-ID: 245780247857024504
CSeq: 2 INVITE
Max-Forwards: 68
P-Asserted-Identity: tel:+14085264000
Privacy: id
Table 4-10: ISUP Body Manipulation Rules Examples
Message Condition Action Action Action Row Rule

invite body.isup header.p- Add 'tel:+' + Use Current

exists AND asserted- body.isup.ia Condition
body.isup.i identity m.calling_pa
am.calling_ rty_number.d
party_numbe igits
r.presentat
ion ==
'restricted
' AND
header.p-
asserted-
identity
!exists
invite body.isup header.fr Add "'"Anonymous Use Current
exists AND om " Condition
body.isup.i <sip:anonymo
am.calling_ us@anonymous
party_numbe .invalid>;ta
r.presentat g=9802748'"
ion ==
'restricted
' AND
header.from
!exists
invite body.isup header.pr Add 'id' Use Current
exists AND ivacy Condition
body.isup.i
am.calling_

Message Condition Action Action Action Row Rule

party_numbe
r.presentat
ion ==
'restricted
' AND
header.Priv
acy !exists
4.7 Special Actions using X-AC-Action SIP Header

You can use AudioCodes proprietary SIP header, X-AC-Action in message manipulation
rules to trigger certain actions. These actions can be used to support, for example,
interworking of SIP-I and SIP endpoints for the ISUP SPIROU variant.
The following actions are supported by the X-AC-Action header:
 To disconnect a call (optionally, after a user-defined time):
X-AC-Action: 'disconnect'
X-AC-Action: 'disconnect;delay=<time in ms>'
 To resume a previously suspended call:
X-AC-Action: 'abort-disconnect'
 To automatically reply to a message without forwarding the response to the
other side:
X-AC-Action: 'reply'
 To automatically reply to a message with a specific SIP response without
forwarding the response to the other side:
X-AC-Action: 'reply;response=<response code, e.g., 200>]'
 To switch to a different IP Profile for the call (re-INVITE only), as defined in the
IP Group:
X-AC-Action: 'switch-profile;profile-name=<IP Profile Name>'
X-AC-Action: 'switch-profile;profile-name=<IP Profile
Name>;reason=<PoorInVoiceQuality or
PoorInVoiceQualityFailure>]'
If the IP Profile name contains one or more spaces (e.g., "ITSP NET"), enclose the
name in double quotation marks, for example:
X-AC-Action: 'switch-profile;profile-name="ITSP NET"'
The following table provides examples of the X-AC-Action header.

Table 4-11: X-AC-Action Header Manipulation Rule Example

info.r body.isup.s header.x- Modi 'disconnect; Disconnects a

equest us exists ac-action fy delay=3000,r call after 3
eply' seconds if the
received SIP
INFO message
contains the


ISUP SUS field.
reinvi body.sdp header.x- Add 'switch- If a re-INVITE
te.req regex ac-action profile;prof message is
uest (.*)(m=audi ile- received and
o 7550 name=ITSP- whose media
RTP/AVP)(.* Profile-2' port value is
) 7550, the device
adds the SIP
header "X-AC-
Action: switch-
profile;profile-
name=ITSP-
Profile-2"to the
incoming re-
INVITE
message. As a
result of
receiving this
manipulated
message, the
device starts
using IP Profile
"ITSP-Profile-2"
instead of "ITSP-
Profile-1", for the
IP Group to
which the rule is
applied.

4.8 SIP Message Normalization

The device supports a built-in SIP message normalization feature that can be enabled per
manipulation rule. This is enabled by setting the Action Type field to "Normalize". The
normalization feature removes unknown or non-standard SIP message elements before
forwarding the message. These elements can include SIP headers, SIP header
parameters, and SDP body fields.
Message normalization is typically configured per SIP header but can also be configured
for all headers (including SDP). For example, to normalize the Refer-To header, you would
need to set the Action Subject field to "Refer-To" and the Action Type field to "Normalize".
The device normalizes the following SIP elements:
 URLs:
• User part is normalized, for example, the bolded area is removed:
<sip:+1-800-229-229;phone-
context=1@10.33.2.17;user=phone;UnknownUrlParam>
• Unknown parameters are removed, for example, the bolded area is removed:
<sip:+1-800-229-229;phone-
context=1@10.33.2.17;user=phone;UnknownUrlParam>
The resultant URL after above example normalization:
<sip:+1800229229@10.33.2.17;user=phone>
 Headers:
• Alert-Info: unknown header parameters are removed
• P-Called-Party-ID: unknown header parameters are removed, URL is normalized
• P-Charging-Vector: unknown header parameters are removed
• P-Associated-URI: unknown header parameters are removed, URL is normalized
• P-Preferred-Identity: URL is normalized
• Diversion: unknown header parameters are removed, URL is normalized
• P-Asserted-Identity: URL is normalized
• Remote-Party-ID: unknown header parameters are removed, URL is normalized
• Reason: unknown header parameters are removed
• Max-Forwards: value is changed to 70
• History-Info: unknown header parameters are removed, URL is normalized
• From: unknown header parameters are removed, URL is normalized
• To: unknown header parameters are removed, URL is normalized
• Via: unknown header parameters are removed
• Refer-To: unknown header parameters are removed, URL is normalized
• Referred-By: unknown header parameters are removed, URL is normalized
• Event: unknown header parameters are removed
• Session-Expires: unknown header parameters are removed
• Min-SE: unknown header parameters are removed
• Min-Expires: unknown header parameters are removed
• Request-URI: URL is normalized
• Contact: unknown header parameters are removed
• Subscription-State: unknown header parameters are removed

For example:
• To header before normalization:
To: <sip:100;phone-
context=1@10.33.2.17;user=phone;UnknownUrlParam>;UnknownHea
derlParam
• To header after SIP normalization (user parameter, unknown URL parameter,
and unknown header parameter are removed):
To: <sip:100@10.33.2.17;user=phone>
 SDP Body: Removes unnecessary SDP fields (except v=, o=, s=, c=, t=, and r=) and
unknown media with all its attributes. For example, the bolded text is removed before
sending the message:
v=0
o=SMG 791285 795617 IN IP4 10.33.2.17
s=Phone-Call
i=A Seminar on the session description protocol
u=http://www.example.com/seminars/sdp.pdf
e=j.doe@example.com (Jane Doe)
c=IN IP4 10.33.2.26
t=0 0
m=unknown 6000 RTP/AVP 8
a=unknown
a=sendrecv
a=ptime:20
m=audio 6000 RTP/AVP 8
a=rtpmap:8 pcma/8000
a=sendrecv
a=unknown
a=ptime:20
 Message: Normalization of the entire message. Headers and bodies not listed below
are removed while those listed are retained and normalized (if necessary and if listed
as supported for normalization, as previously mentioned) :
• Headers:
♦ Request-URI
♦ Via
♦ Max-Forwards
♦ From
♦ To
♦ Call-ID
♦ Cseq
♦ Contact
♦ Record-Route
♦ Route
♦ Supported
♦ Allow
♦ P-Preferred-Identity
♦ Diversion
♦ Rack
♦ Required
♦ RSeq
♦ Authorization

♦ Proxy-Authorization
♦ WWW-Authenticate
♦ Proxy-Authenticate
♦ Event
♦ Refer-To
♦ Referred-By
♦ Replaces
♦ User-Agent
♦ P-Asserted-ID
♦ History-Info
♦ Priority
♦ Resource-Priority
♦ Unsupported
♦ Expires
♦ Session-Expires
♦ Min-SE
♦ Min-Expires
• Bodies:
♦ SDP
♦ DTMF
Configuration Examples:
Table 4-12: Normalization Examples
Message Action
Condition Action Subject Action Type Description
Type Value
invite - message Normaliz - Normalizes entire

e message (headers and
SDP) of INVITE
messages
invite - body.sdp Normaliz - Normalizes only SDP
e body of INVITE
messages
invite - header.max- Normaliz - Normalizes the Max-
forwards e Forwards header of
INVITE messages

4.9 Source and Destination Dial Plan Tags

You can use source and destination Dial Plan tags as conditions ('Condition' field) and
values ('Action Value' field) in message manipulation rules.
Syntax
 Source Tag:
srctags
srctags.<tag name>
 Destination Tag:
dsttags
dsttags.<tag name>
Applicable Fields
 Condition
 Action Value
Note: Tags cannot be modified by Message Manipulation rules.
Table 4-13: Source and Destination Tags Examples
Message Action
Condition Action Subject Action Type Description
Type Value
invite srctags= header.City Add srcta If the source tag

='ny' gs associated with the call
equals "ny", add a
header called "City:"
with the value set to
"ny"
4.10 ENUM Queries

You can use Call Setup rules to query an ENUM server and to handle responses from
ENUM server. ENUM translates ordinary telephone numbers (E.164 telephone numbers)
into Internet addresses (SIP URIs), using the ENUM's DNS NAPTR records. Once
resolved into a URI, the device can replace the telephone number in the Request-URI of
the SIP message with the URI. When configuring Call Setup rules for ENUM queries,
configure the 'Query Type' parameter to ENUM.
Syntax
 Result (i.e., URI) of the ENUM query:
enum.result.url.<x>
Where x is optional and can be any of the following:
• type

• host
• mhost
• userphone
• looseroute
• bnce
• cause
• user
• transport-type
• ac-int
• param
 If ENUM query succeeded or not:
enum.found exists
enum.found !exists
Applicable Tables
Call Setup Rules table
Applicable Fields
 Condition
 Action Subject (only enum.result.url)
 Action Value (only enum.result.url)
Example
Table 4-14: ENUM Query Example
Query Action Subject Action Action

Search Key Condition Description
Type Type Value
ENUM param.cal enum.found header.req Modify enum Performs an ENUM

l.dst.use exists uest- .res query using the
called number and
r uri.url ult. if successful,
url replaces the entire
SIP Request-URI
with the retrieved
URI.
ENUM param.cal enum.found header.req Modify enum Performs an ENUM
l.dst.use exists uest- .res query using the
called number and
r uri.url.us ult. if successful,
er url. replaces SIP
user Request-URI user
part with the
retrieved URI user
part

4.11 SIP URIs and LDAP Queries for Microsoft Skype

Presence Feature
When the device is configured to interwork with Microsoft Skype for Business presence
feature for third-party endpoints (non-Microsoft endpoints), the device needs to query the
LDAP server with the calling and/or called numbers of the third-party endpoints and then
retrieve the corresponding SIP URIs of the Skype users. This is the URI that the device
uses as the Request-URI in the PUBLISH message that it sends to the Skype for Business
Server to indicate change of presence.
The device uses the following syntax in Call Setup Rules in the Action Subject field for
these SIP URIs:
Syntax:
 Source SIP URI:
presence.src
 Destination SIP URI:
presence.dst
For example, to search for a called mobile number, the searched LDAP Attribute is
"mobile" set to the value of the destination number ('mobile=+' + param.call.dst.user). If the
entry exists, the query searches for the Attribute userPrincipalName where the SIP URI is
defined for the corresponding mobile user. If found, the query returns the Attribute value
(i.e., URI) to the device (instructed using the special 'Condition' string "presence.dst" or
"presence.src").
Table 4-15: Source and Destination SIP URIs for Skype for Business Presence
Query Action Action

Search Key Attributes To Get Condition Action Value
Type Subject Type
LDAP 'mobile=+' userPrincipa ldap.at presen Add ldap.attr.userPrincipalName

+ lName tr.mobi ce.dst
param.call le
.dst.user exists
LDAP 'mobile=+' userPrincipa ldap.at presen Add ldap.attr.userPrincipalName
+ lName tr.mobi ce.src
param.call le
.src.user exists

This page is intentionally left blank.

Reference Guide 5. Typical Examples
5 Typical Examples
The following table provides a summary of typical examples of Message Manipulation
rules.
Table 5-1: Message Manipulation Examples
Message Action Action Action

invite.re param.messag header.diversi Add '<sip:We In INVITE requests,

quest e.sdp.addres on SellFlow add a Diversion
header if the c line in
s=='flowers. ers@p4.i the SDP is set to
com' sp.com>; "flowers.com".
reason=t
ime-of-
day'
info.resp header.reque header.request Modif '503' Change the Request-
onse st- - y URI method type to
503 from 488 in INFO
uri.methodty uri.methodtype response messages
pe=='488'
info.resp header.request Modif '183' Change request type
onse.180 - y method to 183 in 180
response messages.
uri.methodtype
invite.re header.expir header.organis Add 'audioco Check the time
quest es.time < ation des' parameter in Expires
headers. If it is less
'88888' than 88888, add an
organization header to
the INVITE request
message.
register. header.contact Add 'newValu Add newParam with a
request . e' value of newValue as
a general header level
param.newparam param to REGISTER
Contact headers
subscribe header.remote- Modif '2' In Subscribe response
.response party- y messages, change
the party type to
id.0.partytype ‘called’ (note,
1="calling", 2=
"called", 3="redirect")
in the 1st Remote-
Party-ID header.
invite.re header.from.pa Remov Remove the param
sponse ram.hello e named "hello" from
From headers in
INVITE responses.
any header.user- Modif 'TelcoA' Change the User-
agent y Agent header to
telcoA.
any header.from.qu Modif '0' Removes quotation
otecontrol y marks surrounding
display name in From
header.
any header.user- Add ‘isdn- Adds the parameter

Message Action Action Action

to- network’ "purpose" with value
user.param.pur "isdn-network' to the
User-to-User header.
pose

Reference Guide A. Message Manipulation Syntax Reference
A Message Manipulation Syntax Reference

This appendix provides a detailed description on the support and syntax for configuring SIP
message manipulation rules.
A.1 Action Type

The actions that can be done on SIP message manipulation are listed in the table below.
Table A-1: Action Types
Action Value
Add 0
Remove 1
Modify 2
Add Prefix 3
Add Suffix 4
Remove Suffix 5
Remove Prefix 6
The maximum length of the value for a manipulation is 299 characters.
A.2 Header Types

A.2.1 Accept
An example of the header is shown below:
Accept: application/sdp
Possible action types: Add, Delete, Modify
Multiple header fields support: No
The header properties are shown in the table below:
Action
Type
Header Level Action Add Delete Modify List Entries
Operations Supported Yes Yes No N/A
Keyword Sub Types Attributes
N/A N/A N/A
Below is a header manipulation example:

Rule: If the supported header does not contain 'mm,100rel,timer,replaces', then in all INVITE
messages add an Accept header:
MessageManipulations 8 = 1, invite, header.supported !=
'mm,100rel,timer,replaces', header.accept, 0, ' application/x-
private ', 0;

Rule: If the supported header does not contain 'mm,100rel,timer,replaces', then in all INVITE
messages add an Accept header:
MessageManipulations 8 = 1, invite, header.supported !=
'mm,100rel,timer,replaces', header.accept, 0, ' application/x-
private ', 0;
Result: Accept: application/x-private
A.2.2 Accept-Language
Accept-Language: da, en-gb;q=0.8, en;q=0.7
N/A N/A N/A

Rule: Add a new Language header to all INVITE messages:
MessageManipulations 0 = 1, invite, , header.accept-language, 0,
'en, il, cz, it', 0;
Result: Accept-Language: en, il, cz, it
A.2.3 Allow
Allow:
REGISTER,OPTIONS,INVITE,ACK,CANCEL,BYE,NOTIFY,PRACK,REFER,INFO,SUB
SCRIBE
N/A N/A Read/Write

Rule: Add an Allow header to all INVITE messages:
MessageManipulations 0 = 1, invite, , header.allow, 0,
'REGISTER,OPTIONS,INVITE,ACK,CANCEL,BYE,NOTIFY,PRACK,REFER,INFO
,SUBSCRIBE, XMESSAGE', 0;
Result: Allow:
REGISTER,OPTIONS,INVITE,ACK,CANCEL,BYE,NOTIFY,PRACK,REFER,INFO,

Rule: Add an Allow header to all INVITE messages:

MessageManipulations 0 = 1, invite, , header.allow, 0,
'REGISTER,OPTIONS,INVITE,ACK,CANCEL,BYE,NOTIFY,PRACK,REFER,INFO
,SUBSCRIBE, XMESSAGE', 0;
SUBSCRIBE, XMESSAGE
A.2.4 Call-Id
Call-ID: JNIYXOLCAIWTRHWOINNR@10.132.10.128
Operations Supported No No No NA
ID String Read Only

Rule: Add a proprietary header to all INVITE messages using the data in the Call-id header:
MessageManipulations 0 = 1, invite, , header.Xitsp-abc, 0,
header.call-id, 0;
Result: Xitsp-abc: GIAPOFWRBQKJVAETIODI@10.132.10.128
A.2.5 Contact
Contact: <sip:555@10.132.10.128:5080>
Multiple header fields support: Yes
Operations Supported No No No 3
Expires Integer Read/Write

GruuContact String Read/Write
IsGRUU Boolean Read/Write
Name String Read/Write
Param Param Read/Write
URL 'URL' on page 99 Read/Write*
* Host name cannot be modified in the URL structure for a contact header.

Rule: Change the user part in the Contact header in all INVITE messages to fred:
MessageManipulations 0 = 1, Invite, ,header.contact.url.user, 2,
'fred', 0;
Result: Contact: <sip:fred@10.132.10.128:5070>
A.2.6 Cseq
CSeq: 1 INVITE
Operations Supported No No No N/A
Num Integer Read Only

Type String Read Only

Rule: If the Cseq number is 1, then modify the user in the Contact header to fred.
MessageManipulations 0 = 1, Invite,
header.cseq.num=='1',header.contact.url.user, 2, 'fred', 0;
Result: Contact: <sip:fred@10.132.10.128:5070>
A.2.7 Diversion
Diversion: <sip:654@IPG2Host;user=phone>;reason=user-
busy;screen=no;privacy=off;counter=1
Operations Supported Yes Yes Yes 3

Privacy Enum Privacy (see 'Privacy' on page Read/Write
103)
Reason Enum Reason (see 'Reason Read/Write
(Diversion)' on page 103)
Screen Enum Screen (see 'Screen' on page Read/Write
106)
URL URL Structure (see 'URL' on page 99) Read/Write

Below are header manipulation examples:

Example 1 Rule: Add a Diversion header to all INVITE messages:
MessageManipulations 0 = 1, invite, ,
header.Diversion, 0, '<tel:+101>;reason=unknown;
counter=1;screen=no; privacy=off', 0;
Result: Diversion: <tel:+101>;reason=user-
Example 2 Rule: Modify the Reason parameter in the header to 1, see 'Reason (Diversion)'
on page 103 for possible values:
header.Diversion.reason, 2, '1', 0;
Result: Diversion: <tel:+101>;reason=user-
Example 3 Rule: The URL in the Diversion header is modified to that which is contained in
the header URL:
header.Diversion.URL, 2, header.from.url, 0;
Result: Diversion:<sip:555@IPG2Host;user=phone>;reason=user-
A.2.8 Event
Event: foo; id=1234
Operations Supported Yes Yes Yes N/A
EventKey Event Structure (see 'Event Read/Write

Structure' on page 97)
Example 1 Rule: Add parameter itsp-abc=voip to the Event header:
header.event.param.itsp-abc, 0, 'voip' , 0;
Result: Event: foo;id=1234;itsp-abc=voip
Example 2 Rule: Modify the Event ID string:

header.event.EVENTKEY.id, 2, '5678', 0;
Result: Event: foo;id=5678;
Example 3 Rule: Modify the Event package enum:

header.event.EVENTKEY.EVENTPACKAGE, 2, '2', 0;
Result: Event: refer;id=5678

A.2.9 From
From: <sip:555@10.132.10.128;user=phone>;tag=YQLQHCAAYBWKKRVIMWEQ
Operations Supported No No Yes NA

tag String Read Only
URL URL Structure (refer to Read/Write
'URL' on page 99)

Example 1 Rule: Change the user part of the From header if the user is not 654:
MessageManipulations 8 = 1, invite, header.from.url.user
!= '654', header.from.url.user, 2, 'fred', 0;
Result: From: <sip:fred@IPG2Host;user=phone>;tag=1c20161
Example 2 Rule: Add a new parameter to the From header called p1 and set its value to
myParameter:
MessageManipulations 1 = 1, Invite.request,
,header.from.param.p1, 0, 'myParameter', 0;
Result: From:
<sip:fred@IPG2Host;user=phone>;p1=myParameter;tag=1c5891
Example 3 Rule: Modify the URL in the From header:
MessageManipulations 0 = 1, any, , header.from.url, 2,
'sip:3200@110.18.5.41;tusunami=0', 0;
Result: From:
<sip:3200@110.18.5.41;user=phone;tusunami=0>;tag=1c23750
A.2.10 History-Info
History-Info: <sip:UserA@ims.example.com;index=1>
History-Info: <sip:UserA@audc.example.com;index=2>

HistoryInfo String Read/Write

Example 1 Rule: Add a new History-Info header to the message:
MessageManipulations 0 = 1, any, , header.History-
Info, 0, '<sip:UserA@audc.mydomain.com;index=3>', 0
Result: History-Info:sip:UserA@ims.example.com;index=1
History-Info:sip:UserA@audc.example.com;index=2
History-Info: <sip:UserA@audc.mydomain.com;index=3>
Example 2 Rule: Delete an unwanted History-Info header from the message:
Info.1, 1, , 0;
Result: History-Info: <sip:UserA@ims.example.com;index=1>
Example 3 Rule: Delete all History-Info from the message:

Info, 1, , 0;
Result: All history-info headers are removed.
A.2.11 Min-Se and Min-Expires

Min-SE: 3600
Min-Expires: 60

Time Integer Read/Write

Example 1 Rule: Add a Min-Se header to the message using a value of 50:
MessageManipulations 1 = 1, any, , header.min-se, 0,
'50', 0;
Result: Min-SE: 50
Example 2 Rule: Modify a Min-Expires header with the min-expires value and add an
additional 0:
MessageManipulations 0 = 1, Invite, , header.Min-
Expires.param, 2, header.Min-Expires.time + '0', 0;
Result: Min-Expires: 340;3400
Example 3 Rule: Modify a Min-Expires header changing the time to 700:

MessageManipulations 0 = 1, Invite, , header.Min-

Expires.time, 2, '700', 0;
Result: Min-Expires: 700
A.2.12 P-Asserted-Identity
P-Asserted-Identity: Jane Doe <sip:567@itsp.com>
URL URL Structure (see 'URL' Read/Write

on page 99)

Example 1 Rule: Add a P-Asserted-Id header to all INVITE messages:
MessageManipulations 2 = 1, invite, , header.p-
asserted-identity, 0, '<sip:567@itsp.com>', 0;
Result: P-Asserted-Identity: <sip:567@itsp.com>
Example 2 Rule: Modify the P-Asserted-Identity host name to be the same as the host name in
the To header:
MessageManipulations 2 = 1, invite, , header.p-
asserted-identity.URL.host, 2, header.to.url.host, 0;
Result: P-Asserted-Identity: <sip:567@10.132.10.128>
A.2.13 P-Associated-Uri
P-Associated-URI: <sip:12345678@itsp.com>

on page 99)


Example 1 Rule: Add a P-Associated-Uri header to all INVITE response messages:
MessageManipulations 5 = 1, register.response,
,header.P-Associated-URI, 0,
'<sip:admin@10.132.10.108>', 0;
Result: P-Associated-URI:<sip:admin@10.132.10.108>
Example 2 Rule: Modify the user portion of the URL in the header to 'alice':
MessageManipulations 5 = 1, register.response,
,header.P-Associated-URI.url.user, 2, 'alice', 0;
Result: P-Associated-URI:<sip:alice@10.132.10.108>
A.2.14 P-Called-Party-Id
P-Called-Party-ID: <sip:2000@gw.itsp.com>

on page 99)

Example 1 Rule: Add a P-Called-Party-Id header to all messages:
MessageManipulations 8 = 1, any, , header.p-called-
party-id, 0, 'sip:2000@MSBG.ITSP.COM', 0;
Result: P-Called-Party-ID: <sip:2000@gw.itsp.com>
Example 2 Rule: Append a parameter (p1) to all P-Called-Party-Id headers:

MessageManipulations 9 = 1, invite, , header.p-called-
party-id.param.p1, 0, 'red', 0;
Result: P-Called-Party-ID: <sip:2000@gw.itsp.com>;p1=red
Example 3 Rule: Add a display name to the P-Called-Party-Id header:

MessageManipulations 3 = 1, any, , header.p-called-
party-id.name, 2, 'Secretary', 0;
Result: P-Called-Party-ID: Secretary
<sip:2000@gw.itsp.com>;p1=red

A.2.15 P-Charging-Vector
P-Charging-Vector: icid-value=1234bc9876e; icid-generated-
at=192.0.6.8; orig-ioi=home1.net
N/A N/A N/A

Rule: Add a P-Charging-Vector header to all messages:
MessageManipulations 1 = 1, any, , header.P-Charging-Vector, 0,
'icid-value=1234bc9876e; icid-generated-at=192.0.6.8; orig-
ioi=home1.net', 0;
Result: P-Charging-Vector: icid-value=1234bc9876e; icid-generated-
at=192.0.6.8; orig-ioi=home1.net
A.2.16 P-Preferred-Identity
P-Preferred-Identity: "Cullen Jennings" <sip:fluffy@abc.com>

on page 99)

Example 1 Rule: Add a P-Preferred-Identity header to all messages:
MessageManipulations 1 = 1, any, , header.P-Preferred-
Identity, 0, 'Cullen Jennings <sip:fluffy@abc.com>', 0;
Result: P-Preferred-Identity: "Cullen Jennings"
<sip:fluffy@abc.com>
Example 2 Rule: Modify the display name in the P-Preferred-Identity header:
MessageManipulations 2 = 1, any, , header.P-Preferred-
Identity.name, 2, 'Alice Biloxi', 0;
Result: P-Preferred-Identity: "Alice Biloxi"
<sip:fluffy@abc.com>

A.2.17 Privacy
Privacy: none
privacy 'Privacy Struct' on page 98 Read/Write

Example 1 Rule: Add a privacy header and set it to ‘'session':
MessageManipulations 1 = 1, any, , header.Privacy, 0,
'session', 0;
Result: Privacy: session
Example 2 Rule: Add ‘user’ to the list:

MessageManipulations 1 = 3, , ,
header.privacy.privacy.user, 2, '1', 0;
Result: Privacy: session;user
A.2.18 Proxy-Require
Proxy-Require: sec-agree
Capabilities SIPCapabilities Struct Read/Write

Example 1 Rule: Add a Proxy-Require header to the message:
MessageManipulations 1 = 1, any, , header.Proxy-
Require, 0, 'sec-agree', 0;
Result: Proxy-Require: sec-agree
Example 2 Rule: Modify the Proxy-Require header to itsp.com:

MessageManipulations 2 = 1, any, , header.Proxy-
Require, 2, 'itsp.com' , 0;
Result: Proxy-Require: itsp.com

Example 3 Rule: Set the privacy options tag in the Proxy-Require header:
MessageManipulations 0 = 0, invite, , header.Proxy-
Require.capabilities.privacy, 0, 1 , 0;
Result: Proxy-Require: itsp.com, privacy
A.2.19 Reason
Reason: SIP ;cause=200 ;text="Call completed elsewhere"
MLPP MLPP Structure (see Read/Write

'MLPP' on page 97)
Reason Reason Structure (see Read/Write
'Reason Structure' on
page 98)

Example 1 Rule: Add a Reason header:
MessageManipulations 0 = 1, any, ,header.reason, 0,
'SIP;cause=200;text="Call completed elsewhere"', 0;
Result: Reason: SIP ;cause=200 ;text="Call completed elsewhere"
Example 2 Rule: Modify the reason cause number:

MessageManipulations 0 = 1, any,
,header.reason.reason.cause, 0, '200', 0;
Result: Reason: Q.850 ;cause=180 ;text="Call completed
elsewhere"
Example 3 Rule: Modify the cause number:
MessageManipulations 0 = 1, any,
,header.reason.reason.reason, 0, '483', 0;
Result: Reason: SIP ;cause=483 ;text="483 Too Many Hops"
Note: The protocol (SIP or Q.850) is controlled by setting the cause number to be greater
than 0. If the cause is 0, then the text string (see Example 3) is generated from the reason
number.

A.2.20 Referred-By
Referred-By: <sip:referrer@referrer.example>;
param param Read/Write

on page 99)

Example 1 Rule: Add a Referred-By header:
MessageManipulations 0 = 1, any, ,header.Referred-By,
0, '<sip:refer@refer.com>', 0;
Result: Referred-By: <sip: sip:refer@refer.com>
Example 2 Rule: Modify the host:

MessageManipulations 0 = 1, any, ,header.Referred-
By.url.host, 0, 'yahoo.com', 0;
Result: Referred-By: <sip:refer@yahoo.com>
Example 3 Rule: Add a new parameter to the header:

MessageManipulations 0 = 1, any, ,header.Referred-
By.param.p1, 0, 'fxs', 0
Result: Referred-By: <sip:referrer@yahoo.com>;p1=fxs
A.2.21 Refer-To
Refer-To: sip:conference1@example.com
Refer-To:
<sips:a8342043f@atlanta.example.com?Replaces=12345601%40atlanta.ex
ample.com%3bfrom-tag%3d314159%3bto-tag%3d1234567>
N/A N/A N/A


Example 1 Rule: Add a basic header:
MessageManipulations 0 = 1, any, ,header.Refer-to, 0,
'<sip:referto@referto.com>', 0;
Result: Refer-To: <sip:referto@referto.com>
Example 2 Rule: Add a Refer-To header with URI headers:

MessageManipulations 0 = 1, any, ,header.Refer-to, 0,
'<sips:a8342043f@atlanta.example.com?Replaces=12345601
%40atlanta.example.com%3bfrom-tag%3d314159%3bto-
tag%3d1234567>', 0;
Result: Refer-To:
<sips:a8342043f@atlanta.example.com?Replaces=12345601%
40atlanta.example.com%3bfrom-tag%3d314159%3bto-
tag%3d1234567>
A.2.22 Remote-Party-Id
Remote-Party-ID: "John Smith"
<sip:john.smith@itsp.com>;party=calling; privacy=full;screen=yes
Counter Integer Read/Write

NumberPlan Enum Number Plan (see 'Number Plan' on page 102) Read/Write
NumberType Enum Number Type (see 'NumberType' on page 102) Read/Write
Privacy Enum Privacy (see 'Privacy' on page 103) Read/Write
Reason Enum Reason (RPI) (see 'Reason (Remote-Party-Id)' Read/Write
on page 106)
Screen Enum Screen (see 'Screen' on page 106) Read/Write
ScreenInd Enum ScreenInd (see 'ScreenInd' on page 106) Read/Write
URL URL Structure (see 'URL' on page 99) Read/Write

Example 1 Rule: Add a Remote-Party-Id header to the message:
MessageManipulations 0 = 1, invite, ,header.REMOTE-
PARTY-ID, 0, '<sip:999@10.132.10.108>;party=calling',
0;
Result: Remote-Party-ID:
<sip:999@10.132.10.108>;party=calling;npi=0;ton=0

Example 2 Rule: Create a Remote-Party-Id header using the url in the From header using
the + operator to concatenate strings:
MessageManipulations 0 = 1, Invite, ,header.REMOTE-
PARTY-ID, 0, '<'+header.from.url +'>' +
';party=calling', 0;
<sip:555@10.132.10.128;user=phone>;party=calling;npi=
0;ton=0
Example 3 Rule: Modify the number plan to 1 (ISDN):
MessageManipulations 1 = 1, invite, , header.Remote-
Party-ID.numberplan, 2, '1', 0;
<sip:555@10.132.10.128;user=phone>;party=calling;npi=
1;ton=0
Example 4 Rule: Modify the Remote-Party-Id header to set the privacy parameter to 1 (Full):
MessageManipulations 1 = 1, invite, , header.Remote-
Party-ID.privacy, 2, '1', 0;
<sip:555@10.132.10.128;user=phone>;party=calling;priv
acy=full;npi=0;ton=0
A.2.23 Request-Uri
sip:alice:secretword@atlanta.com;transport=tcp
SIP/2.0 486 Busy Here
Operations Supported No No Yes NA

Method String Read/Write
MethodType Enum: Read/Write
 5: INVITE
 7: BYE
 8: OPTIONS
 9: ACK
 10: CANCEL
 11: REGISTER
 12: INFO
 13: MESSAGE
 14: NOTIFY
 15: REFER
 16: SUBSCRIBE
 17: PRACK
 18: UPDATE
 19: PUBLISH
 21: SERVICE
URI String Read/Write


on page 99)

Example 1 Rule: Test the Request-URI transport type. If 1 (TCP), then modify the URL portion
of the From header:
header.REQUEST-URI.url.user == '101', header.REMOTE-
PARTY-ID.url, 2, 'sip:3200@110.18.5.41;tusunami=0', 0;
<sip:3200@110.18.5.41;tusunami=0>;party=calling;npi=0;
ton=0
Example 2 Rule: If the method type is 5 (INVITE), then modify the Remote-Party-Id header:
header.REQUEST-URI.methodtype == '5', header.REMOTE-
PARTY-ID.url, 2, 'sip:3200@110.18.5.41;tusunami=0', 0;
<sip:3200@110.18.5.41;tusunami=0>;party=calling;npi=0;
ton=0
Example 3 Rule: For all request URI's whose method types are 488, modify the message type
to a 486:
MessageManipulations 1 = 1, , header.request-
uri.methodtype=='488', header.request-uri.methodtype,
2, '486', 0;
Result: SIP/2.0 486 Busy Here
A.2.24 Require
Require: 100rel

Example 1 Rule: Add a Require header to all messages:
MessageManipulations 1 = 1, , ,header.require, 0,
'early-session,em,replaces', 0;
Result: Require: em,replaces,early-session
Example 2 Rule: If a Require header exists, then delete it:

MessageManipulations 2 = 1, Invite, header.require
exists ,header.require, 1, '', 0;
Result: The Require header is deleted.
Example 3 Rule: Set the early media options tag in the header:

header.require.capabilities.earlymedia, 0, 1 , 0;
Result: Require: em,replaces,early-session, early-media
Example 4 Rule: Set the privacy options tag in the Require header:
header.require.capabilities.privacy, 0, 1 , 0;
Result: Require: em,replaces,early-session, privacy
A.2.25 Resource-Priority
Resource-Priority: wps.3
Namespace String Read/Write

RPriority String Read/Write
A.2.26 Retry-After
Retry-After: 18000

Example 1 Rule: Add a Retry-After header:
MessageManipulations 2 = 1, Invite, ,header.Retry-
After, 0, '3600', 0;
Result: Retry-After: 3600
Example 2 Rule: Modify the Retry-Time in the header to 1800:

MessageManipulations 3 = 1, Invite, ,header.Retry-
After.time, 2, '1800', 0;
Result: Retry-After: 1800

A.2.27 Server or User-Agent

User-Agent: Sip Message Generator V1.0.0.5
N/A N/A N/A

Example 1 Rule: Remove the User-Agent header:
MessageManipulations 2 = 1, Invite, ,header.user-
agent, 1, '', 0;
Result: The header is removed.
Example 2 Rule: Change the user agent name in the header:
MessageManipulations 3 = 1, Invite, ,header.user-
agent, 2, 'itsp analogue gateway', 0;
Result: User-Agent: itsp analog gateway
A.2.28 Service-Route
Service-Route: <sip:P2.HOME.EXAMPLE.COM;lr>,
<sip:HSP.HOME.EXAMPLE.COM;lr>
ServiceRoute String Read/Write

Example 1 Rule: Add two Service-Route headers:
MessageManipulations 1 = 1, Invite, ,header.service-
route, 0, '<P2.HOME.EXAMPLE.COM;lr>', 0;
route, 0, '<sip:HSP.HOME.EXAMPLE.COM;lr>', 0;
Result: Service-Route:<P2.HOME.EXAMPLE.COM;lr>
Service-Route: <sip:HSP.HOME.EXAMPLE.COM;lr>
Example 2 Rule: Modify the Service-Route header in list entry 1:

route.1.serviceroute, 2, '<sip:itsp.com;lr>', 0;
Result: Service-Route:sip:itsp.com;lr
Service-Route: <sip:HSP.HOME.EXAMPLE.COM;lr>
Example 3 Rule: Modify the Service-Route header in list entry 0:
route.0.serviceroute, 2, '<sip:home.itsp.com;lr>', 0;
Result: Service-Route:sip:home.itsp.com;lr
Service-Route: <sip:itsp.com;lr>
A.2.29 Session-Expires
Session-Expires: 480

Refresher Enum Refresher (see Read/Write
'Refresher' on page 106)

Example 1 Rule: Add a Session-Expires header:
MessageManipulations 0 = 1, any, , header.Session-
Expires, 0, '48' + '0', 0;
Result: Session-Expires: 480
Example 2 Rule: Modify the Session-Expires header to 300:

Expires.time, 2, '300', 0;
Result: Session-Expires: 300
Example 3 Rule: Add a param called longtimer to the header:

Expires.param.longtimer, 0, '5', 0;
Result: Session-Expires: 480;longtimer=5
Example 4 Rule: Set the refresher to 1 (UAC):

MessageManipulations 3 = 1, any, , header.session-
expires.refresher, 2, '1', 0;
Result: Session-Expires: 300;refresher=uac;longtimer=5

A.2.30 Subject
Subject: A tornado is heading our way!
Subject String Read/Write

Rule: Add a Subject header:
MessageManipulations 0 = 1, any, , header.Subject, 0, 'A tornado
is heading our way!', 0;
Result: Subject: A tornado is heading our way!
A.2.31 Supported
Supported: early-session

Example 1 Rule: Add a Supported header:
MessageManipulations 1 = 1, Invite, ,header.supported,
0, 'early-session', 0;
Result: Supported: early-session
Example 2 Rule: Set path in the Supported headers options tag:

header.supported.capabilities.path, 0, true, 0;
Result: Supported: early-session, path

A.2.32 To
To: <sip:101@10.132.10.128;user=phone>
Operations Supported No No No NA

tag String Read Only
URL URL Structure (refer to Read/Write
'URL' on page 99)

Example 1 Rule: Set the user phone Boolean to be false in the To header's URL:
MessageManipulations 4 = 1, invite.request, ,
header.to.url.UserPhone, 2, '0', 0;
Result: To: <sip:101@10.132.10.128>
Example 2 Rule: Change the URL in the To header:

header.to.url.UserPhone, 2, '0', 0;
Result: To: <sip:101@10.20.30.60:65100>
Example 3 Rule: Set the display name to 'Bob':

header.to.name, 2, 'Bob', 0;
Result: To: "Bob D" sip:101@10.20.30.60:65100
Example 4 Rule: Add a proprietary parameter to all To headers:

header.to.param.artist, 0, 'singer', 0;
Result: To: "Bob D" <sip:101@10.20.30.60:65100>;artist=singer

A.2.33 Unsupported
Unsupported: 100rel

Example 1 Rule: Add an Unsupported header to the message:
MessageManipulations 0 = 1, Invite.response,
,header.unsupported, 0, 'early-session,
myUnsupportedHeader', 0;
Result: Unsupported: early-session
Example 2 Rule: Modify the Unsupported header to 'replaces':

MessageManipulations 1 = 1, Invite,
,header.unsupported, 2, 'replaces', 0;
Result: Unsupported: replaces
Example 3 Rule: Set the path in the Unsupported headers options tag:
header.unsupported.capabilities.path, 0, true, 0;
Result: Unsupported: replaces, path
A.2.34 Via
Via: SIP/2.0/UDP 10.132.10.128;branch=z9hG4bKUGOKMQPAVFKTAVYDQPTB
Operations Supported No No No 10
Alias Boolean Read Only

Branch String Read Only
Host Host Structure (see 'Host' Read Only
on page 97)
MAddrIp gnTIPAddress Read Only

Port Integer Read Only

TransportType Enum TransportType (see Read Only
'TransportType' on page
107)

Rule: Check the transport type in the first Via header and if it's set to UDP, then modify the
From header's URL:
header.VIA.0.transporttype == '0', header.from.url, 2,
'sip:3200@110.18.5.41;tusunami=0', 0;
Result: From: <sip:3200@110.18.5.41;user=phone;tusunami=0>;tag=1c7874
A.2.35 Warning
Warning: 307 isi.edu "Session parameter 'foo' not understood"
Warning: 301 isi.edu "Incompatible network address type 'E.164'"
N/A N/A N/A

Rule: Add a Warning header to the message:
MessageManipulations 0 = 1, Invite.response.180,
,header.warning, 0, '399 source.host.com \"Incompatible\"', 0;
Result: Warning: 399 source.host.com “Incompatible”

A.2.36 Unknown Header

An Unknown header is a SIP header that is not included in this list of supported headers.
MYEXP: scooby, doo, goo, foo
N/A N/A N/A

Example 1 Rule: Add a custom header to all messages:
MessageManipulations 0 = 1, , , header.myExp, 0,
'scooby, doo, goo, foo', 0;
Result: myExp: scooby, doo, goo, foo
Example 2 Rule: Create a new header called "media", whose value is a concatenation of the
time in the Session-Expires header, followed by "000", followed by
";refresher=", followed by "1" or "2", depending on whether the refresher
parameter in the Session-Expires header has the value 'UAC' or 'UAS':
MessageManipulations 0 = 1, any, , header.media, 0,
header.Session-Expires.time + '000' + ';refresher=' +
header.Session-Expires.Refresher, 0;
Result: media: 3600000;refresher=1
Example 3 Rule: Create lists of Unknown headers:

MessageManipulations 1 = 1, Invite, , header.myExp.1,
0, 'scooby, doo, goo, foo1', 0;
MessageManipulations 2 = 1, Invite, , header.myExp.2,
0, 'scooby, doo, goo, foo2', 0;
Result: myExp: scooby, doo, goo, foo1
myExp: scooby, doo, goo, foo2
Example 4 Rule: Remove the SIP header 'colour' from INVITE messages:
MessageManipulations 1 = 1, Invite, , header.colour, 1,
'', 0;
Result: The colour header is removed.

A.3 Structure Definitions

A.3.1 Event Structure
The Event structure is used in the Event header (see 'Event' on page 77).
Table A-2: Event Structure
EventPackage Enum Event Package (see Read/Write

'Event Package' on page
101)
EventPackageString* String Read/Write
Id String Read/Write
Event package string is used for packages that are not listed in the Enum Event Package
table (see 'Event Package' on page 101).
A.3.2 Host
The host structure is applicable to the URL structure (see 'URL' on page 99) and the Via
header (see 'Via' on page 94).
Table A-3: Host Structure
Keyword Sub Types
Port Short
Name String
A.3.3 MLPP
This structure is applicable to the Reason header (see 'Reason' on page 84).
Table A-4: MLPP Structure
Keyword Sub Types
Type Enum MLPP Reason (see 'MLPP Reason Type' on page 102)
Cause Int

A.3.4 Privacy Struct

This structure is applicable to the Privacy header (see 'Privacy' on page 83).
Table A-5: Privacy Structure
Keyword Sub Types
NONE Boolean
HEADER Boolean
SESSION Boolean
USER Boolean
CRITICAL Boolean
IDENTITY Boolean
HISTORY Boolean
A.3.5 Reason Structure

This structure is applicable to the Reason header (see 'Reason' on page 84).
Table A-6: Reason Structure
Keyword Sub Types
Reason Enum Reason (see 'Reason (Reason Structure)' on page 103)

Cause Int
Text String
A.3.6 SIPCapabilities
This structure is applicable to the following headers:
 Supported (see 'Supported' on page 92)
 Require (see 'Require' on page 88)
 Proxy-Require (see 'Proxy-Require' on page 83)
 Unsupported (see 'Unsupported' on page 94)
Table A-7: SIPCapabilities Structure
Keyword Sub Types
EarlyMedia Boolean
ReliableResponse Boolean
Timer Boolean
EarlySession Boolean
Privacy Boolean
Replaces Boolean

Keyword Sub Types
History Boolean
Unknown Boolean
GRUU Boolean
ResourcePriority Boolean
TargetDialog Boolean
SdpAnat Boolean
A.3.7 URL
This structure is applicable to the following headers:
 Contact (see 'Contact' on page 75)
 Diversion (see 'Diversion' on page 76)
 From (see 'From' on page 78)
 P-Asserted-Identity (see 'P-Asserted-Identity' on page 80)
 P-Associated-Uri (see 'P-Associated-Uri' on page 80)
 P-Called-Party-Id (see 'P-Called-Party-Id' on page 81)
 P-Preferred-Identity (see 'P-Preferred-Identity' on page 82)
 Referred-By (see 'Referred-By' on page 85)
 Refer-To (see 'Refer-To' on page 85)
 Remote-Party-Id (see 'Remote-Party-Id' on page 86)
 Request-Uri (see 'Request-Uri' on page 87)
 To (see 'To' on page 93)
Table A-8: URL Structure
Keyword Sub Types
Type Enum Type (see 'Type' on page 107)
Host Host Structure (see 'Host' on page 97)

MHost Structure
UserPhone Boolean
LooseRoute Boolean
User String
TransportType Enum Transport (see 'TransportType' on page 107)
Param Param

A.4 Random Type

Manipulation rules can include random strings and integers. An example of a manipulation
rule using random values is shown below:
MessageManipulations 4 = 1, Invite.Request, , Header.john, 0,
rand.string.56.A.Z, 0;
In this example, a header called "john" is added to all INVITE messages received by the
device and a random string of 56 characters containing characters A through Z is added to
the header.
For a description of using random values, see the subsequent subsections.
A.4.1 Random Strings

The device can generate random strings in header manipulation rules that may be
substituted where the type ‘String’ is required. The random string can include up to 298
characters and include a range of, for example, from a to z or 1 to 10. This string is used in
the table's 'Action Value' field.
The syntax for using random strings is:
Rand.string.<number of characters in string>.<low character>.<high
character>
Examples:
 Rand.string.5.a.z: This generates a 5-character string using characters a through z.
 Rand.string.8.0.z: This generates an 8-character string using characters and digits.
A.4.2 Random Integers

The device can generate a random numeric value that may be substituted where the type
‘Int’ is required. The syntax for random numeric values is:
Rand.number.<low number>.<high number>
Examples:
 Rand.number.5.32: This generates an integer between 5 and 32

A.5 Enum Definitions

A.5.1 AgentRole
These ENUMs are applicable to the Server or User-Agent headers (see 'Server or User-
Agent' on page 90).
Table A-9: Enum Agent Role
AgentRole Value
Client 1
Server 2
A.5.2 Event Package

These ENUMs are applicable to the Server or User-Agent (see 'Server or User-Agent' on
page 90) and Event (see 'Event' on page 77) headers.
Table A-10: Enum Event Package
Package Value
TELEPHONY 1
REFER 2
REFRESH 3
LINE_STATUS 4
MESSAGE_SUMMARY 5
RTCPXR 6
SOFT_SYNC 7
CHECK_SYNC 8
PSTN 9
DIALOG_PACKAGE 10
REGISTRATION 11
START_CWT 12
STOP_CWT 13
UA_PROFILE 14
LINE_SEIZE 15

A.5.3 MLPP Reason Type

These ENUMs are applicable to the MLPP Structure (see 'MLPP' on page 97).
Table A-11: Enum MLPP Reason Type
Type Value
PreEmption Reason 0
MLPP Reason 1
A.5.4 Number Plan

These ENUMs are applicable to the Remote-Party-Id header (see 'Remote-Party-Id' on
page 86).
Table A-12: Enum Number Plan
Plan Value
ISDN 1
Data 3
Telex 4
National 8
Private 9
Reserved 15
A.5.5 Number Type

page 86).
Table A-13: Enum Number Type
Number Type Value
INTERNATIONAL LEVEL2 REGIONAL 1

NATIONAL LEVEL1 REGIONAL 2
NETWORK PISN SPECIFIC NUMBER 3
SUBSCRIBE LOCAL 4
ABBREVIATED 6
RESERVED EXTENSION 7

A.5.6 Privacy
These ENUMs are applicable to the Remote-Party-Id (see 'Remote-Party-Id' on page 86)
and Diversion (see 'Diversion' on page 76) headers.
Table A-14: Enum Privacy
Privacy Role Value
Full 1
Off 2
A.5.7 Reason (Diversion)

These ENUMs are applicable to the Diversion header (see 'Diversion' on page 76).
Table A-15: Enum Reason
Reason Value
Busy 1
No Answer 2
Unconditional 3
Deflection 4
Unavailable 5
No Reason 6
Out of service 7
A.5.8 Reason (Reason Structure)

These ENUMs are used in the Reason Structure (see 'Reason Structure' on page 98).
Table A-16: Enum Reason (Reason Structure)
Reason Value
INVITE 5
REINVITE 6
BYE 7
OPTIONS 8
ACK 9
CANCEL 10
REGISTER 11
INFO 12
MESSAGE 13
NOTIFY 14

Reason Value
REFER 15
SUBSCRIBE 16
PRACK 17
UPDATE 18
PUBLISH 19
LAST_REQUEST 20
TRYING_100 100
RINGING_180 180
CALL_FORWARD_181 181
QUEUED_182 182
SESSION_PROGRESS_183 183
OK_200 200
ACCEPTED_202 202
MULTIPLE_CHOICE_300 300
MOVED_PERMANENTLY_301 301
MOVED_TEMPORARILY_302 302
SEE_OTHER_303 303
USE_PROXY_305 305
ALTERNATIVE_SERVICE_380 380
BAD_REQUEST_400 400
UNAUTHORIZED_401 401
PAYMENT_REQUIRED_402 402
FORBIDDEN_403 403
NOT_FOUND_404 404
METHOD_NOT_ALLOWED_405 405
NOT_ACCEPTABLE_406 406
AUTHENTICATION_REQUIRED_407 407
REQUEST_TIMEOUT_408 408
CONFLICT_409 409
GONE_410 410
LENGTH_REQUIRED_411 411
CONDITIONAL_REQUEST_FAILED_412 412
REQUEST_TOO_LARGE_413 413
REQUEST_URI_TOO_LONG_414 414
UNSUPPORTED_MEDIA_415 415
UNSUPPORTED_URI_SCHEME_416 416
UNKNOWN_RESOURCE_PRIORITY_417 417

Reason Value
BAD_EXTENSION_420 420
EXTENSION_REQUIRED_421 421
SESSION_INTERVAL_TOO_SMALL_422 422
SESSION_INTERVAL_TOO_SMALL_423 423
ANONYMITY_DISALLOWED_433 433
UNAVAILABLE_480 480
TRANSACTION_NOT_EXIST_481 481
LOOP_DETECTED_482 482
TOO_MANY_HOPS_483 483
ADDRESS_INCOMPLETE_484 484
AMBIGUOUS_485 485
BUSY_486 486
REQUEST_TERMINATED_487
NOT_ACCEPTABLE_HERE_488 488
BAD_EVENT_489 489
REQUEST_PENDING_491 491
UNDECIPHERABLE_493 493
SECURITY_AGREEMENT_NEEDED_494 494
SERVER_INTERNAL_ERROR_500 500
NOT_IMPLEMENTED_501 501
BAD_GATEWAY_502 502
SERVICE_UNAVAILABLE_503 503
SERVER_TIME_OUT_504 504
VERSION_NOT_SUPPORTED_505 505
MESSAGE_TOO_LARGE_513 513
PRECONDITION_FAILURE_580 580
BUSY_EVERYWHERE_600 600
DECLINE_603 603
DOES_NOT_EXIST_ANYWHERE_604 604
NOT_ACCEPTABLE_606 606

A.5.9 Reason (Remote-Party-Id)

page 86).
Table A-17: Enum Reason (RPI)
Reason Value
Busy 1
Immediate 2
No Answer 3
A.5.10 Refresher
These ENUMs are used in the Session-Expires header (see 'Session-Expires' on page 91).
Table A-18: Enum Refresher
Refresher String Value
UAC 1
UAS 2
A.5.11 Screen
These ENUMs are applicable to the Remote-Party-Id (see 'Remote-Party-Id' on page 86)
and Diversion (see 'Diversion' on page 76) headers.
Table A-19: Enum Screen
Screen Value
Yes 1
No 2
A.5.12 ScreenInd
page 86).
Table A-20: Enum ScreenInd
Screen Value
User Provided 0
User Passed 1
User Failed 2
Network Provided 3

A.5.13 TransportType
These ENUMs are applicable to the URL Structure (see 'URL' on page 99) and the Via
header (see 'Via' on page 94).
Table A-21: Enum TransportType
TransportType Value
UDP 0
TCP 1
TLS 2
SCTP 3
A.5.14 Type
These ENUMs are applicable to the URL Structure (see 'URL' on page 99).
Table A-22: Enum Type
Type Value
SIP 1
Tel 2
Fax 3
SIPS 4
A.5.15 Address Presentation Restricted Indicator

These ENUMs are applicable to the phone number handling (see 'ISUP Body Manipulation'
on page 53).
Table A-23: Enum Presentation Restricted Indicator
Presentation Value
Allowed 0
Restricted 1
A.5.16 Transmission Medium Requirement

These ENUMs are applicable to the ISUP handling (see 'ISUP Body Manipulation' on page
53).
Table A-24: Enum Transmission Medium Requirement
Transmission Medium Requirement (TMR) Value
Speech 0
64 kbits/s unrestricted 2

Transmission Medium Requirement (TMR) Value
3.1 kHz audio 3
A.5.17 Charge Indicator

53).
Table A-25: Enum Charge Indicator
Charge Indicator Value
No indication 0
No charge 1
Charge 2
A.5.18 Called Party Status Indicator

53).
Table A-26: Enum Called Party Status Indicator
Called Party Status Indicator Value
No indication 0
Subscriber free 1
A.5.19 Called Party Category Indicator

53).
Table A-27: Enum Called Party Category Indicator
Called Party Category Indicator Value
Ordinary subscriber 0
Test call 40
Priority 41
Payphone 70
No indication 71
A.5.20 Event Information

53).
Table A-28: Enum Event Information
Event Information Value
No INFORMATION 0

Event Information Value
ALERTING 1
PROGRESS 2
In-band information 3
A.5.21 Cause Value

53).
Table A-29: Enum Cause Value
Cause Value
Unallocated number 1
No route to specified transit network 2
No route to destination 3
Send special information tone 4
Misdialled trunk prefix 5
Channel unacceptable 6
Call awarded and being delivered in an established 7
channel
Preemption 8
Preemption – circuit reserved for reuse 9
Normal call clearing 16
User busy 17
No user responding 18
No answer from user (user alerted) 19
Subscriber absent 20
Call rejected 21
Number changed 22
Redirection to new destination 23
Exchange routing error 25
Non-selected user clearing 26
Destination out of order 27
Invalid number format (address incomplete) 28
Facility rejected 29
Response to STATUS ENQUIRY 30
Normal, unspecified 31
No circuit/channel available 34
Network out of order 38
Permanent frame mode connection out of service 39

Cause Value
Permanent frame mode connection operational 40

Temporary failure 41
Switching equipment congestion 42
Access information discarded 43
Requested circuit/channel not available 44
Precedence call blocked 46
Resource unavailable, unspecified 47
Quality of service not available 49
Requested facility not subscribed 50
Outgoing calls barred within CUG 53
Incoming calls barred within CUG 55
Bearer capability not authorized 57
Bearer capability not presently available 58
Inconsistency in designated outgoing access information 62
and subscriber class
Service or option not available, unspecified 63
Bearer capability not implemented 65
Channel type not implemented 66
Requested facility not implemented 69
Only restricted digital information bearer capability is 70
available
Service or option not implemented, unspecified 79
Invalid call reference value 81
Identified channel does not exist 82
A suspended call exists, but this call identity does not 83
Call identity in use 84
No call suspended 85
Call having the requested call identity has been cleared 86
User not member of CUG 87
Incompatible destination 88
Non-existent CUG 90
Invalid transit network selection 91
Invalid message, unspecified 95
Mandatory information element is missing 96
Message type non-existent or not implemented 97
Message not compatible with call state or message type 98
non-existent or not implemented
Information element /parameter nonexistent or not 99

Cause Value
implemented
Invalid information element contents 100
Message not compatible with call state 101
Recovery on timer expiry 102
Parameter non-existent or not implemented, passed on 103
Message with unrecognized parameter, discarded 110
Protocol error, unspecified 111
Interworking, unspecified 127
A.5.22 Cause Location

53).
Table A-30: Enum Cause Location
Location Value
user (U) 0
private network serving the local user (LPN) 1
public network serving the local user (LN) 2
transit network (TN) 3
public network serving the remote user (RLN) 4
private network serving the remote user (RPN) 5
international network (INTL) 7
network beyond interworking point (BI) 10
A.5.23 Redirect Reason

53).
Table A-31: Enum Redirect Reason
Redirect Reason Value
Busy 1
No reply 2
Deflection 4
Deflection Immediate 5
Mobile subscriber not reachable 6
Unconditional 15

A.6 Actions and Types
Table 5-32: Action and Types
Element Comman Command Value Type Remarks

Type d Type
IPGroup Match == String Returns true if the parameter equals to the

value.
!= String Returns true if the parameter not equals to the
value.
contains String Returns true if the string given is found in the
parameter value.
!contains String Returns true if the string given is not found in
the parameter value.
Call- Match == String Returns true if the parameter equals to the
Parameter value.
!= String Returns true if the parameter not equals to the
value.
parameter value.
the parameter value.
Body Match == String Returns true if the body’s content equals to the
value.
!= String Returns true if the body’s content not equals to
the value.
body’s content.
the body’s content.
exists Returns true if this body type exists in the
message.
!exists Returns true if this body type does not exist in
the message.
Action Modify String Modifies the body content to the new value.
Add String Adds a new body to the message.
If such body exists the body content will be
modified.
Remove Removes the body type from the message.
Header- Match == String Returns true if the header’s list equals to the
List *Header-list string.
!= String Returns true if the header’s list not equals to

*Header-list the string.


Type d Type
contains String Returns true if the header’s list contains the

string.
!contains String Returns true if the header’s list does not
contain the string.
exists Returns true if at least one header exists in the
list.
!exists Returns true if no headers exist in the list.
Action Modify String Removes all the headers from the list and
*Header allocates a new header with the given value.
Add String Adds a new header to the end of the list.

*Header
Remove Removes the whole list from the message.
Header Match == String Returns true if a header equals to the value.
*Header The header element must not be a list.
!= String Returns true if a header not equals to the value.

*Header The header element must not be a list.
contains String Returns true if the header contains the string.
!contains String Returns true if the header does not contain the
string.
exists Returns true if the header exists.
!exists Returns true if the header does not exist.
Action Modify String Replaces the entire header with the new value.
*Header
Remove Removes the header from the message, if the
header is part of a list only that header will be
removed.
Add String Adds a new header to the end of the list.

*Header
Parameter Match == String Returns true if the header’s list equals to the
-List Parameter- string.
list
!= String Returns true if the header’s list not equals to
Parameter- the string.
list
contains String Returns true if the header’s list contains the
string.


Type d Type
!contains String Returns true if the header’s list does not

contain the string.
exists Returns true if at least one parameter exists in
the list.
!exists Returns true if the header’s parameter list is
empty.
Action Modify String Replaces the current parameters with the new
Parameter- value.
list
Add String Adds a new parameter to the parameter’s list.
Parameter
Remove Removes all the unknown parameters from the
list.
Parameter Match == String Returns true if the header’s parameter’s value
Parameter equals to the value.
!= String Returns true if the header’s parameter’s value

Parameter not equals to the value.
contains String Returns true if the header’s parameter contains

the string.
!contains String Returns true if the header’s parameter does not
contain the string.
exists Returns true if the header’s parameter exists.
!exists Returns true if the header’s parameter does not
exist.
Action Modify String Sets the header’s parameter to the value.
Parameter
Remove Removes the header’s parameter from the
parameter list.
Structure Match == String Returns true if the header’s structure’s value
*Structure equals to the value.
The string given must be able to be parsed to
the structure.
!= String Returns true if the header’s structure’s value
*Structure not equals to the value.
The string given must be able to be parsed to
the structure.
Action Modify String Sets the header’s structure to the value.
*Structure The string given must be able to be parsed to
the structure.
Integer Match == Integer Returns true if value equals to the integer

element


Type d Type
!= Integer Returns true if value not equals to the integer

element
> Integer Returns true if value is greater than the value.
>= Integer Returns true if value is greater than or equals to

the value.
< Integer Returns true if value is less than the value.
<= Integer Returns true if value is less than or equals to

the value.
Action Modify Integer Sets the integer element to the value.
A string value must be a representation of an
integer.
String Match == String Returns true if the string element equals to the
value.
!= String Returns true if the string element not equals to
the value.
contains String Returns true if the value is found in the string
element.
!contains String Returns true if the value is not found in the
string element.
> String Performs a character by character compare.
Returns true if the ASCII value of the character
is greater than that in the value
>= String Performs a character by character compare.
is greater than or equal to that in the value
< String Performs a character by character compare.
is less than that in the value
<= String Performs a character by character compare.
is less than or equal to that in the value
Action Modify String Sets the string element to the value.
Add prefix String Adds the value to the beginning of the string
element.
Remove String Removes the value from the beginning of the
prefix string element.
Add suffix String Adds the value to the end of the string element.
Remove String Removes the value from the end of the string
suffix element.


Type d Type
Boolean Match == Boolean Returns true if the Boolean element equals to

the value.
Boolean – can be either 0 or 1.
!= Boolean Returns true if the Boolean element not equals

to the value.
> Boolean Returns true if the Boolean element not equals

to the value.
< Boolean Returns true if the Boolean element not equals
to the value.
Action Modify Boolean Sets the Boolean element to the value.

Attribute Match == Integer Returns true if the attribute element equals to

*Attribute the value.
An attribute element value must be of the same
type of the attribute element.
!= Integer Returns true if the attribute element not equals
*Attribute to the value.
An attribute element value must be of the same
Action Modify Integer Sets the attribute element to the value.
*Attribute An attribute element value must be of the same

A.7 Syntax
This section describes the fields of the message manipulation tables:
A.7.1 Message Type

Description: Rule is applied only if this is the message's type
Syntax: <method>.<message role>
 Method:
• Description: Rule is applied only if this is the message's method
• Syntax: token / any
• Examples:
♦ invite, subscribe rule applies only to INVITE messages
♦ unknown unknown methods are also allowed
♦ any no limitation on the method type
 Message role:
• Description: Rule is applied only if this is the message's role
• Syntax: request / response.response-code / any
• Examples:
♦ request rule applies only on requests
♦ response.200 rule applies only on 200 OK messages
♦ any no limitations on the type of the message
 Response code:
• Description: Response code of the message
• Syntax: 1xx / 18x / 2xx / 3xx / 4xx / 5xx / 6xx / 3digit / any
• Examples:
♦ 3xx any redirection response
♦ 18x any 18x response
♦ 200 only 200 OK response
♦ Any any response
Examples:
 invite.request
 invite.response.200
 invite.response.18x
 subscribe.response.2xx
A.7.2 Condition
Description: Matching criteria for the rule
Syntax: (Action Subject / param) SWS match-type [SWS Action Value] * [ SWS logical-
expression SWS Condition ]
Examples:
 header.from.user == '100'
 header.contact.header-param.expires > '3600'
 header.to.host contains 'itsp'
 param.call.dst.user != '100'

 header.john exists
 header.john exists AND header.to.host !contains 'john'
 header.from.user == '100' OR header.from.user == '102' OR header.from.user ==
'300'
 match-type
• Description: Comparison to be made
• Syntax:
♦ == equals
♦ != not equals
♦ > greater than
♦ < less than
♦ >= greater than or equal to
♦ <= less than or equal to
♦ contains does a string contain a value (relevant only to string fields)
♦ exists does a certain header exists
♦ !exists does a certain header not exists
♦ !contains does a string exclude a value. Relevant only to string fields
 logical-expression:
• Description: Condition for the logical expression
• Syntax:
♦ AND logical And
♦ OR logical Or
Note: "A AND B OR C" is calculated as A AND (B OR C).
A.7.3 Action Subject

Description: Element in the message
Syntax: (header / body).Action Subject name [.header-index ] * [.( sub-element / sub-
element-param )]
Examples:
 header.from
 header.via.2.host
 header.contact.header-param.expires
 header.to.uri-param.user-param
 body.application/dtmf-relay
 Action Subject name:

• Description: Name of the message's element - "/" only used for body types
• Syntax: 1 * ( token / "/" )
• Examples:
♦ from (header's name)
♦ to (header's name)
♦ application/dtmf-relay (body's name)
 header-index:
• Description: Header's index in the list of headers
• Syntax: Integer
• Examples: If five Via headers arrive:

♦ 0 (default) refers to first Via header in message

♦ 1 second Via header
♦ 4 fifth Via header
 sub-element:
• Description: Header's element
• Syntax: sub-element-name
• Examples:
♦ user
♦ host
 sub-element-param:
• Description: Header's element
• Syntax: sub-element-name [.sub-element-param-name ]
• Example:
♦ header.from.param.expires
 sub-element-param-name
• Description: Header's parameter name - relevant only to parameter sub-
elements
• Syntax: token
• Examples:
♦ expires (contact's header's param)
♦ duration (retry-after header's param)
♦ unknown-param (any unknown param can be added/removed from the
header)
 param:
• Description: Params can be as values for match and action
• Syntax: param.param-sub-element.param-dir-element.(call-param-entity / ipg-
param-entity)
• Examples:
♦ param.ipg. src.user
♦ param.ipg.dst.host
♦ param.ipg.src.type
♦ param.call.src.user
 param-sub-element:
• Description: Determines whether the param being accessed is a call or an IP
Group
• Syntax:
♦ call relates to source or destination URI for the call
♦ ipg relates to source or destination IP Group
 param-dir-element:
• Description: Direction relating to the classification
• Syntax:
♦ src refers to source
♦ ds refers to destination
 call-param-entity
• Description: Parameters that can be accessed on the call
• Syntax:

♦ user refers to username in request-URI for call

 ipg-param-entity:
• Description: Name of the parameter
• Syntax:
♦ user refers to Contact user in IP Group
♦ host refers to Group Name in IP Group table
♦ type refers to Type field in IP Group table
♦ id refers to IP Group ID (used to identify source or destination IP
Group)
 string:
• Description: String
• Syntax: string enclosed in single apostrophe
• Examples:
♦ 'username
♦ '123'
♦ 'user@host'
 Integer:
• Description: A number
• Syntax: 1 * digit
• Example:
♦ 123
A.7.4 Action Type

Description: Action to be performed on the element
Syntax:
 modify sets element to new value (all element types)
 add-prefix adds value at beginning of string (string element only)
 remove-prefix removes value from beginning of string (string element only)
 add-suffix adds value at end of string (string element only)
 remove-suffix removes value from end of string (string element only)
 add adds a new header/param/body (header or parameter elements)
 remove removes a header/param/body (header or parameter elements)

A.7.5 Action Value

Description: Value for action and match
Syntax: ('string' / Action Subject / param) * (+ ('string' / Action Subject / param))
Examples:
 'itsp.com'
 header.from.user
 param.ipg.src.user
 param.ipg.dst.host + '.com'
 param.call.src.user + '<' + header.from.user + '@' + header.p-asserted-id.host + '>'

International Headquarters
1 Hayarden Street,
Airport City
Lod 7019900, Israel
Tel: +972-3-976-4000
Fax: +972-3-976-4040
AudioCodes Inc.
27 World’s Fair Drive,
Somerset, NJ 08873
Tel: +1-732-469-0880
Fax: +1-732-469-2298
Contact us: https://www.audiocodes.com/

Website: https://www.audiocodes.com/corporate/offices-worldwide
©2018 AudioCodes Ltd. All rights reserved. AudioCodes, AC, HD VoIP, HD VoIP Sounds Better, IPmedia, Mediant,
MediaPack, What’s Inside Matters, OSN, SmartTAP, User Management Pack, VMAS, VoIPerfect, VoIPerfectHD, Your
Gateway To VoIP, 3GX, VocaNom, AudioCodes One Voice and CloudBond are trademarks or registered trademarks of
AudioCodes Limited. All other products or trademarks are property of their respective owners. Product specifications
are subject to change without notice.
Document #: LTRT-29040

Sip Message Manipulation Reference Guide Ver 72

Uploaded by

Copyright:

Available Formats

Sip Message Manipulation Reference Guide Ver 72

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Sip Message Manipulation Reference Guide Ver 72

Uploaded by

Copyright:

Available Formats

Reference Guide

AudioCodes Media Gateways, Session Border Controllers & MSBRs

SIP Message Manipulation,

Version 7.2 3 MSBRs, Gateways & SBCs

4.6.2 Removing Elements from ISUP Body......................................................................59

Reference Guide 4 Document #: LTRT-29040

A.3.6 SIPCapabilities ........................................................................................................98

Version 7.2 5 MSBRs, Gateways & SBCs

Table 3-10: Call Parameter Syntax ........................................................................................................35

Reference Guide 6 Document #: LTRT-29040

Abbreviations and Terminology

Document Revision Record

28631 Initial document release for Version 7.2.

Version 7.2 7 MSBRs, Gateways & SBCs

28646  Updated sections: String Examples (description); Message Parameter Syntax

Reference Guide 8 Document #: LTRT-29040

Message Manipulations Table  Message Type

Version 7.2 9 MSBRs, Gateways & SBCs

This page is intentionally left blank.

Reference Guide 10 Document #: LTRT-29040

2.1.1 Message Type Examples

Message Types Description

invite.request INVITE requests

invite.response.200 INVITE 200 responses only

register.response.2xx All 2xx responses for REGISTER

invite.response.18x All 18x responses for INVITE

subscribe.request All SUBSCRIBE requests

subscribe.response All SUBSCRIBE responses

reinvite.request re-INVITE requests

any.request Requests of all method types, where any is a keyword.

<empty> All request and responses for all method types.

info.any All INFO requests and responses.

private1.request All requests with method 'private1'.

Version 7.2 11 MSBRs, Gateways & SBCs

2.2 Condition Field

2.2.1 Condition Field Operands

Condition Operand Description

== / != Tests for equivalent / not equivalent values.

2.2.2 Condition Field Examples

header.user-agent contains Returns true if the user agent is 'Android-VMAS' or

Reference Guide 12 Document #: LTRT-29040

param.message.sdp.address == Returns true if the "c=" line contains the given IP

header.request- Returns true if the message method type is '415'.

ldap.attr.msRTCSIP-Line contains LDAP Attribute contains three values, which are

2.3 Action Subject Field

2.3.1 Action Subject Field Examples

Action Subject Action Action Value Description

header.cust Add 'Audiocode Adds the "customername" header to

var.global. Modify header.use Stores the content of the User-agent

Version 7.2 13 MSBRs, Gateways & SBCs

2.4 Action Type Field

Action Operand Description

Add Adds entities to a message.

2.5 Action Value Field

2.5.1 Action Value Field Examples

Action Subject Action Action Value Description

header.custom Add 'ABCompany' Adds the "customername" header to the

header.custom Remove Deletes the header "customername" from