Voice Service Configuration

You can use the configuration properties in create_config.py to configure additional voice charging services.

Voice Charging Services Configuration describes the configuration parameters in create_config.py for defining additional voice charging services, and shows example values for each parameter.
Table 1. Voice Charging Services Configuration
Parameter Description Example Value
Number of Additional Voice Services The number of voice charging services required in addition to the mobile originating and mobile terminating voice charging services. Enter a value of 1 or more to configure additional services for voice charging.

create_config.info question: Camel Gateway:How many additional voice services do you wish to create?

1
Voice Service Name The unique name of the voice service that you want to add. The default value is "VCS Additional 1".

create_config.info question: Camel Gateway:VCS Additional 1:What is the name identifier of this service?

my_voice_service
Enable Voice Charging Sets whether call details are sent to MATRIXX Engine to enable charging for calls that use this service.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you wish to charge calls to this service?

y
Send CIQ Whether to send a CallInformationRequest (CIQ) operation in the same message as the Connect or Continue operation. The information is returned in a CallInformationReport (CIR) operation. This information can be recorded in the MEF record (EDR).

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to send CallInformationRequest to monitor calls for this service (y/n)?

n
Voice Service ID The ID to use for Multi Service Credit Control (MSCC) information sent to MATRIXX Engine. The specified value populates following MSCC charging configuration fields in My MATRIXX:
  • ServiceId
  • ServiceTypeObjectId

The default value for the Voice Service ID is 3.

create_config.info question: Camel Gateway:VCS my_voice_service:What charging Service ID should be used for this service?

3
Requested Time The number of seconds to request from the Charging Server for calls for this service. Sets the maximum number of seconds granted in an ApplyCharging operation for this service. The minimum value is 30 seconds. Set to 900 seconds by default.
create_config.info question: What requested time in seconds should be used for this service?
Note: The alert timer index size configuration is used for determining when to trigger an alert. You must set the alert timer index size to 20 seconds more than the maximum requested time configured for any service. For more information about configuring the timer index size, see the discussion about alerts configuration.
900
Enable RAA Enables reauthorization on answer (RAA) for voice calls using this service. Answer y (yes) if you want MATRIXX Engine to reauthorize granted quota when a call is answered. Otherwise, answer n (no).

create_config.info question: Camel Gateway:VCS my_voice_service:Reauthorize charge on answer for this service (y/n)?

n
Enable Relay SCCP Answer y to enable CCF to relay incoming TCAP messages for subscribers who cannot be found in the MATRIXX subscriber database to the specified relay SCCP address. You will be asked additional create_config.info questions for configuring the relay SCCP address. For information, see the discussion about relay sccp address configuration parameters.

If you answer n, the additional questions are not asked.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you wish to enable relay sccp for the service?

n
Reauthorize on Receipt of ERBCSM chargeIndicator (Valid only for calls using the CAP4 protocol) Answer y (yes) if you want the service to honor the chargeIndicator parameter value requested in an o/tAnswer EventReportBCSM operation.

Otherwise answer n (no).

When set to y, if chargeIndicator is set to:
  • no charge — The Charging Server determines that the call must be free and releases any charging reservation for it. The call continues without being charged.
  • no indication, charge, or spare — The Charging Server reauthorizes the call quota and the call continues to be charged.
When set to n, the call is always charged for, even if chargeIndicator is set to no charge, unless the Rating Plan specifies not to charge the call.
Note: The ApplyCharging operation is not sent if the Charging Server determines not to charge the call.

create_config.info question: Camel Gateway:VCS my_voice_service:Honor no charge request on call answer for this service (y/n)?

y
Send ReleaseCall on Receipt of ERBCSM Sets whether to send ReleaseCall on receipt of an EventReportBCSM request operation for which the event detection point (EDP) is armed as anything except answer. A Continue operation is sent by default.

Answer y to the following create_config.info question to send ReleaseCall or n to send Continue:

create_config.info question: Camel Gateway:VCS my_voice_service:Should ReleaseCall be sent on receipt of ERBCSM(EDP anything except answer,request) for CAP2 and CAP3(y/n)?

n
No Answer Timeout Sets the number of seconds ringing time to wait for an answer to the call before the call times out.

create_config.info question: Camel Gateway:VCS my_voice_service:What no answer timeout in seconds do you want for this service?

