Skip to end of metadata
Go to start of metadata

Table : SIP Variant/SIP-I Signaling Sub-field Descriptions

 

Sub-Field     

Description

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.sonusnet.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

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

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.

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@10.7.11.186:5060"

is rendered as:

"sip:1234567890;isub=1234%2C5678@10.7.11.186:5060"

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 character 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.

Valid values for this field are:

  • empty – Not present
  • 0 – ACK not received
  • 1 – ACK received

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.

Valid values for this field are:

  • empty – Not present
  • 400-700 – Message Name/ID
  • 703 – Message Name/ID
  • BYE – BYE message received
  • CAN – CANCEL message received
  • 729 – DNS related error

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.

Valid values for this field are:

  • empty – Not present
  • 1-127 – The range of recognized reason values in the Q850 standard

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.

Valid values for this field are:

  • empty – Unknown, such as a parse failure.
  • 0 – NAPT is disabled for signaling for the SIP service group involved for this leg of the call.
  • 1 – NAPT is enabled for signaling for SIP service group involved for this leg of the call.

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.

Valid values for this field are:

  • empty – Unknown, such as a parse failure.
  • 0 – NAPT is disabled for media for the SIP service group involved for this leg of the call.
  • 1 – NAPT is enabled for media for the SIP service group involved for this leg of the call.

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.

Valid values for this field are:

  • empty – Not present
  • 0-99 – The number of UUI parameters sent from the a-party.

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.

Valid values for this field are:

  • empty – Not present
  • 0-99 – The number of UUI parameters received by the a-party.

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.

Valid values for this field are:

  • empty – An ordinary call with no service information.
  • 1 – CPC_SVC_INFO_DPNSS_REAL (real call established for ring back when free).
  • 2 – CPC_SVC_INFO_DPNSS_VIRTUAL (virtual call established for ring back when free)

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

Transport protocol used to setup the SIP call

  • Max length: 1
  • Field type: Decimal

Valid values for this field are:

  • 0 – Unknown Transport
  • 1 – UDP
  • 2 – TCP
  • 3 – TLS/TCP
  • 4 – SCTP

Sub-Field 34

Direct Media Call

  • Max length: 1
  • Field type: Boolean

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

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

  • Max length: 1
  • Field type: Decimal

This field contains the inbound SIP Message Manipulation status. Valid values for this field are:

  • 0 – No SIP Message Manipulation
  • 1 – Successful SIP Message Manipulation
  • 2 – SIP Message Manipulation Error

Sub-Field 36

Outbound SMM Indicator

  • Max length: 1
  • Field type: Decimal

This field contains the outbound SIP Message Manipulation status. Valid values for this field are:

  • 0 – No SIP Message Manipulation
  • 1 – Successful SIP Message Manipulation
  • 2 – SIP Message Manipulation Error
Sub-Field 37

Originating Charge Area – String of exactly 5 characters.
Values: 00000-99999 or empty

  • Max length: 5
Sub-Field 38

Terminating Charge Area – String of exactly 5 characters
Values: 00000-99999 or empty

  • Max length: 5
Sub-Field 39

Feature Tag in Contact Header

  • Max length: 200
Sub-Field 40

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”
Sub-Field 44

Direct Media with NAPT Call. Valid values are:

  • 0 – Media flow through the SBC, or basic Direct Media
  • 1 – Direct Media with NAPT
Sub-Field 45

Ingress SMM Profile Name
This field contains the Inbound SIP Message Manipulation Profile Name that was executed against a session.

An example string is "Ingress SMM".

  • Max Length: 24
  • Field Type: String
Sub-Field 46

Egress SMM Profile Name
This field contains the Outbound SIP Message Manipulation Profile Name that was executed against a session.

An example string is "Egress SMM".

  • Max Length: 24
  • Field Type: String
Sub-Field 47

P-Access-Network-Information header

  • Max Length: 256
  • Field Type: Integer

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

Sub-Field 48

IMS Node functionality

  • Max Length: 2
  • Field Type: Decimal

Valid values are:

  • 1 – P-CSCF
  • 6 – AS
  • 7 – IBCF
  • 11 – E-CSCF

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

