LinQ2 P-Series Voice Integration Channel v1.0

LinQ2 P-Series Voice Integration Channel v1.0

Voice Integration

Introduction

Now Linq2 P Series supports automated voice calling feature through standard SIP providers e.g. FreePBX.  Linq2 P Series is integrated with SIP Providers by using the following approach/steps.

 

  • Configure SIP account inside your organizations PBX, if not already exist then FreePBX connected to SIP truck can be used.
  • Configure SIP service and related SIP parameters in the P Series portal.
  • Setup the Voice templates and voice template clips in the P Series Voice module. 
  • VOICE NOTIFICATION can be requested in the XML or Rest request by MQ or WebService integration channels. 
  • LinQ2 P-Series, extracts the voice template along with the optional parameters from incoming requests and dials the given voice recipient number (mobile phone/landline) using the configured SIP account as per the configurations in the system.
  • Coming soon, A VOICE NOTIFICATION can be initiated by using the compose screen. 




    Configuration

                                       Authorized user can configure service parameter setting from configuration >LinQ2 resources > Voice - Show List > LinQ2 page. 


 

Screen 1 – LinQ2 P-Series Voice backend management_1

 

 

Screen 2 – LinQ2 P-Series Voice backend management_2

 

 

 

 Voice Module and Voice Template Configuration



Authorized user can configure voice templates from Voice module in the LinQ2 P Series portal. 

 

Ref: - Screen 3 – P Series Voice Management Module

 

 

 

Voices used by the P Series Voice Module must be placed in the folder pointed by the system setting “Voice Files Path” defined in the configuration >LinQ2 resources > System - Show List > System page. 

To be used by the Voice messaging system use Voice > Voice Clips > Refresh button to reload the contents of the available voice files.

Ref: - Screen 4 – P Series Voice Clips

 

​

The voice calls placed to the recipient phone is defined by “Voice Templates”. 

 

Ref: - Screen 5 – P Series Voice Templates_1 

 

 


 

Each voice template is a set of “call steps”. A call step can be a “start step” used as the first item when the call is initiated. A call step can also be an “end step” that terminates/ends the call. A voice template can have only one start step but one or more end steps. Call step can be of one of two types “fixed” or “parameter”.

Each step is linked to a voice clip that is to be played when the step is executed when the step is of fixed type.  

If step is of parameter type the digits in the provided voice parameter are played.

Ref: - Screen 6 – P Series Voice Templates_2

 



Each voice step can have 0 or 1 step condition, if the condition is blank then the next voice step is played immediately without waiting for the input from the end user.


 

Ref: - Screen 7 – P Series Voice Templates Step Conditions

 

 


 

Monitoring and Control

Voice handler service is available in services list. Authorized user can login in to LinQ2 system and can monitor the status of Voice handler service and recent errors and warning from status monitor section. User can also start and stop the Voice handler service from this section.

 

Ref: - Screen 8 – LinQ2 Voice handler Service Status Monitoring and Control

 

 

 

Screen 9 – LinQ2 Voice handler Service Error Monitoring

 

 

     Before You Apply Test

For samples and full structure details of LinQ2 XML format please take a look at “LINQ2 XML STRUCTURE” document.


Test Cases


Test 1 - Duplicate Event Id test


Test

Duplicate Event Id

Interface

Queue

Pre-conditions

 

  • Request is having duplicate event id

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • Complain Error for duplicate event in error log.
  • No VOICE NOTIFICATION has been sent.
  • Event has not been logged because of duplicate event.

 

Actual Result

 



Test 2:- Invalid XML

Test

Invalid XML

Interface

Queue

Pre-conditions

XML is not correct according to specify format

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • Complain Error for Invalid xml in error log.
  • No VOICE NOTIFICATION has been sent.

Event has not been logged because parsing error.

Actual Result

 

 

 

 

 



Test 3:- Send VOICE NOTIFICATION to direct recipient.

Test

Send VOICE NOTIFICATION to direct recipients

Interface

Queue

Pre-conditions

  • Event id is not duplicate.
  • XML is in the proper format according to the format used by the queue handler
  • Proper push template code is defined in the P-Series portal 
  • The correct voice template code is specified in the XML message
  • The Default Queue Handler service is active and running 
  • The VOICE NOTIFICATION handle service is active and running 

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

 

  • 1 VOICE NOTIFICATION call is initiated according to the selected voice template step and conditions  
  • Event has been logged with event id

 

