DTMF and Hook-Flash Parameters

The DTMF and hook-flash parameters are described in the table below.

DTMF and Hook-Flash Parameters

Parameter

Description

Hook-Flash Parameters  

'Hook-Flash Code'

configure voip > gateway dtmf-supp-service supp-service-settings > hook-flash-code

[HookFlashCode]

Defines the digit pattern that when received from the Tel side, indicates a Hook Flash event.

The valid range is a 25-character string. The default is a null string.

Note: The parameter can also be configured in a Tel Profile.

'Hook-Flash Option'

configure voip > gateway dtmf-supp-service dtmf-and-dialing > hook-flash-option

[HookFlashOption]

Defines the hook-flash transport type (i.e., method by which hook-flash is sent and received).

[0] Not Supported = (Default) Hook-Flash indication is not sent.
[1] INFO = Sends proprietary INFO message (Broadsoft) with Hook-Flash indication.
[4] RFC 2833
[5] INFO (Lucent) = Sends proprietary SIP INFO message with Hook-Flash indication.
[6] INFO (NetCentrex) = Sends proprietary SIP INFO message with Hook-Flash indication. The device sends the INFO message as follows:

Content-Type: application/dtmf-relay

Signal=16

Where 16 is the DTMF code for hook flash.

[7] INFO (HUAWEI) = Sends a SIP INFO message with Hook-Flash indication. The device sends the INFO message as follows:

Content-Length: 17

Content-Type: application/sscc

event=flashhook

Note:

FXS interfaces send Hook-Flash signals only if the EnableHold parameter is set to 0.

'Min. Flash-Hook Detection Period'

configure voip > interface fxs-fxo > min-flash-hook-time

[MinFlashHookTime]

Defines the minimum time (in msec) for detection of a hook-flash event. Detection is guaranteed for hook-flash periods of at least 60 msec (when setting the minimum time to 25). Hook-flash signals that last a shorter period of time are ignored.

The valid range is 25 to 300. The default is 300.

Note:

The parameter is applicable only to FXS interfaces.
It's recommended to reduce the detection time by 50 msec from the desired value. For example, if you want to set the value to 200 msec, then enter 150 msec (i.e., 200 minus 50).

'Max. Flash-Hook Detection Period'

configure voip > interface fxs-fxo > flash-hook-period

[FlashHookPeriod]

Global parameter defining the hook-flash period (in msec) for Tel and IP sides.

You can also configure the feature per specific calls, using Tel Profiles ('Flash Hook Period' parameter). For a detailed description of the parameter and for configuring the feature in the Tel Profiles table, see Configuring Tel Profiles.

Note:

The parameter is applicable only to FXS interfaces.
If the feature is configured for a specific Tel Profile, the settings of the global parameter is ignored for calls associated with the Tel Profile.

DTMF Parameters

 

notify-on-sig-end

[MGCPDTMFDetectionPoint]

Determines when the detection of DTMF events is notified.

[0] = DTMF event is reported at the end of a detected DTMF digit.
[1] = (Default) DTMF event is reported at the start of a detected DTMF digit.

'Declare RFC 2833 in SDP'

configure voip > gateway dtmf-supp-service dtmf-and-dialing > rfc-2833-in-sdp

[RxDTMFOption]

Global parameter that enables the device to declare the RFC 2833 'telephony-event' parameter in the SDP. You can also configure this feature per specific calls, using IP Profiles ('Rx DTMF Option' parameter). For a detailed description of the parameter and for configuring this feature in the IP Profiles table, see Configuring IP Profiles.

Note: If you configure this feature for a specific IP Profile, the device ignores this global parameter for calls associated with the IP Profile.

'First Tx DTMF Option'

configure voip > gateway dtmf-supp-service dtmf-and-dialing > first-dtmf-option-type

[FirstTxDTMFOption]

Defines the first preferred transmit (Tx) DTMF negotiation method.

[0] Not Supported = (Default) No negotiation. DTMF digits are sent according to the [DTMFTransportType] and [RFC2833PayloadType] parameters. The RFC 2833 payload type is according to the [RFC2833PayloadType] parameter for transmit and receive.
[1] Info NORTEL = Sends DTMF digits according to IETF Internet-Draft draft-choudhuri-sip-info-digit-00.
[2] NOTIFY = Sends DTMF digits according to IETF Internet-Draft draft-mahy-sipping-signaled-digits-01.
[3] Info Cisco = Sends DTMF digits according to Cisco format.
[4] RFC 2833 = The device handles DTMF as follows:
Negotiates RFC 2833 payload type using local and remote SDPs.
Sends DTMF packets using RFC 2833 payload type according to the payload type in the received SDP.
Expects to receive RFC 2833 packets with the same payload type according to the RFC2833PayloadType parameter.
Removes DTMF digits in transparent mode (as part of the voice stream).
[5] Info KOREA = Sends DTMF digits according to Korea Telecom format.

