Page History
REST API Method: PUT /rest/spmmessagetable/{identifier}/spmheaderrule/{identifier}
| Page Tree | ||
|---|---|---|
|
Creates a Header Rule Table Entry given a specific Table Entry ID in a given Message Table. The ID must be within the range 1 through 1000. The Element Descriptors associated with the Header Rule need to be created before creating the Header Rule. The Element Descriptors IDs must be unique across all SIP Manipulation Rules.
URL:
https://134.56.227.163/rest/spmmessagetable/{identifier}/spmheaderrule/{identifier}
HTTP Method
PUT
Requires Authentication:
true
Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| Description | No | No | string | none | 64 - Max Length | Description of Header Rule |
| ConditionExpression | No | No | string | none | 255 - Max Length | Logical expression, including Condition Rule references, the logical operators && and ||, and parenthesis grouping. If the condition evaluates true then this header rule will be applied, otherwise it will not. Condition rule references are of the form ${n}, where 'n' is the row ID of the condition rule. If no logical expression is provided then the expression is evaluated as 'true'. |
| ResultType | Yes | No | Enum | 1 | Possible values:
| Specifies the result type of the current rule to go on to the next rule. If eRtMandatory, and this rule fails, all other rules in this message table will be dropped. If eRtOptional, then continue to the next rule unconditionally. |
| HeaderName | Yes | No | The SIP header name. | |||
| HeaderOrdinal | Yes | No | int | 1 | Possible values:
| Where a message contains multiple headers of the same name, this specifies the ordinal position of the header being referred to by the rule. 0 indicates the rule applies to all headers of the same name. A positive number indicates the ordinal position of the header from the front, for example 2 means the second header of that name. A negative number indicates the ordinal position of the header from the back, for example -3 means the third-from-last header of that name. |
| HeaderAction | Yes | No | Enum | 1 | Possible values:
| Indicates the action to take on the header as a whole. Supported values and their meaning are: Add - if the header is present then it is passed-through, otherwise it is added. Modify - if the header is present then it is modified, otherwise no action is taken. Remove - if the header is present then it is removed, otherwise no action is taken. The values of "CopyValue", "Ignore", and "DrillDown" don't apply at the header identification level. |
| HeaderElementDescriptorList | No | No | string | none | 300 - Max Length | This is a comma-separated list of the element descriptor row IDs which are part of this header rule. There is a maximum of 50 members. There is no significance to the sequence of IDs in this list. |
| HeaderParameterElementDescriptorList | No | No | string | none | 60 - Max Length | This is a comma-separated list of the element descriptor row IDs which are header parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant. |
| URIParameterElementDescriptorList | No | No | string | none | 60 - Max Length | This is a comma-separated list of the element descriptor row IDs which are URI parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant. |
| URIUserParameterElementDescriptorList | No | No | string | none | 60 - Max Length | This is a comma-separated list of the element descriptor row IDs which are URI User parameters associated with this header rule. There is a maximum of 5 members. The sequence of this list is significant. |
Usage Example: (about cURL | requires a session token)
| Code Block | ||
|---|---|---|
| ||
Put code example here |
Response:
| Code Block | ||
|---|---|---|
| ||
Put Code response here |
Overview
Content Tools