Sub-Field 49

IMS node role

  • Max Length: 1
  • Field Type: Decimal

Valid values are:

  • 0 – originating
  • 1 – terminating

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

Sub-Field 50

IMS Use PcfaCcf

  • Max Length: 1
  • Field Type: Decimal

Valid values are:

  • Empty – PcfaCcf is not in use
  • 1 – PcfaCcf is in use
Sub-Field 51

P-CSCF calling party

  • Max Length: 50
  • Field Type: String
Sub-Field 52

P-CSCF called party

  • Max Length: 50
  • Field Type: String
Sub-Field 53

ICE used on Call

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

ICE Complete - Time-stamp when ICE Completes

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

Transit IOI List

  • Max Length: 639
  • Field Type: String
Sub-Field 56

Loop Back Ravel Call

  • Max Length: 1
  • Field Type: Boolean
Sub-Field 57

Optimal Media Routing Applied

  • Max Length: 1
  • Field Type: Boolean
Sub-Field 58

IMS PAI Service header

  • Max Length: 64
  • Field Type: String
Sub-Field 59

Feature-Caps header

  • Max Length: 300
  • Field Type: String
Sub-Field 60

Called Asserted Identity

  • Max Length: 256
  • Field Type: String
Sub-Field 61

NNI-Type

  • Max Length: 1
  • Format: decimal 0 - non roaming,1 - roaming without loopback, 2 - roaming with loopback
Sub-Field 62

Neighbour Address

  • Max Length: 39
  • Format: IPv4 or IPv6 address
Sub-Field 63

Relationship mode

  • Max Length: 1
  • Format: decimal 0 - trusted,1 - untrusted
Sub-Field 64

Session direction

  • Max Length: 1
  • Format: decimal 0 - inbound,1 - outbound
Sub-Field 65

SMM CDR Field #1

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

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.

Sub-Field 66

SMM CDR Field #2

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

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.

Sub-Field 67

SMM CDR Field #3

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

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.

Sub-Field 68

SMM CDR Field #4

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

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.

Sub-Field 69

SMM CDR Field #5

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

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.

This SIP variant is delimited by the delimiter "". The sub-fields are separated by a comma (,). An empty field is represented by either two consecutive commas (,,) or by comma-space-comma (, ,).

For example:

"SIP,2203_1034102674@10.6.30.27:34975,<sip:9876543210@10.6.30.27:34975>;tag=1034102674,<sip:7661112222@10.13.1.35:4000>;tag=gK098024b6,0,,,,sip:7661112222@10.13.1.35:4000,user1@sonusnet.com,aliceinthewonderland,9876543210,sip:9876543210@10.6.30.27:34975,sip:7661112222@10.13.1.35:4000,msnr,9876543212,,1,,,0,0,,3,3,1,3cbed620-0001-1000-00-0000-10-6b-00-02-20,10.10.10.10,home1.net,dest.net,01793601014,123.14.15.16,0,0"

If a double quote ("") occurs within a sub-field, then the escape sequence "%22" replaces the double quote.

For example, the SIP Protocol Variant:

"SIP,f26b0300-464a4c40-7704286-322e3031@10.20.9.68,"6976921234"
 <sip:6976921234@10.99.55.6>;tag=, 
<sip:3216921115@10.99.55.6>;tag=34,,unavailable,joe123@4.3.2.1,cda,+8105030450095,0311112222,1,BYE,32,0,0,,3,3,1,3cbed620-0001-1000-00-0000-10-6b-00-02-20,10.10.10.10,home1.net,dest.net,01793601014,123.14.15.16,0,0"

is rendered as:

"SIP,f26b0300-464a4c40-7704286-322e3031@10.20.9.68,%226976921234%22
 <sip:6976921234@10.99.55.6>;tag=, 
<sip:3216921115@10.99.55.6>;tag=34,,unavailable,joe123@4.3.2.1,cda,+8105030450095,0311112222,1,BYE,32,0,0,,3,3,1,3cbed620-0001-1000-00-0000-10-6b-00-02-20,10.10.10.10,home1.net,dest.net,01793601014,123.14.15.16,0,0"

  • No labels