Versions Compared

Old Version 4

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel

In this section:

Table of Contents
maxLevel2

 

X-headers are request HTTP header fields beginning with an "X" which are used for non-standard (or proprietary) additions to the regular fields in the HTTP header.

Command Syntax

Code Block
languagenone
% set profiles signaling XHeaderProfile <profile_name> 
	P-HeaderExtensions 
		P-Area-Info 
			RecvHeader <disabled|enabled> 
			SendHeader <disabled|enabled> 
	X-Header-default-value 
		X-IsupMtype-ACM 
			X-BCI <0-4 characters, in bytes> 
			X-OBCI <0-2 characters, in bytes> 
		X-IsupMtype-ANM 
			P-Area-Info <0-10 characters, in bytes> 
			X-BCI <0-4 characters, in bytes> 
			X-OBCI <0-2 characters, in bytes> 
		X-IsupMtype-IAM 
			CallingPartycategory <0-2 characters, in bytes> 
			X-FCI <0-4 characters, in bytes> 
			X-NOCI <0-2 characters, in bytes> 
	X-HeaderExtensions
		X-ATP 
			RecvHeader 
			SendHeader 
		X-AUT 
			RecvHeader 
			SendHeader 
		X-BCI 
			RecvHeader 
			SendHeader 
		X-CALLING-NUM 
			RecvHeader 
			SendHeader 
		X-CHGDelay 
			RecvHeader 
			SendHeader 
		X-CHGInfo 
			RecvHeader 
			SendHeader
Code Block
languagenone
		X-CONTRACT-ADDR 
			RecvHeader 
			SendHeader 
		X-Carrier-Info 
			RecvHeader 
			SendHeader 
		X-EMG 
			RecvHeader 
			SendHeader 
		X-FCI 
			RecvHeader 
			SendHeader 
		X-FWDORIG-NUM 
			RecvHeader 
			SendHeader 
		X-GENERIC-NUM 
			RecvHeader 
			SendHeader 
		X-ISUPEvent 
			RecvHeader 
			SendHeader 
		X-ISUPMtype 
			RecvHeader 
			SendHeader 
		X-NOCI 
			RecvHeader 
			SendHeader 
		X-OBCI 
			RecvHeader 
			SendHeader 
		X-ORIGCLD-NUM 
			RecvHeader 
			SendHeader 
		X-REDBWDINF 
			RecvHeader 
		X-REDCAP 
			SendHeader 
		X-REDCNT 
			RecvHeader 
			SendHeader 
		X-REDFWDINF 
			SendHeader 
		X-TMR RecvHeader 
			SendHeader 
		X-USI RecvHeader 
			SendHeader 
	X-HeaderFlags 	
		recvCfn 
		recvResume 
		recvSuspend 
		sendCfn 
		sendResume 
		sendSuspend

Command Parameters

The X- Header parameters are defined below:

Caption
0Table
1X-Header Parameters

Parameter

Description

XHeaderProfile

Name of X-Header profile.

P-HeaderExtensions

Prescribes behavior associated with various P-Headers and P-K headers. Currently, only one option available:

  • P-Area-Info
    • RecvHeader – Enable to receive P-Area-Info header on the ingress leg.
      • disabled
      • enabled (default)
    • SendHeader – Enable to send P-Area-Info header on the egress leg.
      • disabled
      • enabled (default)

X-Header-default-value

Use this object to configure X Header default values.

  • X-IsupMtype-ACM – ACM default values.
    • X-BCI – Allow 4 bytes of X-BCI default data (default = 1014).
    • X-OBCI – Allow 2 bytes of X-OBCI default data (default = "").
  • X-IsupMtype-ANM – ANM default values.
    • P-Area-Info – Allow 10 bytes of P-Area-Info default data.
    • X-BCI – Allow 4 bytes of X-BCI default data. (default = 0014)
    • X-OBCI – Allow 2 bytes of X-OBCI default data. (default = "")
  • X-IsupMtype-IAM– IAM default values.
    • CallingPartycategory – Allow 2 bytes of CallingParty category default data. (default = 0A)
    • X-FCI – Allow 4 bytes of X-FCI default data. (default = 2001).
    • X-NOCI – Allow 2 bytes of X-NOCI default data. (default = 00).