Actual Result

 

 

 

 

 

 



Test 4- Arabic VOICE NOTIFICATION message from Queue

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 VOICE NOTIFICATION Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • Message will be sent and will be showing in push message report.

Record will be updated in PUSH_OUT in column SMS_STATUS (702).

Actual Result

 



 Test 1 - Duplicate Event Id test

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 VOICE NOTIFICATION Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • Message will be sent and will be showing in push message report.

Record will be updated in PUSH_OUT in column SMS_STATUS (702).

Actual Result

 


Test 6- Rejecting message after specified number of tries.

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 VOICE NOTIFICATION Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.
  • The VOICE NOTIFICATION Queue Handler service is active and running 
  • The VOICE NOTIFICATION handle service is active and running 
  • Max tries for sending message fails.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • P-Series tries to send the VOICE NOTIFICATION for configured number of tries
  • After failure attempts the message is marked as rejected 

Record will be updated in PUSH_OUT in column SMS_STATUS (703).

Actual Result

 

 


Test 6- Rejecting message after specified number of tries.

Test

Extract message and his parameter from xml content 

Interface

Queue

Pre-conditions

  • LinQ2 VOICE NOTIFICATION Service should be enabled and running.
  • XML Should valid.
  • XML should contain Push recipient.
  • Message tag should exist is the PushWoosh portal and its value should be correctly set on the mobile device.
  • Notification Method value should be 00001.
  • The VOICE NOTIFICATION Queue Handler service is active and running 
  • The VOICE NOTIFICATION handle service is active and running 
  • Max tries for sending message fails.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • P-Series tries to send the VOICE NOTIFICATION for configured number of tries
  • After failure attempts the message is marked as rejected 

Record will be updated in PUSH_OUT in column SMS_STATUS (703).

Actual Result

 

 


Test 7- Receive INVALID_REQUEST while sending VOICE NOTIFICATION.

Test

Internal Error occurred while processing your request due to any reason

Interface

Queue

Pre-conditions

  • LinQ2 VOICE NOTIFICATION Service should be enabled and running.
  • Notification Method value should be 00001.
  • The VOICE NOTIFICATION Queue Handler service is active and running 
  • The VOICE NOTIFICATION handle service is active and running 
  • Max tries for sending message fails.

 

Request

Check doc LinQ2 XML Structure Description for samples.

 

Expected Result

  • P-Series tries to send the VOICE NOTIFICATION for configured number of tries
  • After failure attempts the message is marked as rejected 
  • Record will be updated in PUSH_OUT in column SMS_STATUS (703).

Actual Result

 

 

© 2024 Cerebra All Copyrights Reserved

    • Related Articles

    • Release Note - Voice Module [P-Series - V 4.1.0] - Internal

      LinQ2 P-Series Voice Release Notes This release contains Voice module & integration in LinQ2 P-Series: Introduction: Now Linq2 P Series supports automated voice calling feature through standard SIP providers e.g. FreePBX. Linq2 P Series is integrated ...

    • LinQ2 P-Series Push Notifications Integration Channel v1.1

      Push Notification Integration 1.1 Introduction Linq2 is integrated with Push Providers (PushWoosh/OneSignal/Google FCM) by using following approach. Push notification can be requested in the XML or Rest request by MQ or WebService integration ...

    • LinQ2 P-Series XML Structure Description v 2.0

      This document explains LinQ2's XML structure, which uses ar XML File Channel Element Type Max. Len Rep Allowed Values Mandatory Description Evnt_Id Text 10 1 N/A Y Unique Event Identifier. Evnt_Source Text 10 1 ‘OMS’, ‘CRM’ Y Event source. Put here a ...

    • LinQ2 P-Series Xml File Integration Channel

      XML File Integration 1.1 Introduction This interface allows sending requests to LinQ2 through xml file saved in UTF 8 format. Linq2 application will read this file from already defined source directory. In case of successful processing this file will ...

    • LinQ2 P-Series Database Integration Channel

      Data base Integration 1.1 Introduction LinQ2 application has a database monitor component to pull messages from database other then linQ2 database. LinQ2 database monitor can pull message information from the database table and send it to appropriate ...