SIP Message Manipulation, Conditions and Call Setup Rules

1 reference guide AudioCodes Media Gateways, Session Border Controllers & MSBRs SIP Message Manipulation, Conditions and Call Setup Rules Version Version 3 MSBRs, Gateways & SBCs reference guide Contents Table of Contents 1 Introduction .. 9 2 Field Syntax .. 11 Message Type Field .. 11 Message Type Examples .. 11 Condition Field .. 12 Condition Field Operands .. 12 Condition Field Examples .. 12 Action Subject Field .. 13 Action Subject Field Examples .. 13 Action Type Field .. 14 Action Value Field .. 14 Action Value Field Examples .. 14 3 Detailed Syntax .. 15 Strings .. 15 String Examples .. 16 Headers .. 17 Detailed Header Syntax .. 17 Header Examples .. 27 Body .. 29 Body Examples .. 29 Parameters .. 30 Message Parameter Syntax .. 30 IP Groups Table Parameter Syntax .. 33 Call Parameter Syntax.

2 35 Parameter Examples .. 35 Example for IP Group Keep-Alive ..37 4 Advanced Manipulation Features .. 39 Wildcards for Header Removal .. 39 Random Characters .. 39 SDP Body Fields .. 40 Source IP Address .. 40 RTP Mode .. 41 Origin Username .. 41 Origin IP Address .. 41 Port .. 41 IP Address .. 42 SDP Examples .. 42 Regular Expressions (Regex) .. 44 Regex Basic Examples .. 45 Regex Detailed Examples .. 46 Variables for Copying Data between Messages .. 49 Call Variable .. 49 Global Variable .. 50 Session Variable .. 51 Registered User 51 ISUP Body Manipulation .. 53 Attaching ISUP Body .. 59 reference guide 4 Document #: LTRT-29040 SIP Message Manipulation, Conditions & CSRs Removing Elements from ISUP Body .. 59 ISUP Examples .. 60 ISUP Deny Message Condition Rule ..60 ISUP Message Manipulation Rules .

3 61 Special Actions using X-AC-Action SIP Header .. 62 SIP Message Normalization .. 64 Source and Destination Dial Plan Tags .. 67 ENUM Queries .. 67 SIP URIs and LDAP Queries for Microsoft Skype Presence Feature .. 69 5 Typical Examples .. 71 A Message Manipulation Syntax reference .. 73 Action Type .. 73 Header Types .. 73 Accept .. 73 Accept-Language .. 74 Allow .. 74 Call-Id .. 75 75 Cseq .. 76 Diversion .. 76 Event .. 77 From .. 78 History-Info .. 78 Min-Se and Min-Expires .. 79 P-Asserted-Identity .. 80 P-Associated-Uri .. 80 P-Called-Party-Id .. 81 P-Charging-Vector .. 82 P-Preferred-Identity .. 82 Privacy .. 83 Proxy-Require .. 83 84 Referred-By .. 85 Refer-To .. 85 Remote-Party-Id .. 86 Request-Uri .. 87 Require .. 88 Resource-Priority .. 89 Retry-After .. 89 Server or User-Agent.

4 90 Service-Route .. 90 Session-Expires .. 91 Subject .. 92 Supported .. 92 To .. 93 Unsupported .. 94 Via .. 94 Warning .. 95 Unknown Header .. 96 Structure Definitions .. 97 Event Structure .. 97 Host .. 97 MLPP .. 97 Privacy Struct .. 98 Reason Structure .. 98 Version 5 MSBRs, Gateways & SBCs reference guide Contents SIPC apabilities .. 98 URL .. 99 Random Type .. 100 Random Strings ..100 Random Integers .. 100 Enum Definitions .. 101 AgentRole ..101 Event Package ..101 MLPP Reason Type ..102 Number Plan ..102 Number Type ..102 Privacy ..103 Reason (Diversion) ..103 Reason (Reason Structure) ..103 Reason (Remote-Party-Id) ..106 Refresher ..106 ScreenInd ..106 TransportType ..107 Type ..107 Address Presentation Restricted Indicator ..107 Transmission Medium Requirement ..107 Charge Indicator.

5 108 Called Party Status Indicator ..108 Called Party Category Indicator ..108 Event Information .. 108 Cause Value ..109 Cause Location ..111 Redirect Reason .. 111 Actions and Types .. 112 Syntax .. 117 Message Type ..117 Condition ..117 Action Subject ..118 Action Type ..120 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.

6 27 Table 3-6: Message Body Syntax 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 reference guide 6 Document #: LTRT-29040 SIP Message Manipulation, Conditions & CSRs 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.

7 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 97 Table A-5: Privacy 98 Table A-6: Reason Structure .. 98 Table A-7: SIPC apabilities 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).

8 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 Version 7 MSBRs, Gateways & SBCs 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.

9 Updates to this document can be downloaded from 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 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 28632 Attaching ISUP to SIP Message body; Additional ISUP Backward Call Indicator fields; <src/dst>.

10 Sipinterface; Special Actions using X-AC-Action SIP Header; Source and Destination Dial Plan Tags. 28633 ISUP syntax typos corrected (" " 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 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 ( , , <tag name>, <tag name>, , ); Parameter Examples; ; SDP Examples; Regex updated; ISUP Body Manipulation (Access transport / User service information; SIP URIs for Microsoft Skype Presence Feature reference guide 8 Document #: LTRT-29040 SIP Message Manipulation, Conditions & CSRs LTRT Description 28646 Updated sections: String Examples (description); Message Parameter Syntax (descriptions); Special Actions using X-AC-Action SIP Header; Warning New syntax: ; ; ; Updated syntax: <src/dst>.)