X-HeaderExtensions

Use this object to enable/disable Receive and/or Send headers associated with specified X-Headers. See X-Header Extensions Descriptions table below for a list of X-Header parameters associated with this object.
For each X-Header parameter, enable or disable the associated RecvHeader and/or SendHeader flags:

  • RecvHeader – By default, this flag is enabled to allow reception of the specified X-Header on the ingress leg.
    • disabled
    • enabled (default)
  • SendHeader – By default, this flag is enabled to honor sending the specified X-Header on the egress leg.
    • disabled
    • enabled (default)

X-HeaderFlags

Collection of X-Header control flags which define specific behaviors as indicated.

  • recvCfn – Enable flag to interwork INFO messages with CONFUSION message types to ISUP.
    • disabled (default)
    • enabled
  • recvResume – Enable flag to interwork INFO messages with RESUME message types to ISUP.
    • disabled (default)
    • enabled
  • recvSuspend – Enable flag to interwork INFO messages with SUSPEND message types to ISUP.
    • disabled (default)
    • enabled
  • sendCfn – Enable flag to interwork ISUP messages CONFUSION messages to the SIP side.
    • disabled (default)
    • enabled
  • sendResume – Enable flag to interwork ISUP messages RESUME messages to the SIP side.
    • disabled (default)
    • enabled
  • sendSuspend – Enable flag to interwork ISUP messages SUSPEND messages to the SIP side.
    • disabled (default)
    • enabled
Caption
0Table
1X-Header Extensions Descriptions
3X-Header Extensions Descriptions

X-Header Extension

Description

X-ATP

Enable/disable X-ATP headers on incoming/outgoing directions separately.

X-AUT

Enable/disable X-AUT headers on incoming/outgoing directions separately.

X-BCI

Enable/disable X-BCI headers on incoming/outgoing directions separately.

X-CALLING-NUM

Enable/disable X-CALLING-NUM headers on incoming/outgoing directions separately.

X-CHGDelay

Enable/disable X-CHGDelay headers on incoming/outgoing directions separately.

X-CHGInfo

Enable/disable X-CHGInfo headers on incoming/outgoing directions separately.

X-CONTRACT-ADDR

Enable/disable X-CONTRACT-ADDR headers on incoming/outgoing directions separately.

X-Carrier-Info

Enable/disable X-Carrier-Info headers on incoming/outgoing directions separately.

X-EMG

Enable/disable X-EMG header on incoming/outgoing directions separately.

X-FCI

Enable/disable X-FCI headers on incoming/outgoing directions separately.

X-FWDORIG-NUM

Enable/disable X-FWDORIG-NUM headers on incoming/outgoing directions separately.

X-GENERIC-NUM

Enable/disable X-GENERIC-NUM headers on incoming/outgoing directions separately.

X-ISUPEvent

Enable/disable X-ISUPEvent headers on incoming/outgoing directions separately.

X-ISUPMtype

Enable/disable X-ISUPMtype headers on incoming/outgoing directions separately.

X-NOCI

Enable/disable X-NOCI headers on incoming/outgoing directions separately.

X-OBCI

Enable/disable X-OBCI headers on incoming/outgoing directions separately.

X-ORIGCLD-NUM

Enable/disable X-ORIGCLD-NUM headers on incoming/outgoing directions separately.

X-REDBWDINF

Enable/disable X-REDBWDINF headers on incoming/outgoing directions separately.

X-REDCAP

Use to enable/disable X-REDCAP headers on incoming/outgoing directions separately.

X-REDCNT

Enable/disable X-REDCNT headers on incoming/outgoing directions separately.

X-REDFWDINF

Enable/disable X-REDFWDINF headers on incoming/outgoing directions separately.

X-TMR

Enable/disable X-TMR headers on incoming/outgoing directions separately.

X-USI

Enable/disable the X-USI headers on incoming/outgoing directions separately.

Pagebreak