Home
MATRIXX Call Control Framework Integration
Supported Message Sequences
MATRIXX Call Control Framework (CCF) provides support for message sequences using the Camel Application Part (CAP) protocol.
Pre-Call Announcement Message Sequences
MATRIXX Call Control Framework (CCF) pre-call announcement functionality enables you to play announcements to the caller before connecting them to the dialed number, either by returning the IDs of one or more announcements to play, or the ID of a VoiceXML (VXML) script to run in response to an initial quota request.
Pre-Call Announcements Using VoiceXML Scripts
Call Control Framework (CCF) supports message sequences for playing pre-call announcements using VoiceXML scripts. When MATRIXX Engine returns a VoiceXML (VXML) script ID in the response to an initial quota request, the script ID determines which VoiceXML script to run on the Interactive Voice Response (IVR) system. The subscriber can make choices, such as whether to top up their balance, through their interaction with the script.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
- About Call Control Framework Integration
  MATRIXX Call Control Framework Integration provides information about MATRIXX Call Control Framework support and configuration.
- MATRIXX Call Control Framework
  MATRIXX includes an integrated GSM Service Control Function to support call control capabilities for telephony services.
- Supported Message Sequences
  MATRIXX Call Control Framework (CCF) provides support for message sequences using the Camel Application Part (CAP) protocol.
  - Released Calls and Denial Codes
    For calls that are rejected by pricing before the call is connected, the pricing denial code is mapped onto the cause value in the ReleaseCall operation sent to the MSC.
  - TCAP Session Timer
    Call Control Framework (CCF) maintains an end of transaction timer for TCAP sessions.
  - How CCF Decodes or Encodes CallingStationId and CalledStationId Fields
    The way Call Control Framework (CCF) decodes or encodes the CallingStationId and CalledStationId fields in the MtxDiamRoMsg MDC depends on whether the field holds a GSM 04.08 number or a Q.763 number.
  - Basic Voice Charging Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for basic voice charging message sequences.
  - CAP1 Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for voice call message sequences using the CAP1 protocol.
  - CS1 INAP Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for message sequences using the CS1 INAP protocol.
  - Reauthorization on Answer Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for reauthorization on answer and for no reauthorization on answer message sequences. When a call is answered, MATRIXX Engine determines whether to send an ApplyCharging operation with, or without reauthorization, based on configuration.
  - SMS Charging Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for SMS charging message sequences.
  - Pre-Call Announcement Message Sequences
    MATRIXX Call Control Framework (CCF) pre-call announcement functionality enables you to play announcements to the caller before connecting them to the dialed number, either by returning the IDs of one or more announcements to play, or the ID of a VoiceXML (VXML) script to run in response to an initial quota request.
    - Example Values in Pre-Call Announcement Message Sequences
      The example scenarios for pre-call announcements use the example parameter values described in the following table.
    - Pre-Call Announcements Using Announcement IDs
      Call Control Framework (CCF) supports message sequences for playing pre-call announcements to the subscriber when MATRIXX Engine returns a PlayAnnouncement operation in the response to an initial quota request.
    - Pre-Call Announcements Using VoiceXML Scripts
      Call Control Framework (CCF) supports message sequences for playing pre-call announcements using VoiceXML scripts. When MATRIXX Engine returns a VoiceXML (VXML) script ID in the response to an initial quota request, the script ID determines which VoiceXML script to run on the Interactive Voice Response (IVR) system. The subscriber can make choices, such as whether to top up their balance, through their interaction with the script.
      - VXML Pre-Call Announcement With Successful Recharge
        This example scenario describes the message sequence used to play the subscriber a pre-call announcement by running a VoiceXML (VXML) script.
      - Successful Recharge After Initial Response Has LastUnitInfo
        This example scenario describes the message sequence used when the initial response from the Charging Server to a request for quota has LastUnitInfo and the ID of VoiceXML (VXML) script to run.
      - Subscriber With No Funds Chooses Not to Top Up
        This example scenario describes the message sequence used for a pre-call recharge attempt where a subscriber with no funds chooses not to top up.
      - LastUnitInfo, Subscriber Chooses Not to Top Up
        This example scenario describes the message sequence used for a pre-call recharge attempt where the subscriber's funds are low and the subscriber chooses not to top up.
      - Successful Recharge, Reauthorize on Answer
        This example scenario describes the message sequence used for a pre-call recharge attempt where the subscriber successfully tops up and Call Control Framework is configured to reauthorize on answer (RAA).
      - Connection Attempt to IVR Fails, Call Continues
        This example scenario describes the message sequence used when the Mobile Switching Center (MSC) fails to connect to the Interactive Voice Response (IVR) system and MATRIXX Engine sends a TCAP Continue message to the MSC to continue the call.
      - Timeout Connecting to IVR
        This example scenario describes the message sequence used when the VoiceXML (VXML) script cannot be run because a timeout occurs while connecting to the Interactive Voice Response (IVR) system.
      - VXML Script Fails to Run
        This example scenario describes the message sequence used when the Interactive Voice Response (IVR) system fails to run the VoiceXML (VXML) script.
      - VXML Script Times Out While Running on IVR
        This example scenario describes the message sequence used when the VoiceXML (VXML) script times out while running on the Interactive Voice Response (IVR) system.
      - Caller Hangs Up While Connecting to IVR
        This example scenario describes the message sequence used when the caller (subscriber) hangs up while a connection to the Interactive Voice Response (IVR) system is being established.
      - Caller Hangs Up While VXML Script is Running
        This example scenario describes the message sequence used when the caller hangs up while the VoiceXML (VXML) script is running.
      - IVR Cancels VXML Script
        This example scenario describes the message sequence used when the Interactive Voice Response (IVR) system sends a TCAP ABORT message to cancel the dialog with MATRIXX Engine while the VoiceXML (VXML) script is running.
  - CallInformationRequest Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for CAP4 message sequences that include CallInformationRequest operations.
  - ActivityTest Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for ActivityTest message sequences. MATRIXX Engine periodically sends ActivityTest operations for non-chargeable voice calls that are being monitored (through CallInformationRequest operations) to find out whether calls are still active.
  - Disconnect Leg 2 Message Sequences
    MATRIXX Call Control Framework provides support for called party disconnects message sequences. In the following example scenarios, Call Control Framework (CCF) is configured to arm the oDisconnect (leg 2) or tDisconnect (leg 2) event detection point (EDP) as interrupted.
  - Alternative Message Sequences
    You can configure MATRIXX Call Control Framework (CCF) to use alternative message sequences.
  - Furnish Charging Information (FCI) Message Sequences
    MATRIXX Call Control Framework (CCF) provides support for FCI message sequences. CCF sends FCI operations to instruct the Mobile Switching Center (MSC) to add charging information to the call data record (CDR) for a call.
  - Non-Standard ConnectToResource Message Sequence
    Call Control Framework (CCF) supports using a non-standard message sequence for playing announcements on an external interactive voice response (IVR) system in which MATRIXX sends an extra ConnectToResource (CTR) operation in a separate TCAP CONTINUE message before playing the first announcement.
  - Error Condition Message Sequences
    MATRIXX Call Control Framework (CCF) includes message sequences to support the following error conditions.
