Replace a config element: SD.sip-manipulation
put
https://cloud-native-SBC-IP/config/v1/sd/sip-manipulation/{ElementKey}
Replace a config element: SD.sip-manipulation
Request
Path Parameters
-
ElementKey: string
Identifier for the element
Supported Media Types
- application/json
Root Schema : schema
Type:
object
configure SIP manipulations
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
cfg-order: object
SipManipOrderEntry
order of sip manipulation rules
-
description: string
brief description of what the set of header rules is doing
-
header-rules: array
header-rules
list of header rules
-
join-headers: array
join-headers
Unique Items Required:
true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via -
mime-isup-rules: array
mime-isup-rules
list of mime isup rules
-
mime-rules: array
mime-rules
list of mime rules
-
mime-sdp-rules: array
mime-sdp-rules
list of mime sdp rules
-
name(required): string
Minimum Length:
1
Pattern:^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
sip-manipulation list name -
split-headers: array
split-headers
Unique Items Required:
true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Nested Schema : SipManipOrderEntry
Type:
object
order of sip manipulation rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
rules-order: array
rules-order
list of header,mime,mime-isup and mime-sdp rules
Nested Schema : header-rules
Type:
array
list of header rules
Show Source
-
Array of:
object SipHdrRule
list of header rules
Nested Schema : join-headers
Type:
array
Unique Items Required:
true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : mime-isup-rules
Type:
array
list of mime isup rules
Show Source
-
Array of:
object MimeIsupRule
list of mime isup rules
Nested Schema : mime-rules
Type:
array
list of mime rules
Show Source
-
Array of:
object MimeRule
list of mime rules
Nested Schema : mime-sdp-rules
Type:
array
list of mime sdp rules
Show Source
-
Array of:
object MimeSdpRule
list of mime sdp rules
Nested Schema : split-headers
Type:
array
Unique Items Required:
true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : rules-order
Type:
array
list of header,mime,mime-isup and mime-sdp rules
Show Source
Nested Schema : SipHdrRule
Type:
object
list of header rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
element-rules: array
element-rules
list of element-rules
-
header-name: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
header name for which rule needs to be applied -
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL -
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : element-rules
Type:
array
list of element-rules
Show Source
-
Array of:
object SipElemRule
list of element-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
Show Source
-
Array of:
string
Allowed Values:
[ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : SipElemRule
Type:
object
list of element-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-val-type: string
Allowed Values:
[ "any", "ip", "fqdn" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
parameter-name: string
element param name for which rule needs to be applied
-
type: string
Allowed Values:
[ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : MimeIsupRule
Type:
object
list of mime isup rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
content-type: string
Pattern:
^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
Content-Type header for which rule needs to be applied -
isup-msg-types: array
isup-msg-types
Unique Items Required:
true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM -
isup-param-rules: array
isup-param-rules
list of isup-param-rules
-
isup-spec: string
Allowed Values:
[ "ansi-2000", "itu-99", "gr-317", "etsi-356", "spirou" ]
-
match-value: string
>value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
rules-order: array
rules-order
list of mime-header and isup-param rules
Nested Schema : isup-msg-types
Type:
array
Unique Items Required:
true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
Show Source
Nested Schema : isup-param-rules
Type:
array
list of isup-param-rules
Show Source
-
Array of:
object IsupParamRule
list of isup-param-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : IsupParamRule
Type:
object
list of isup-param-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
format: string
Allowed Values:
[ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
-
match-value: string
value to match against the current object. To clear the match-value, update with an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. To clear the newValue, update with an empty string
-
type: string
Pattern:
^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$
parameter type specifying which part of the isup body will be manipulated
Nested Schema : MimeHeaderRule
Type:
object
list of mime-header-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
mime-header-name: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue -
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : MimeRule
Type:
object
list of mime rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
content-type: string
Pattern:
^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
Content-Type header for which rule needs to be applied -
format: string
Allowed Values:
[ "ascii-string", "hex-ascii", "binary-ascii" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes(e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
-
Array of:
string
Allowed Values:
[ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : MimeSdpRule
Type:
object
list of mime sdp rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
rules-order: array
rules-order
list of mime-header ,sdp-session and sdp-media rules
-
sdp-media-rules: array
sdp-media-rules
list of sdp-media-rules
-
sdp-session-rules: array
sdp-session-rules
list of sdp-session-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : rules-order
Type:
array
list of mime-header ,sdp-session and sdp-media rules
Show Source
Nested Schema : sdp-media-rules
Type:
array
list of sdp-media-rules
Show Source
-
Array of:
object SdpMediaRule
list of sdp-media-rules
Nested Schema : sdp-session-rules
Type:
array
list of sdp-session-rules
Show Source
-
Array of:
object SdpSessionRule
list of sdp-session-rules
Nested Schema : SdpMediaRule
Type:
object
list of sdp-media-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
media-type: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
media type to manipulate (e.g. audio, video, etc.) -
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
sdp-line-rules: array
sdp-line-rules
list of sdp-line-rules
Nested Schema : sdp-line-rules
Type:
array
list of sdp-line-rules
Show Source
-
Array of:
object SdpLineRule
list of sdp-line-rules
Nested Schema : SdpLineRule
Type:
object
list of sdp-line-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
type: string
Pattern:
^[A-Za-z](\[(([0-9]+)|([*^]))\])?$
descriptor type specifying which line of the sdp will be manipulated
Nested Schema : SdpSessionRule
Type:
object
list of sdp-session-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
sdp-line-rules: array
sdp-line-rules
list of sdp-line-rules
Nested Schema : sdp-line-rules
Type:
array
list of sdp-line-rules
Show Source
-
Array of:
object SdpLineRule
list of sdp-line-rules
Response
Supported Media Types
- application/json
200 Response
return one config element: SipManipulation
Root Schema : schema
Type:
object
configure SIP manipulations
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
cfg-order: object
SipManipOrderEntry
order of sip manipulation rules
-
description: string
brief description of what the set of header rules is doing
-
header-rules: array
header-rules
list of header rules
-
join-headers: array
join-headers
Unique Items Required:
true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via -
mime-isup-rules: array
mime-isup-rules
list of mime isup rules
-
mime-rules: array
mime-rules
list of mime rules
-
mime-sdp-rules: array
mime-sdp-rules
list of mime sdp rules
-
name(required): string
Minimum Length:
1
Pattern:^[A-Za-z0-9_][A-Za-z0-9._\-]{0,127}$
sip-manipulation list name -
split-headers: array
split-headers
Unique Items Required:
true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Nested Schema : SipManipOrderEntry
Type:
object
order of sip manipulation rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
rules-order: array
rules-order
list of header,mime,mime-isup and mime-sdp rules
Nested Schema : header-rules
Type:
array
list of header rules
Show Source
-
Array of:
object SipHdrRule
list of header rules
Nested Schema : join-headers
Type:
array
Unique Items Required:
true
list of headers to be joined into a single, comma separated header. Joining of headers occurs after execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : mime-isup-rules
Type:
array
list of mime isup rules
Show Source
-
Array of:
object MimeIsupRule
list of mime isup rules
Nested Schema : mime-rules
Type:
array
list of mime rules
Show Source
-
Array of:
object MimeRule
list of mime rules
Nested Schema : mime-sdp-rules
Type:
array
list of mime sdp rules
Show Source
-
Array of:
object MimeSdpRule
list of mime sdp rules
Nested Schema : split-headers
Type:
array
Unique Items Required:
true
list of headers to be split and treated as separate headers. Splitting of headers occurs prior to the execution of any manipulation rules e.g. Diversion,Route,Via
Show Source
Nested Schema : rules-order
Type:
array
list of header,mime,mime-isup and mime-sdp rules
Show Source
Nested Schema : SipHdrRule
Type:
object
list of header rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
element-rules: array
element-rules
list of element-rules
-
header-name: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
header name for which rule needs to be applied -
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL -
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : element-rules
Type:
array
list of element-rules
Show Source
-
Array of:
object SipElemRule
list of element-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified). For e.g.: INVITE,ACK,CANCEL
Show Source
-
Array of:
string
Allowed Values:
[ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : SipElemRule
Type:
object
list of element-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete-element", "delete-header", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-val-type: string
Allowed Values:
[ "any", "ip", "fqdn" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
parameter-name: string
element param name for which rule needs to be applied
-
type: string
Allowed Values:
[ "none", "header-value", "header-param", "uri-param", "uri-header", "uri-user", "uri-host", "uri-port", "uri-user-param", "teluri-param", "uri-display", "uri-param-name", "uri-header-name", "header-param-name", "status-code", "reason-phrase", "mime", "uri-user-only", "uri-phone-number-only" ]
Nested Schema : MimeIsupRule
Type:
object
list of mime isup rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
content-type: string
Pattern:
^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
Content-Type header for which rule needs to be applied -
isup-msg-types: array
isup-msg-types
Unique Items Required:
true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM -
isup-param-rules: array
isup-param-rules
list of isup-param-rules
-
isup-spec: string
Allowed Values:
[ "ansi-2000", "itu-99", "gr-317", "etsi-356", "spirou" ]
-
match-value: string
>value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
rules-order: array
rules-order
list of mime-header and isup-param rules
Nested Schema : isup-msg-types
Type:
array
Unique Items Required:
true
specifies a list of isup message types that the mime isup rule applies to (applies to all ISUP messages when none are specified) e.g.: IAM, ACM
Show Source
Nested Schema : isup-param-rules
Type:
array
list of isup-param-rules
Show Source
-
Array of:
object IsupParamRule
list of isup-param-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to (applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : IsupParamRule
Type:
object
list of isup-param-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
format: string
Allowed Values:
[ "raw-binary", "hex-ascii", "bcd", "binary-ascii", "ascii-string", "number-param" ]
-
match-value: string
value to match against the current object. To clear the match-value, update with an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. To clear the newValue, update with an empty string
-
type: string
Pattern:
^((25[0-5])|(2[0-4][0-9])|(1[0-9][0-9])|([0-9]([0-9])?))(\[([*^]|[0-9]+)\])?$
parameter type specifying which part of the isup body will be manipulated
Nested Schema : MimeHeaderRule
Type:
object
list of mime-header-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
mime-header-name: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
header within mime part for which rule needs to be applied. To change the preamble of a SIP body, use the header name @preamble. To change the epilogue of a SIP body, use the header name @epilogue -
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : MimeRule
Type:
object
list of mime rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
content-type: string
Pattern:
^[A-Za-z0-9.!%*_+`'~/-]+(;.+)*(\[(([0-9]+)|([*^]))\])?$
Content-Type header for which rule needs to be applied -
format: string
Allowed Values:
[ "ascii-string", "hex-ascii", "binary-ascii" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes(e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
-
Array of:
string
Allowed Values:
[ "INVITE", "ACK", "BYE", "CANCEL", "REGISTER", "OPTIONS", "PRACK", "SUBSCRIBE", "NOTIFY", "PUBLISH", "INFO", "REFER", "MESSAGE", "UPDATE" ]
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : MimeSdpRule
Type:
object
list of mime sdp rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "store", "sip-manip", "find-replace-all", "reject", "log", "monitor" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
methods: array
methods
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL -
mime-header-rules: array
mime-header-rules
list of mime-header-rules
-
msg-type: string
Allowed Values:
[ "any", "request", "reply", "out-of-dialog" ]
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
rules-order: array
rules-order
list of mime-header ,sdp-session and sdp-media rules
-
sdp-media-rules: array
sdp-media-rules
list of sdp-media-rules
-
sdp-session-rules: array
sdp-session-rules
list of sdp-session-rules
Nested Schema : methods
Type:
array
Unique Items Required:
true
specifies list of methods that the rule applies to(applies to all methods when none are specified) e.g.: INVITE,ACK,CANCEL
Show Source
Nested Schema : mime-header-rules
Type:
array
list of mime-header-rules
Show Source
-
Array of:
object MimeHeaderRule
list of mime-header-rules
Nested Schema : rules-order
Type:
array
list of mime-header ,sdp-session and sdp-media rules
Show Source
Nested Schema : sdp-media-rules
Type:
array
list of sdp-media-rules
Show Source
-
Array of:
object SdpMediaRule
list of sdp-media-rules
Nested Schema : sdp-session-rules
Type:
array
list of sdp-session-rules
Show Source
-
Array of:
object SdpSessionRule
list of sdp-session-rules
Nested Schema : SdpMediaRule
Type:
object
list of sdp-media-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
media-type: string
Pattern:
^@status-line$|^[A-Za-z0-9@.!%*_+`'~-]+(\[(([0-9]+)|([*^]))\])?$
media type to manipulate (e.g. audio, video, etc.) -
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
sdp-line-rules: array
sdp-line-rules
list of sdp-line-rules
Nested Schema : sdp-line-rules
Type:
array
list of sdp-line-rules
Show Source
-
Array of:
object SdpLineRule
list of sdp-line-rules
Nested Schema : SdpLineRule
Type:
object
list of sdp-line-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "store", "sip-manip", "replace", "find-replace-all", "delete", "log", "monitor", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
type: string
Pattern:
^[A-Za-z](\[(([0-9]+)|([*^]))\])?$
descriptor type specifying which line of the sdp will be manipulated
Nested Schema : SdpSessionRule
Type:
object
list of sdp-session-rules
Show Source
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
action: string
Allowed Values:
[ "none", "add", "delete", "manipulate", "replace", "store", "sip-manip", "find-replace-all", "log", "reject" ]
-
comparison-type: string
Allowed Values:
[ "case-sensitive", "case-insensitive", "pattern-rule", "refer-case-sensitive", "refer-case-insensitive", "boolean" ]
-
match-value: string
value to match against the current object. To clear the match-value, enter an empty string
-
name(required): string
Minimum Length:
1
Pattern:^(([a-z][A-Za-z0-9_]+)|([A-Z][A-Za-z0-9_]*[a-z][A-Za-z0-9_]*))$
unique name for rule -
new-value: string
new value for the object. Quoted display names must be escaped within quotes (e.g. '\\'My Name\\' '). To clear the new-value, enter an empty string
-
sdp-line-rules: array
sdp-line-rules
list of sdp-line-rules
Nested Schema : sdp-line-rules
Type:
array
list of sdp-line-rules
Show Source
-
Array of:
object SdpLineRule
list of sdp-line-rules
404 Response
Not Found
Root Schema : ApiValidationError
Type:
Show Source
object
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
code: string
-
errors: array
errors
-
message: string
-
timestamp: string
Nested Schema : Errors
Type:
Show Source
object
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
attribute: string
-
code: string
-
message: string
-
type: string
Allowed Values:
[ "error", "fatal", "warn" ]
406 Response
Validation Failure
Root Schema : ApiValidationError
Type:
Show Source
object
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
code: string
-
errors: array
errors
-
message: string
-
timestamp: string
Nested Schema : Errors
Type:
Show Source
object
-
_elementKey: string
Read Only:
true
Identifier for the element or sub-element -
attribute: string
-
code: string
-
message: string
-
type: string
Allowed Values:
[ "error", "fatal", "warn" ]