Note:

When out-of-band DTMF transfer is used -- [1], [2], [3], or [5] -- the [DTMFTransportType] parameter is automatically set to [0] (i.e., DTMF digits are erased from the RTP stream).
For more information on DTMF transport, see Configuring DTMF Transport Types.
You can also configure the parameter per specific calls, using IP Profiles ('First Tx DTMF Option' parameter). To configure IP Profiles, see Configuring IP Profiles.

'Second Tx DTMF Option'

configure voip > gateway dtmf-supp-service dtmf-and-dialing > second-dtmf-option-type

[SecondTxDTMFOption]

Defines the second preferred transmit (Tx) DTMF negotiation method. The first preferred method is configured by the FirstTxDTMFOption parameter. For a description of the optional values for the parameter, see the FirstTxDTMFOption parameter above.

Note: You can also configure the parameter per specific calls, using IP Profiles ('Second Tx DTMF Option' parameter). To configure IP Profiles, see Configuring IP Profiles.

[AdditionalOutOfBandDtmfFormat]

Enables the device to simultaneously send DTMF tones (signals) in SIP messages such as INFO messages (out-of-band) and in RTP media streams (in-band) with a special payload type (as defined in RFC 2833), when the FirstTxDTMFOption parameter is configured to 4. The parameter must be configured to the method for transporting DTMF digits over the IP network to the remote endpoint. For more information on DTMF transport, see Configuring DTMF Transport Types.

[0] = (Default) DTMF is sent according to FirstTxDTMFOption.
[1] = Nortel
[2] = Cisco
[3] = Threecom
[4] = Korea

configure voip > gateway dtmf-supp-service dtmf-and-dialing > auto-dtmf-mute

[DisableAutoDTMFMute]

Enables the automatic muting of DTMF digits when out-of-band DTMF transmission is used.

[0] = (Default) Automatic mute is used.
[1] = No automatic mute of in-band DTMF.

When the parameter is set to [1], the DTMF transport type is set according to the parameter [DTMFTransportType] and the DTMF digits aren't muted if out-of-band DTMF mode is selected -- [FirstTxDTMFOption] set to [1], [2] or [3]. This enables the sending of DTMF digits in-band (transparent of RFC 2833) in addition to out-of-band DTMF messages.
Note: This mode is usually not recommended.

'Enable Digit Delivery to IP'

configure voip > sip-definition settings > digit-delivery-2ip

[EnableDigitDelivery2IP]

Enables the Digit Delivery feature whereby DTMF digits are sent to the destination IP address after the Tel-to-IP call is answered.

[0] Disable (default)
[1] Enable = Enable digit delivery to IP.

To enable this feature, modify the called number to include at least one 'p' character. The device uses the digits before the 'p' character in the initial INVITE message. After the call is answered, the device waits for the required time (number of 'p' multiplied by 1.5 seconds), and then sends the rest of the DTMF digits using the method chosen (in-band or out-of-band).

Note: The called number can include several 'p' characters (1.5 seconds pause), for example, 1001pp699, 8888p9p300.

'Enable Digit Delivery to Tel'

configure voip > sip-definition settings > digit-delivery-2tel

[EnableDigitDelivery]

Global parameter enabling the Digit Delivery feature, which sends DTMF digits of the called number to the Tel side (analog port or B-channel for digital interfaces) after the call is answered (i.e., line is off-hooked for FXS) for IP-to-Tel calls.

You can also configure the feature per specific calls, using Tel Profiles ('Enable Digit Delivery' parameter). For a detailed description of the parameter and To configure the feature in the Tel Profiles table, see Configuring Tel Profiles.

Note: If the feature is configured for a specific Tel Profile, the settings of the global parameter is ignored for calls associated with the Tel Profile.

Replace Number Sign With Escape

configure voip > sip-definition settings > replace-nb-sign-w-esc

[ReplaceNumberSignWithEscapeChar]

Determines whether to replace the number sign (#) with the escape character (%23) in outgoing SIP messages for Tel-to-IP calls.

[0] Disable (default).
[1] Enable = All number signs #, received in the dialed DTMF digits are replaced in the outgoing SIP Request-URI and To headers with the escape sign %23.

Note:

The parameter is applicable only if the parameter IsSpecialDigits is set 1.

'Special Digit Representation'

configure voip > gateway dtmf-supp-service dtmf-and-dialing > special-digit-rep

[UseDigitForSpecialDTMF]

Defines the representation for ‘special’ digits (‘*’ and ‘#’) that are used for out-of-band DTMF signaling (using SIP INFO/NOTIFY).

[0] Special = (Default) Uses the strings ‘*’ and ‘#’.
[1] Numeric = Uses the numerical values 10 and 11.