- Configuring MATRIXX Network Enabler
  This section describes how to configure MATRIXX Network Enabler.
- Configuring CAMEL Gateway
  CAMEL Gateway is a CAMEL Application Part (CAP) server. Configure CAMEL Gateway to allow communication between MATRIXX Engine and Network Enablers through the CAP protocols.
- Configuring Routing Preferences
  Configuring routing preferences allows you to define how routes are prioritized between CAMEL Gateway on each engine and Network Enablers.
- Configuring Correlation ID Length
  Call Control Framework (CCF) supports configurable correlation ID lengths. CCF handles 10 digit correlation ID lengths by default.
- Support for CAP1
  Call Control Framework (CCF) supports the processing of roaming voice calls that use the CAP1 protocol.
- Charging for CS1 INAP Calls
  Call Control Framework (CCF) provides support for processing and applying charging for voice calls that use the CS1 INAP protocol.
- Sending Furnish Charging Information
  You can configure Call Control Framework (CCF) to send Furnish Charging Information (FCI) operations at specific points during call handling. CCF sends FCI operations to instruct the Mobile Switching Center (MSC), or service switching point (SSF), to add charging information to the call data record (CDR) for a call.
- Support for MT Call Forwarding
  When handling a mobile terminating (MT) call, Call Control Framework (CCF) can forward the call to another number if the call is not answered, or the called number is busy.
- TCAP Handover and Relay Configuration
  Call Control Framework (CCF) can handover (relay) incoming TCAP requests for subscribers that MATRIXX cannot find in its subscriber database to another platform for processing. For example, when migrating to the MATRIXX platform, CCF can relay incoming TCAP requests to the incumbent platform for subscribers that have not yet been migrated across. After handover, the incumbent platform processes the TCAP request without any further involvement with MATRIXX.
- Support for Announcements
  MATRIXX Call Control Framework (CCF) provides support for playing pre-call announcements. The following topics describe CCF pre-call announcement functionality and explain how to configure CCF to play announcements.
- Support for USSD Services
  Call Control Framework (CCF) supports making Mobile Application Part (MAP) Unstructured Supplementary Service Data (USSD) call out requests to deliver USSD notifications to a subscriber. CCF also supports USSD services for queries, call back, and interactive menus using MAP-Process-UnstructuredSS-Request messages, and MAP-UnstructuredSS-Request messages.
- Announcements (IVR) and USSD Menus
  Call Control Framework (CCF) provides support for menu driven announcements using IVRs and interactive USSD service menus that give subscribers options for retrieving and updating their balances and account details.
- Apache FreeMarker Template Configuration
  You can configure Apache FreeMarker templates for handling Call Control Framework (CCF) services such as Unstructured Supplementary Service Data (USSD) query and call back services, and menu services using announcements or interactive USSD menus.
- Mobile Application Part (MAP) Call Outs
  MATRIXX Call Control Framework (CCF) provides support within the Charging Server for making MAP call out requests to an external platform in response to TCAP or Diameter messages that require them.
- Extending MAP Callouts
  You can extend the data used in Mobile Application Part (MAP) callout requests and results. You can include customized private extension data in the extensionContainer parameter in MAP ATI (AnyTimeInterrogation) and MAP SRI (SendRoutingInfo) operations. This feature enables you to manipulate the data sent and returned in MAP callouts, for example, to correct the digits dialed by a user when roaming.
- LDAP Callout Service
  Call Control Framework (CCF) provides support for making Lightweight Directory Access Protocol (LDAP) call out requests to an LDAP server in response to TCAP or Diameter messages that require them.
- Callout Response Data MDCs
  Call Control Framework (CCF) holds response data for Mobile Application Part (MAP) callouts and Lightweight Directory Access Protocol (LDAP) callouts for a call or a session in MATRIXX Data Container (MDC) format.
- Appendixes
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Pre-Call Announcements Using VoiceXML Scripts

Call Control Framework (CCF) supports message sequences for playing pre-call announcements using VoiceXML scripts. When MATRIXX Engine returns a VoiceXML (VXML) script ID in the response to an initial quota request, the script ID determines which VoiceXML script to run on the Interactive Voice Response (IVR) system. The subscriber can make choices, such as whether to top up their balance, through their interaction with the script.