20
ActivityTest Interval Sets the number of seconds that MATRIXX Engine should wait between sending ActivityTest operations to the mobile switching center (MSC) for non-chargeable calls. The default value is 1800 seconds (30 minutes). If the MSC returns:
  • An ActivityTest response, then MATRIXX Engine restarts the ActivityTest timer.
  • A TCAP ABORT, then MATRIXX Engine releases the reserved quota and ends the charging session.

create_config.info question: Camel Gateway:VCS my_voice_service:What is the interval in seconds between sending ActivityTest operations for uncharged calls for this service?

1800
ActivityTest Response Timeout Sets the number of seconds that MATRIXX Engine waits for a response to the ActivityTest operation before timing out.

create_config.info question: Camel Gateway:VCS my_voice_service:What is the activity test response timeout in seconds for this service?

5
Send ActivityTest for Timed Calls When set to y, the default, CCF sends ActivityTest for CAP 1 or CS1 INAP timed calls when the timer expires. Time is charged only when the ActivityTest result is recieived. If no ActivityTest result is received within the specified timeout then the call finishes and no further time is charged.

create_config.info question: Should ActivityTest be sent for CS1 INAP or CAP 1 timed calls for the vcs_service calls service (y/n)?

y
Correlation ID Length Sets the correlation ID length to use for the voice service for correlating the TCAP dialogues used in the message sequence when playing announcements. CCF handles 10 digit correlation IDs by default. If you set the correlation ID length to a value other than 10, you must also configure ranges of correlation IDs on each domain. For information about configuring correlation IDs, see the discussion about configuring correlation IDs.
Note: You can override the correlation ID length on an announcement server basis. For information about configuring announcement servers, see the discussion about configuring announcements in My MATRIXX Help.

create_config.info question: What is the default correlation ID length for this service?

10
Play Announcements Enables pre-call announcements for calls using this service. Answer y (yes) to play pre-call announcements. Otherwise, answer n (no).

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to play announcements for this service?

n
Enable Announcements for Forwarded Calls Answer y if you want to enable announcements for forwarded calls. Otherwise, answer n. This question is asked only if Play Announcements is enabled.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to play announcements for forwarded calls in this service (y/n)?

Note: CCF assumes the call is forwarded if the InitialDP originalCalledPartyID is present.
Announcement Failure Policy Answer y (yes) to release the call if the Interactive Voice Response (IVR) system is unable to play an announcement. Answer n (no) if you want the call to continue without playing any announcements.

create_config.info question: Camel Gateway:VCS my_voice_service:If any announcements fail during this service should the call be released (y/n)?

n
Tssf Timer Reset Answer y (yes) to the following questions to send a ResetTimer operation to the Mobile Switching Center (MSC), before playing an announcement or script, to set the Tssf timer to a value 10 seconds longer than the configured time of the announcement or script. Answer n (no) if you don't want to reset the Tssf timer.

create_config.info questions:

Camel Gateway:VCS my_voice_service:Should ResetTimer be sent when running scripts (y/n)?Should ResetTimer be sent when playing announcements (y/n)?

Camel Gateway:VCS my_voice_service:Should ResetTimer be sent when running scripts (y/n)?
n
Arm oAbandon EDP Arms the oAbandon EDP before playing an announcement or running a VXML script. This means that the MSC sends events instead of TCAP aborts if the call is ended before or during an announcement or VXML script. This option becomes available for a service only when you answer y (yes) to the following question:

Do you want to play announcements in the vcs_service calls service (y/n)?

By default the oAbandon EDP is not armed before playing an announcement or running a VXML script. To arm the oAbandon EDP, answer 'y' to the following question:

create_config.info question: Camel Gateway:VCS my_voice_service:Should the oAbandon EDP be armed before playing announcements or running VXML scripts (y/n)?

n
Bothway Indicator Sets the value of the bothwayThroughConnectionInd field in ConnectToResource and EstablishTemporaryConnection operations for the service. When set to:
  • bothwayPathNotRequired — The sound path from the caller to the IVR is disabled.
    Note: If you are using VXML scripts to play announcements, and you set bothwayThroughConnectionInd to: bothwayPathNotRequired, this value is ignored because it disables the ability of the IVR to collect information or speech from the caller. The bothwayThroughConnection field is not set.
  • bothwayPathRequired — The sound path between the caller and the IVR is enabled in both directions.
