Smart Carrier | Call Shaper Module - Vicidial Integration

Smart Carrier | Call Shaper Module - Vicidial Integration

The TILTX Call Shaper Module - Vicidial Integration will connect your Vicidial to our services.  These services include STIR/SHAKEN, Caller ID Assessments, National DNC Scrubbing, Disconnected Number Analysis, and others.  

This service requires an AGI script to be run before each call is placed through your dialer(agi-TILTX_SHAKEN.agi). It will tag the call with SIP Headers with the "X-TILTX-ID", "Identity" and "CAID" values that TILTX returns so your carrier can route the call properly. There are also optional service features that allow for a National Do-Not-Call(DNC) list check and a Disconnected-number check, as well as CallerID Number validation/replacement with our NumberRisk service.

In order to use this module, you will need an API key.  To get your API Key, please contact us at support@tiltx.com.


Prerequisites:

  1. To use this feature, you will have to get a valid API Key from TILTX and create a new VICIdial Settings Container entry with the Container ID of "TILTX_SHAKEN_API_KEY", and place only the TILTX API key into the Container Entry.

  2. You will need to have the VICIdial svn/trunk revision 3449 or higher installed on all servers in your VICIdial cluster.

  3. You will need to put a similar dialplan entry into your Carrier Dialplan BEFORE the line where the call is placed out through your carrier:

    • exten => _91NXXNXXXXXX,n,AGI(/var/lib/asterisk/agi-bin/agi-TILTX_SHAKEN.agi,${EXTEN:-10}-----${CALLERID(num)}-----YES-----)

  4. NOTE: Here are the configurable CLI flags for the above AGI script:

    • Phone number being called (USE DIALPLAN VARIABLE like '${EXTEN:-10}')

    • CallerID number being sent with call (USE DIALPLAN VARIABLE like '${CALLERID(num)}')

    • (YES/NO) whether to speak error messages or not, default 'NO'

    • Settings Container ID(override) to use for TILTX API settings, default 'TILTX_SHAKEN_API_KEY' if empty

New Vicidial Status Codes (if subscribed to the respective service from TILTX):

  1. ADCCAR - Disconnect Carrier-Defined

  2. DNCCAR - DNC Carrier-Defined

Advanced Option:

  1. You can override the hard-coded TILTX Call Shaper API "https://api.shaper.tiltx.com/Calls/shaper" by adding a second line to the Settings Container that looks like the following:

Advanced Debug:

  1. To see that the SIP Headers are being set properly, add the following line to your dialplan(extensions.conf after the 8368 "Playback" line), then reload your Asterisk dialplan and place a test call through the campaign detail screen:

    • exten => 8368,n,Verbose("X-CIDNAME:${SIP_HEADER(X-CIDNAME)}, X-TILTX-ID:${SIP_HEADER(X-TILTX-ID)}, Identity:${SIP_HEADER(Identity)}, CAID:${SIP_HEADER(CAID)}")