SIP Variant Sub-field Descriptions

Sub-Field 1

Protocol Variant (String up to 16 characters, for example, "SIP or SIP-T")

Sub-Field 2

Call ID (variable length string up to 256 characters, for example: 44-871244022@sylcs.rbbn.com).

Sub-Field 3

From Field (variable length string up to 256 characters, for example: 3211941116@10.99.55.6)

Sub-Field 4

To Field (variable length string up to 256 characters, for example: 2971612002@10.20.9.73)

Sub-Field 5

Redirect Attempt Count (number of times that the call was redirected before being connected, a decimal number 0-255)

• Max length: 3

Sub-Field 6

Reserved (The field is empty in case of SIP.)

NOTE: SIP-I/T Version String (variable length string of up to 23 characters, which contains the MIME version, for example "itu-t92+".

Sub-Field 7

Display name of SIP URI PAI header. This field is presented in ISUP signaling messages received at the gateway, such as IAM, SGM, etc. The content details the reason that the caller number (or "caller identification") was not provided and displayed.

• Max length: Variable length up to 47 characters, or empty
• Field type: String

Example strings are "Unavailable", "Anonymous", "Coin line", or "payphone".

Sub-Field 8

User parameter of P-K-CallForwardingLast header (variable length string of up to 24 characters, or empty).

This field is presented in ISUP messages received at the gateway such as IAM, SGM, etc. The content is the username information that is in the P-K-CallForwardingLast header "u=" parameter of the INVITE. Example strings are "john_doe", "joe1234", and "987654321".

Sub-Field 9

Userinfo and Hostname of SIP request URI header (variable length string of up to 256 characters or empty).

The content is the username and hostname fields of the Request URI of the initial SIP INVITE message. Example strings are "sip:john@somewhere.com", "sip:joe123@4.3.2.1", "sip:987654321@anywhere.com", "sip:+1987654321@3.4.5.6;dtg=sip", and "tel:987654321".

If a comma (,) occurs within this sub-field, then the escape sequence "%2C" will replace the comma. For example:
"sip:1234567890;isub=1234,5678@AN.7.11.186:port"

is rendered as:

"sip:1234567890;isub=1234%2C5678@AN.7.11.186:port"

If a percent symbol (%) occurs within this sub-field, then the escape sequence "%25" replaces the percent symbol itself.

NOTE: If FQDN is used by the SBC when processing the call, this field may not contain the actual Request URI of the initial SIP INVITE message. It may contain an FQDN value in place of an IP address.

Sub-Field 10

Userinfo and Hostname of SIP URI PAI header (variable length string of up to 128 characters or empty).

The content is the username and hostname fields of the P-Asserted-Id (PAI) header that is in SIP URI address scheme of the initial SIP INVITE message. Example strings are "john@somewhere.com", "joe123@4.3.2.1", "987654321@anywhere.com", and "+1987654321@3.4.5.6".

Sub-Field 11

Username parameter of the Proxy-Authorization header (variable length string of up to 20 characters or empty).

The content is the "username=" parameter value of the Proxy-Authorization header contained in the initial SIP INVITE message. Example strings are "tst1234", "janedoe", and "7654321".

Sub-Field 12

Displayname of Tel URI PAI header (variable length string of up to 11 characters or empty).

The content is the display name of the P-Asserted-Id (PAI) header that is in Tel URI address scheme of the initial SIP INVITE message. Example strings are "9876543210", and "05030450095".

Sub-Field 13

INVITE Contact header (variable length string of up to 128 characters or empty).

The content is the Contact header of the initial SIP INVITE message. Example strings are "sip:john@somewhere.com:5060", "sip:john@somewhere.com:5060;transport=udp", "sip:joe123@4.3.2.1:5060;transport=udp", "sip:987654321@anywhere.com:5060;transport=udp", "sip:+1987654321@3.4.5.6:5060;transport=udp", "sip:10.192.168.70:5060", and "sip:10.192.168.70:5060;transport=udp".

Sub-Field 14

200 OK INVITE Contact header (variable length string of up to 128 characters or empty).

The content is the Contact header of the 200 OK response to the initial SIP INVITE message. Example strings are "sip:john@somewhere.com:5060", "sip:john@somewhere.com:5060;transport=udp", "sip:joe123@4.3.2.1:5060;transport=udp", "sip:987654321@anywhere.com:5060;transport=udp", "sip:+1987654321@3.4.5.6:5060;transport=udp", "sip:10.192.168.70:5060", and "sip:10.192.168.70:5060;transport=udp".

Sub-Field 15

Redirecting Reason parameter of P-K CallForwardOriginal header (variable length of up to 4 characters or empty).

The content is the redirecting reason value of "r=" parameter in the P-K-CallForwardOriginal header of the SIP INVITE message. Example strings are "cfb", "cfnr", "cfu", "cda", "cdi", and "msnr".

Sub-Field 16

Username of Tel URI PAI header (variable length string of up to 127 characters or empty).

The content is the username of P-Asserted-Id (PAI) header that is in Tel URI address scheme of the initial SIP INVITE message. Example strings are "9876543210", and "+8105030450095", etc.

Sub-Field 17

The contractor number value in the "cntrct=" parameter of the "P-Sig-Info" header that is sent or received in the SIP INVITE message (variable length string of up to 16 characters or empty).
Example strings are "0311112222" and "9876543210654321".

Sub-Field 18

ACK received for 200 OK (1 decimal Value enumeration or empty)

This field specifies whether a SIP ACK message was received in response to a SIP 200 OK message. When the SIP 200 message is sent, the START record has already been generated. However, the A party has not picked up the SIP phone until this message is received.

The valid values are:

Sub-Field 19

Status Message For Call Release (3 characters or empty)

This field specifies the SIP message received to cause release or transmitted in response to release on this call leg. Used in combination with the disconnect initiator field (#57), you can determine if this message was sent or received on this call leg. For internally disconnected calls, both legs are transmitting the message specified for that leg.

The valid values are:

Sub-Field 20

Reason Header Value Q850 (variable length string of up to 3 decimal characters or empty) This field specifies the Reason Header value that was sent or received in a SIP message.

The valid values are:

Note: You may observe that this is field is present even if the reason header is not sent.

Sub-Field 21

NAPT Status of the SIP Service Group for Signaling (1 decimal character enumeration or empty)

This field contains the NAPT status of the SIP service group for signaling.

The valid values are:

Sub-Field 22

NAPT Status of the SIP Service Group for Media (1 decimal character enumeration or empty)

This field contains the NAPT status of the SIP service group for media.

The valid values are:

Sub-Field 23

Original Peer SDP Address for NAPT or ICE (variable length string up to 15 characters or empty)

This field contains the original peer SDP IP address, in dotted decimal format, received in the SDP from the peer when NAPT is enabled. This field is empty if original peer SDP address is not available or if media is NAPT disabled.

An example string is 123.14.15.16

Sub-Field 24

UUI Sending Count (variable length string of up to 2 decimal characters or empty)

This field contains the number of UUI parameters sent from the a-party. This data comes from the incoming SIP messages INVITE, 18X, 4XX, 5XX, 6XX, BYE, CANCEL, and 200 OK. On the PSX, the IP PROFILE must have the UUI parameter enabled for SIP.

The valid values are:

Sub-Field 25

UUI Receiving Count (variable length string of up to 2 decimal characters or empty.

This field contains the number of UUI parameters sent from the a-party. This data comes from the incoming SIP messages INVITE, 18X, 4XX, 5XX, 6XX, BYE, CANCEL, and 200 OK. On the PSX, the IP PROFILE must have the UUI parameter enabled for SIP.

The valid values are:

Sub-Field 26

Service Information (3 decimal character enumeration or empty).

This field contains service related information associated with the call. This field was initially added to carry the DPNSS Ring Back When Free service information. This field is populated from the received INVITE message.

The valid values are:

Sub-Field 27

ICID (variable length string of up to 127 characters or empty).

This field is a unique string used to identify a session. For ingress Protocol Variant Specific Data fields (PVSD), this field is populated from the "icid-val" parameter of the P-Charging-Vector header from the received INVITE message. This field is empty if the incoming INVITE does not contain the P-Charging-Vector header. For egress PVSD, this field is populated from the "icid-val" parameter of the P-Charging-Vector header from the INVITE message that is sent. This field is empty if the "Creating P-Charging-Vector" flag and the "Transparent P-Charging-Vector" flag of the PSX IP Signaling Profile are both false.

An example string is "3cbed620-0001-1000-00-0000-10-6b-00-02-20".

Sub-Field 28

Generated Host (variable length string of up to 127 characters or empty).

This field indicates the node at which the "icid-val" parameter of the P-Charging-Vector header was generated. For ingress PVSD, this field is populated from the "icid-generated-at" parameter of P-Charging-Vector header from the received INVITE message. This field is empty if the received INVITE does not contain the P-Charging-Vector header. For egress PVSD, this field is populated from "icid-generated-at" parameter of P-Charging-Vector header from the INVITE message that is sent. This field is empty if the "Creating P-Charging-Vector" flag and the "Transparent P-Charging-Vector" flag of the PSX IP Signaling Profile are both false.

An example string is 10.10.10.10.

Sub-Field 29

Originating IOI (variable length string of up to 127 characters or empty).

This field identifies the network that originated the SIP dialog. For ingress PVSD, this field is populated from the "orig-ioi" parameter of the P-Charging-Vector header from the received INVITE message. This field is empty if the received INVITE does not contain the P-Charging-Vector header. For egress PVSD, this field is populated from the "orig-ioi" parameter of the P-Charging-Vector header from the backwards response received or from the INVITE message that is sent. This field is empty if the backward response or the INVITE message that is sent does not contain the "orig-ioi" parameter in the P-Charging-Vector header.

An example string is home1.net.

Sub-Field 30

Terminating IOI (variable length string of up to 127 characters or empty).

This field identifies the network that terminated the SIP dialog. For ingress PVSD, this field is populated from the "term-ioi" parameter of the P-Charging-Vector header from the received INVITE message. This field is empty if the received INVITE does not contain the P-Charging-Vector header. For egress PVSD, this field is populated from the "term-ioi" parameter of the P-Charging-Vector header from the backwards response received or the INVITE message that is sent. This field is empty if the backward response or the INVITE message that is sent does not contain the "term-ioi" parameter in the P-Charging-Vector header.

An example string is dest.net.

Sub-Field 31

Special Routing Table Number in the P-K-Adn Header (variable length string of up to 30 alphanumeric or + characters or empty).

This field contains the Special Routing Table Number which is sent in theP-K-Adn header.

An example string is "01793601014".

Sub-Field 32

IP Address for FQDN calls or IP address of route header selected as next hop (variable length string of up to 15 characters or empty).

An example string is 123.14.15.16.

Sub-Field 33

Transport Protocol – The Transport Protocol used to set up the SIP call.

• Max length: 1
• Field type: Decimal

The valid values are:

Sub-Field 34

Direct Media Call. This field contains "1" if direct media has been used on the call leg, otherwise "0" (media flow is through the SBC).

• Max length: 1
• Field type: Boolean

NOTE: When a call is established as an ICE direct media call, SBC does not support media handling. Therefore, the existing CDR fields are populated for Ingress and Egress local IP address/ports as 255.255.255.255/65535 and Ingress and Egress remote IP address/ports as 127.0.0.0/5004 for each of the media streams on the call.

Sub-Field 35

Inbound SMM Indicator. This field contains the inbound SIP Message Manipulation status.

• Max length: 1
• Field type: Decimal

 The valid values for this field are:

Sub-Field 36

Outbound SMM Indicator. This field contains the outbound SIP Message Manipulation status.

• Max length: 1
• Field type: Decimal
  
  

The valid values are

Originating Charge Area 

• Max length: 5
• Field Type:String of exactly 5 characters

The valid values are:

• • 00000-99999
  • empty

Terminating Charge Area

• Max length: 5
• Field Type:String of exactly 5 characters
  
  The valid values are:
  • 00000-99999
  • empty
    
    

Feature Tag in Contact Header

• Max length: 200

Feature Tag in Accept-Contact Header

• Max length: 200

Sub-Field 41

P-Charging-Function-Address

• Max length: 1024
• Field type: “String"

Sub-Field 42

P-Called-Party-Id

• Max length: 129
• Field type: "String

Sub-Field 43

P-Visited-Network-Id

• Max length: 256
• Field type: String

Direct Media with NAPT Call.

The valid values are:

Ingress SMM Profile Name
This field contains the inbound SIP Message Manipulation trunk group profile name that was executed against a session.

An example string is "Ingress SMM".

• Max Length: 24
• Field Type: String

Egress SMM Profile Name
This field contains the outbound SIP Message Manipulation trunk group profile name that was executed against a session.

An example string is "Egress SMM".

• Max Length: 24
• Field Type: String

P-Access-Network-Information header

• Max Length: 256
• Field Type: String

NOTE: This field is not generated in an ATTEMPT record.

IMS Node functionality

• Max Length: 2
• Field Type: Decimal

 The valid values are:

NOTE: This field is not generated in an ATTEMPT record.

IMS node role

• Max Length: 1
• Field Type: Decimal

The valid values are:

NOTE: This field is not generated in an ATTEMPT record.

IMS Use PcfaCcf

• Max Length: 1

• Field Type: Decimal

The valid values are:

P-CSCF calling party

• Max Length: 50
• Field Type: String

P-CSCF called party

• Max Length: 50
• Field Type: String

ICE used on Call

• Max Length: 1
• Field Type: Boolean value, 0 or 1

ICE Complete - Time-stamp when ICE Completes

• Max Length: 21
• Field Type: mm/dd/yyyy hh:mm:ss.s) (GMT)

Transit IOI List

• Max Length: 639
• Field Type: String

Loop Back Ravel Call

• Max Length: 1
• Field Type: Boolean

Optimal Media Routing Applied

• Max Length: 1
• Field Type: Boolean

IMS PAI Service header

• Max Length: 64
• Field Type: String

Feature-Caps header

• Max Length: 300
• Field Type: String

Called Asserted Identity

• Max Length: 256
• Field Type: String

NNI-Type

• Max Length: 1
• Field Type: decimal

The valid values are:

Neighbour Address

• Max Length: 39
  
• Field Type: IPv4 or IPv6 address

Relationship mode

• Max Length: 1
• Field Type: Decimal

The valid values are:

Session direction

• Max Length: 1
• Field Type: Decimal

The valid values are:

SMM CDR Field #1. This field represents either SIP message Header Value, Parameter value, Token value or value stored in SMM variable as a result of the execution of a SMM rule storing value to SMM CDR Field #1 respectively.

• Max Length: 256
• Field Type: String (variable length up to 256 character or empty)

SMM CDR Field #2. This field represents either SIP message Header Value, Parameter value, Token value or value stored in SMM variable as a result of the execution of a SMM rule storing value to SMM CDR Field #2 respectively.

• Max Length: 256
• Field Type: String (variable length up to 256 character or empty)

SMM CDR Field #3. This field represents either SIP message Header Value, Parameter value, Token value or value stored in SMM variable as a result of the execution of a SMM rule storing value to SMM CDR Field #3 respectively.

• Max Length: 256
• Field Type: String (variable length up to 256 character or empty)

SMM CDR Field #4.

This field represents either SIP message Header Value, Parameter value, Token value or value stored in SMM variable as a result of the execution of a SMM rule storing value to SMM CDR Field #4 respectively.

• Max Length: 256
• Field Type: String (variable length up to 256 character or empty)

SMM CDR Field #5.  This field represents either SIP message Header Value, Parameter value, Token value or value stored in SMM variable as a result of the execution of a SMM rule storing value to SMM CDR Field #5 respectively.

• Max Length: 256
• Field Type: String (variable length up to 256 character or empty)

Origination ID

A globally unique string corresponding to a Universally Unique Identifier (UUID) (RFC 4122).The purpose of the unique origination identifier is to assign an opaque identifier corresponding to the service provider-initiated calls themselves, customers, classes of devices, or other groupings that a service provider might want to use for determining things such as reputation or trace back identification of customers or gateways.

• Max length: 36
• Field Type: String

• Max length: 1
• Field Type: Decimal

The valid values are:

• • Max Length:1

  • Field Type: Decimal

The valid values are:

• Max Length: 3
• Field Type: String

Ingress Global SMM Profile Name
This field contains the inbound SIP Message Manipulation global profile name that was executed against a session.

An example string is "Ingress Global SMM".

• Max Length: 24
• Field Type: String

Egress Global SMM Profile Name
This field contains the outbound SIP Message Manipulation global profile name that was executed against a session.

An example string is "Egress Global SMM".

• Max Length: 24
• Field Type: String

Ingress AddrContext SMM Profile Name
This field contains the inbound SIP Message Manipulation address context profile name that was executed against a session.

An example string is "Ingress AC SMM".

• Max Length: 24
• Field Type: String

Egress AddrContext SMM Profile Name
This field contains the outbound SIP Message Manipulation address context profile name that was executed against a session.

An example string is "Egress AC SMM".

• Max Length: 24
• Field Type: String

Ingress Zone SMM Profile Name
This field contains the inbound SIP Message Manipulation zone profile name that was executed against a session.

An example string is "Ingress Zone SMM".

• Max Length: 24
• Field Type: String

Egress Zone SMM Profile Name
This field contains the outbound SIP Message Manipulation zone profile name that was executed against a session.

An example string is "Egress Zone SMM".

• Max Length: 24
• Field Type: String

STI Display Name

This field contains the STI-VS verified Display name. For more information, refer to Support for Display Name Updates over STI-AS/VS API.

• Max Length: 35
• Field Type: String

AniDnis Loop Detection Fail
This sub-field in ATTEMPT records indicates whether the call was rejected due to ANI-DNIS loop detection. (In START and STOP records the value is set to 0.)

0 – indicates the failure was not due to ANI-Dnis loop detection  

1 – indicates the failure was due to ANI-DNIS loop detection

• Max Length: 1
• Field Type: Boolean

P-K-Info "No-Charge" Indicator

This field indicates whether the SBC included a "no-charge notification" (P-K-Info:nchg header) in 18x responses. When this occurs, the SBC includes "nchg" in this subfield. Otherwise, it is empty.

• Max Length: 4
• Field Type: String

Attestation-Indicator

The Ingress Protocol Variant Specific Data (Ingress PVSD) is populated from Ingress received. If the PSX provides values for Attestation-Level then it is updated in the CDR under Egress Protocol Variant Specific Data (Egress PVSD). If not, then it is updated with Ingress received Attestation-Level. 

• Max Length: 1
• Field Type: String

STI RPH Service Type

Secure Telephone Identity RPH Service Type.

The data for this field is populated only for Egress Protocol Variant Specific Data (PVSD). Ingress Protocol Variant Specific Data (PVSD) is not populated.

• Max Length: 1
• Field type: Decimal

STI RPH Service Status

Secure Telephone Identity RPH Service Status.

The data for this field is populated only for Egress Protocol Variant Specific Data (PVSD). Ingress Protocol Variant Specific Data (PVSD) is not populated.

• Max Length: 1
• Field type: Decimal

STI RPH Reason Code

Secure Telephone Identity RPH SIP Reason Code.
SIP reason code corresponding to the STI RPH Service. Format: String of 3 characters

Values: SIP reason code

• Max Length: 3
• Field Type: String

STI RCD Service Type

Can have field values for the following service types:

STI RCD Service Status

Can have field values for the following service status:

STI RCD Reason Code

An error code providing the reason for the STI service failure using the error code mapping profile.