create_config.info question: What should bothwayThroughConnectionInd be set to in ConnectToResource and EstablishTemporaryConnection operations for the vcs_service calls service?
Important: By default this field is not set and the bothwayThroughConnectionInd field is not included in the message. In this case, the sound path between the caller and the IVR is enabled in both directions. MATRIXX Support recommends that you accept the default value and, if required, set the bothwayThroughConnectionInd field on an announcement server (IVR) basis instead, when configuring announcement pricing components in My MATRIXX. For more information, see the discussion about announcements configuration in My MATRIXX Help.
Not Set
Play Tone Enables CCF to play a warning tone to callers if they are about to run out of funds. Answer y if you want to enable this feature for the service. Otherwise, answer n.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want the caller to hear a tone shortly before the call is cut off due to insufficient funds for this service (y/n)?

y
Maximum Redirections The maximum number of redirections allowed for a call. Calls are released if the number of redirections exceeds the configured maximum.

create_config.info question: Camel Gateway:VCS my_voice_service:How many redirections are allowed in this service?

3
Emergency Number List The list of numbers or number prefixes to treat as emergency numbers. Enter a comma separated list of up to 100 numbers. Numbers can contain non-digits such as * and #.
Note: For MSCs that handle emergency numbers themselves, you can set the emergency number list value to none, but only if you are certain that MSCs already handle these numbers.

create_config.info question: Camel Gateway:VCS my_voice_service:Enter the list of numbers to be treated as emergency numbers in this service?

none
Enable MT Call Forwarding For MT voice services only. Call forwarding is not supported for MO voice services.
Answer y to enable calls using this MT service to be forwarded or redirected. Calls are forwarded to the denormalized number specified in DestinationRoutingAddress only if both the following fields are set in MtxTcapMsg.Ratingmsg.ServiceInfo.VcsInfo:
  • DestinationRoutingAddress
  • ServiceRedirectReason
When MT call forwarding is enabled, tBusy and tNoAnswer EDPs are armed as interrupted.

create_config.info question: Do you wish to support service based call forwarding for this service?

For more information about MT call forwarding, see support for MT call forwarding in MATRIXX Call Control Framework Integration.

n
Search for TSANs For MO voice services only. Call reorigination is not supported for MT calls and this question is not asked for MT voice services.

If you are using the TSAN reorigination service, answer y to enable the service to search for TSANs in InitialDP messages.

create_config.info question: Do you wish to search for TSAN's in the InitialDP (y/n)?

Send FCI Answer y to send FurnishChargingInformation (FCI) operations during call handling. By default, FCI operations are not sent.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to send FurnishChargingInformation for this service (y/n)?

If you answer y, then you must answer the following additional questions:
  • Should FCI be sent before CAP Connect or Continue operations for the vcs_service calls service (y/n)?
  • Should FCI be sent before CAP ReleaseCall operations for the vcs_service calls service (y/n)?
  • Should FCI be sent after receipt of CAP ApplyChargingReport operations for the vcs_service calls service (y/n)?
  • Should FCI be sent in a separate TCAP message for the vcs_service calls service (y/n)?
  • Should the FCI appendFreeFormatData parameter be set to 1=append for the vcs_service calls service (y/n)?
  • Which private MDC type should be used for the FurnishChargingInformation operation parameter for the vcs_service calls service?
n
AChBillingCharacteristics MDC Specifies the private MDC to use for AChBillingCharacteristics parameter data. The AchBillingCharcteristics parameter is sent in custom ApplyCharging operations for CS1 INAP.
Note: You must also define the private MDC, and specify selective updates to populate the AChBillingCharacteristics fields.

create_config.info question: Which private MDC type should be used for the AChBillingCharacteristics type for CS1 INAP for this service (y/n)?

None
Call Result MDC Specifies the private MDC that holds the CallResult parameter data for calls using the CS1 INAP protocol.
Note: You must also define the private MDC, and specify selective updates to populate the CallResult fields.

create_config.info question: Which custom MDC type should be used for the CallResult type for CS1 INAP for this service?

None
Use CS1 INAP Answer y if calls to the voice service will be using the CS1 INAP protocol.
If you answer y, then you must also answer the following question to specify the CS1 INAP charging method, one of:
  • 1 — No charging
  • 2 — ApplyCharging Operation
  • 3 — MATRIXX timer
The charging method is set to MATRIXX timer by default.

create_config.info question: What charging method do you want to use for CS1 INAP calls?

Subscriber Source A comma-separated list of subscriber sources from the initial incoming network request (IDP). The subscriber sources are searched for, in list order, and the first source that is found is used to determine the subscriber that the call is primarily associated with (normally for charging). Valid values are:
  • imsi — The iMSI parameter from the IDP.
  • redir — The redirectingPartyID parameter from the IDP.
  • origcalled — The originalCalledPartyID from the IDP.
  • calling — The callingPartyNumber from the IDP.
  • called — The calledPartyNumber from the IDP.

create_config.info question: Camel Gateway:VCS my_voice_service:What subscriber sources are required for this service?

imsi
TCAP End Type Sets the service behavior at the end of an open TCAP transaction when there are no outstanding messages to send. The CAMEL default behavior is prearranged end. However, for switches that do not use this, you can set to end the transaction by canceling (TCAP abort) or by sending an empty TCAP end. Valid values are:
  • 1 — Prearranged end
  • 2 — TCAP Abort
  • 3 — Empty TCAP end

create_config.info question: Camel Gateway:VCS my_voice_service:What TCAP transaction prearranged-end behavior is required for this service?

2
Destination Routing Address Prefix The prefix to add to the calledPartyNumber or calledPartyBCDNumber contained in the IDP message. The Destination Routing Address is set to the resulting value in the Connect response message. Leave blank (the default) or enter none if no prefix is required. Valid values are:
  • Prefix phone number
  • none

create_config.info question: Camel Gateway:VCS my_voice_service:What Destination Routing Address prefix is required for this service?

Rule Set Name The name of the rule set to use for number normalization or denormalization. To use the default rule set, enter default.

create_config.info question: Camel Gateway:VCS my_voice_service:What rule set should be used for number (de)normalization for this service?

default
Pre Call Initiation Delay Sets the number of seconds to delay call initiation for USSD call back, for the voice service. Set to 0 (zero) if you do not want to delay call initiation.

create_config.info question: What pre call initiation delay in seconds do you want for this service?

0
Call Initiation Retries Sets the maximum number of retries for call initiation to the A-party (calling party) for USSD call back. If Call Initiation Retries is set to a value greater than one, then CCF retries the initiate call attempt only if both the following are true:
  • EventReportBCSM(routeSelectFailure) operation is received.
  • The release cause matches a value specified for call initiation retry Release Causes.

create_config.info question: Camel Gateway:VCS my_voice_service:How many tries do you want for the call initiation a_party for this service?

1
Use Session Limit Service ID Answer y to the following question to specify a service ID to use for limiting the number of concurrent USSD call back sessions to one per subscriber.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to add a session limit service id for this service?

If you answer y, you are asked to enter the service ID:

create_config.info question: Camel Gateway:VCS my_voice_service:What session limit service id do you want for this service?

n
Use Call Initiation Session Limit Service ID Answer y to the following question to specify a service ID to use for limiting the number of concurrent call initiation sessions for USSD call back to one per subscriber.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to add a call initiation session limit service id for this service?

If you answer y, you are asked to enter the service ID:

create_config.info question: What call initiation session limit service id do you want for this service?

n
Call Initiation Order For call initiation, CCF sends an InitateCallAttempt operation for the A-party (the caller) before the InitiateCallAttempt operation for the B-party (the callee) by default. Answer n to the following question to CCF to send InitiateCallAttempt for the B-party first.

create_config.info question: Camel Gateway:VCS my_voice_service:For call initiation, do you want InitiateCallAttempt(A-party) to be sent before InitiateCallAttempt(B-party) for this service (y/n)?

y
Add Call Initiation Release Causes Answer y to the following question to enter a list of valid release cause values for call initiation retries.

create_config.info question: Camel Gateway:VCS my_voice_service:Do you want to add call initiation release cause values in this service?

n
Call Initiation Release Cause Values Enter a comma-separated list of call initiation release cause values. A call initiation retry is attempted only if the release cause for the preceding attempt matches a value in the list, and a EventReportBCSM(routeSelectFailure) operation is received.

create_config.info question: Camel Gateway:VCS my_voice_service:Enter a list of release causes to be checked in order to retry call initiation in this service?

none
Maximum Number of TCAP Sessions per Device Sets the maximum number of open TCAP sessions allowable on one device, at one time. If an event results in an attempt to create more sessions than are allowed by the configuration, an error is returned and the total number of sessions is logged. The maximum number of sessions is 50.

create_config.info question: Global:How many active tcap sessions are allowed per device?

For more information, see the discussion about session management in MATRIXX Subscriber Management.

5