Cloud PBX
      Back to home
      1. Knowledge Base
      2. Cloud PBX

      Call Group Configuration

      The Call Group configuration section allows you to set and configure its settings. 

      Read more about the Call Group section in the Knowledge Base article. 


      The Call Group setup section contains the following tabs:

      General Settings

      Tracking

      Client Information Form

      Post Call API

      Predefined Transfer Routes

      Recordings

      PL/DNPL

       

      General Settings

      The “General Settings” tab allows you to configure the general settings of the Call Group. 

      The following settings are available:

      • Name: Enter the name of the Call Group. 
      • Description: Enter a brief description of the Call Group.  
      • Call Category: Select the classification of calls based on their purpose. 
      • Status: Select the current status of the Call Group. 

      Click the “Save” button to complete the settings. 

      Tracking

      The “Tracking” tab allows you to set the event tracking rules for the Call Group. 

      Read more about the Event Tracking Rules for the PBX in the Knowledge Base article. 

      Client Information Form

      The “Client Information Form” tab allows you to view and add specific fields from the existing Product to the Call Group, or create new fields. 

      These fields help the user to display the information about the lead that is already available in our Lead Stash system and add or update the information in the specific fields during the call processing.  

      Also, these fields can be used during the call processing according to the built Call Script. 

      Read more about the Call Script usage in the following Knowledge Base article. 

      https://6013559.fs1.hubspotusercontent-na1.net/hubfs/6013559/PBX%20Call%20Groups%20Configuration%203.png


      You can narrow down the search results by using the following filter: 

      • Name: Enter the name of the field. 
      • Title: Enter the title of the field. 
      • Type: Select the data type of the field (Text, Number, Dropdown). The “Dropdown” data type allows you to create the drop-down list with the pre-defined options. 
      • Validation: Select the type of the field input validation (No Validation, Length, US ZIP, UK POST CODE, Phone Number, Integer, Decimal, ISO Date, ISO Datetime, IP Address, IPv4 Only Address). 
      • Required: Select the requirement of the field input (No, Yes). 
      • Protection: Select the type of the field display protection to control how it’s viewed by operators on the Operator Dashboard during active calls or in the Call Info section (No Protection, Replace data with '--protected--', Replace data with 'x' sign, Replace data with '*' sign, Replace data with zero sign, Protector v1 (ex: myemail@gmail.com => myemail@), Protector v2 (ex: myemail@gmail.com => m******@gmail.com), Display First Half (123456 => 123***) Display Last Half (123456 => ***456), First 4 symbols (123456 => 1234**), Last 4 symbols (123456 => **3456)).
      • Status: Select the current status of the field (Active, Disabled). 

      The list of the available fields contains the following information: 

      • Name: The name of the field. 
      • Title: The title of the field. 
      • Type: The input data type of the field.  
      • Validation: The type of field input validation. 
      • Required: The requirement of the field input. 
      • Protection: The type of the field displays protection to control how it’s viewed by operators on the Operator Dashboard during active calls or in the Call Info section. 
      • Description: A brief description of the field. 
      • Status: The current status of the field (Active, Disabled). 

      To add a new field to the list, click the “Add Field(s)” button and select the type of field to add. The following options are available:

      The Add Single Field option 

      If the “Add Single Field” option is selected, fill in the following fields in the corresponding pop-up window:

      • Add field from existing product: Select the “No” option if you would like to create a new field.
        • If the option with the corresponding product is selected, select the field of this product in the “Product Field” field. 


      • Name: Enter the name of the new field. 
      • Title: Enter the title of the new field. 
      • Description: Enter a brief description for the new field. 
      • Type: Select the data type of the field (Text, Number, Dropdown).
        • If the “Number” option is selected, enter the minimum and maximum values of the data input in the “Min Value” and “Max Value” fields correspondingly.

        • If the “Dropdown” option is selected, enter the allowed options for the selection in the “Acceptable Values” field. 


      • Validation: Select the type of the field input validation (No Validation, Length, US ZIP, UK POST CODE, Phone Number, Integer, Decimal, ISO Date, ISO Datetime, IP Address, IPv4 Only Address). 
      • Required: Select the requirement of the field input (No, Yes). 
      • Protection: Select the type of the field display protection to control how it’s viewed by operators on the Operator Dashboard during active calls or in the Call Info section (No Protection, Replace data with '--protected--', Replace data with 'x' sign, Replace data with '*' sign, Replace data with zero sign, Protector v1 (ex: myemail@gmail.com => myemail@), Protector v2 (ex: myemail@gmail.com => m******@gmail.com), Display First Half (123456 => 123***) Display Last Half (123456 => ***456), First 4 symbols (123456 => 1234**), Last 4 symbols (123456 => **3456)). Note: The following setting protects data for displaying for the following system roles: PBX Operator, PBX Editor, PBX Outbound Operator, and PBX Department Manager. Note: This setting is not available for the drop-down field type. 
      • Status: Select the current status of the field (Active, Disabled). 

      Click the “Add” button to complete the field creation. 

       

      The Import from Json option

      If the “Import from Json” option is selected, fill in the following fields in the corresponding pop-up window:

      • Action On Duplicate: Select the action that will be performed for the duplicate field records (Ignore new value, Overwrite value).  
      • File: Select the file for the uploading and data importation. 

      Click the “Import” button to start the importation process. 


      To view the sample of the file with the data format used for the proper importation, click the “Download sample file” button. 


      The Import from LMS/Call Logic product option

      If the “Import from LMS/Call Logic product” option is selected, fill in the following fields in the corresponding pop-up window:

      • Action On Duplicate: Select the action that will be performed for the duplicate field records (Ignore new value, Overwrite value).  
      • Product Id: Select the product from which all fields should be added.

      Click the “Import” button to start the importation process. 


      Note: By using this approach all product fields will be added with the inactive status. You should activate them before further usage. 


      To edit and configure the existing field, click the “Edit” button in the “Actions” column. Proceed with the corresponding amendments in the ”Edit” pop-up window, and click the “Save” button to complete the changes.


      To remove the field from the list, click the “Delete” button in the “Actions” column. 


      Post Call API

      The “Post Call API” tab allows you to create, manage, and delete the API Key record. This Key allows you to send the information about the lead to the Lead Stash and store it. 


      The list of API Keys contains the following information:

      • Created: The date and time of the API Key creation. 
      • Name: The name of the API Key record. 
      • Status: The current status of the API Key record. 
      • Nickname: The nickname of the related user. 
      • User Status: The current status of the related user. 
      • Get Data: The availability to get data from the Lead Stash.
      • Set Data: The availability to send data to the Lead Stash.
      • API Id: The unique identification number of the API Key.

      To create a new API Key record, click the “Add New API Key” button and fill in the following fields in the “Add New API Key” pop-up window:

      • Name: Enter the name of the API Key record. 
      • Nickname: Select the related user. 
      • Set Data: Select the availability to send data to the Lead Stash (Active, Disabled). 
      • Get Data: Select the availability to get data from the Lead Stash (Active, Disabled). 

      Click the “Add” button to complete the action. 


      To view the API Key record, click the “Show” button in the “API Password” field. 

      To view the API documentation related to the corresponding API Key record, click the “Doc” button on the “Actions” column. 

      To edit the existing API Key record, click the “Edit” button on the “Actions” column. Change the required information in the “Edit” pop-up window and click the “Save” button to complete the changes. 


      To change the password for the API Key record, click the “Change API Password” button in the “Actions” column. Confirm the password changes by clicking the “Yes” button in the “Change API Password” pop-up window. 


      To remove the API Key record, click the “Delete” button in the “Actions” column. Confirm the API Key record deletion by clicking the “Yes” button in the “Delete” pop-up window. 

      Predefined Transfer Routes

      The “Predefined Transfer Routes” tab allows you to create and set up custom call transfer routes. You can reroute call processing to a particular phone number, IVR, or Campaign within Cloud PBX or Call Logic.    


      You can narrow down the search results by using the following filters:

      • ID: Enter the unique identification number of the predefined route. 
      • Name: Enter the name of the predefined route. 
      • Status: Select the current status of the predefined route (Active, Deleted, Disabled).  
      • Direction: Select the type of the predefined route direction (Call Logic IVR, Call Logic Campaign, Phone number). 

      The list of the predefined routes contains the following information:

      • ID: The unique identification number of the predefined route. 
      • Name: The name of the predefined route. 
      • Status: The current status of the predefined route.  
      • Direction: The type of the predefined route direction
      • Description: A brief description of the predefined route. 

      To add a new predefined route to the list, click the “Add New Record” button and fill in the following fields in the “Add New” pop-up window:

      • Name: Enter the name of the predefined route. 
      • Description: Enter a brief description of the predefined route. 
      • Direction: Select the type of the predefined route direction (Call Logic IVR, Call Logic Campaign, Phone number). 
        • If the “Call Logic IVR” option is selected, select the corresponding IVR in the  “Item ID” field. 
        • If the “Call Logic Campaign” option is selected, select the corresponding campaign in the “Item ID” field. 
        • If the “Phone number” option is selected, enter the corresponding phone number in the “Phone Number” field. 
      • Inbound Phone Number: Select the corresponding inbound phone number. 

      Click the “Add” button to complete the action. 


      To manage settings of the predefined route, click the “Configure” button in the “Actions” column. 


      The “Predefined Transfer Route” section contains the following tabs:


      The “General” tab

      The “General” tab contains the following settings:

      • Name: Enter the name of the predefined route. 
      • Description: Enter a brief description of the predefined route. 
      • Status: Select the current status of the predefined route (Active, Disabled). 

      Click the “Save” button to complete the settings. 


      The “Direction” tab

      The “Direction” tab contains the following settings:

      • Direction: Select the type of the predefined route direction (Call Logic IVR, Call Logic Campaign, Phone number). 
        • If the “Call Logic IVR” option is selected, select the corresponding IVR in the  “Item ID” field. 
        • If the “Call Logic Campaign” option is selected, select the corresponding campaign in the “Item ID” field. 
        • If the “Phone number” option is selected, enter the corresponding phone number in the “Phone Number” field. 
      • Inbound Phone Number: Select the corresponding inbound phone number. 

      Click the “Save” button to complete the settings. 


      The “SIP Headers” tab 

      The “SIP Headers” tab contains the information about available and added SIP Headers records. The SIP Headers allow you to send additional data during a call transfer, such as caller ID, routing details, or custom metadata. This ensures accurate call routing and supports better tracking and reporting. 


      You can narrow down the search results by using the following filters:

      • ID: Enter the unique identification number of the SIP Header record. 
      • Format: Select the value format (DEC, HEX, Plain Text). 

      The list of available SIP Header records contains the following information:

      • ID: The unique identification number of the SIP Header record. 
      • Name: The name of the SIP Header record. 
      • Value: The value of the SIP Header record. 
      • Description: A brief description of the SIP Header record. 
      • Format: The format of the SIP Header record value. 

      To add a new SIP Header record to the list, click the “Add New Record” button and fill in the following fields in the “Add New” pop-up window:

      • Header Name: Enter the name for the SIP Header record. The SIP header is a part of a SIP message used to convey metadata and instructions about a communication session, such as a voice call. SIP headers are defined in plain text. 
      • Header Value: Enter the value for the SIP Header record. To view the list of available placeholders, click the “Show available placeholders” button. A SIP value is the data assigned to a specific SIP header and provides instructions for managing a SIP call. The value is what gives meaning to the header, such as identifying the caller, recipient, or session details. SIP headers are defined in plain text.


      • Value Format: Select the format of the value (DEC, HEX, Plain Text). SIP headers are typically in plain text format, which is human-readable and used in standard SIP communications. For debugging or low-level transport, headers may appear in hexadecimal (encoded for transport) or decimal (binary analysis), but these formats are rare. We recommend using plain text for regular implementations, as defined by the SIP protocol standards. 
      • Description: Enter a brief description for the SIP Header record. 

      Click the “Add” button to complete the SIP Header record adding. 


      To edit the existing SIP Header record, click the “Edit” button in the “Actions” column. Change the corresponding information about the SIP Header record in the “Edit” pop-up window, and click the “Edit” button to save changes. 


      To remove the SIP Header record from the list, click the “Delete” button in the “Actions” column. 

      Confirm the deletion operation by clicking the “Delete” button in the “Delete” pop-up window. 


      To remove the predefined route from the list, click the “Delete” button in the “Actions” column. 

      Confirm the deletion operation by clicking the “Delete” button in the “Delete” pop-up window. 

      Recordings

      The “Recording” tab allows you to manage the call recording, numerical data redaction, and keyword search options for a particular Call Group. 

      These settings can be set for the Call Group, Queue, and Operator levels. The settings set on the Call Group level is applied by default. The settings set on the Queue level override the Call Group level. The settings set on the Operator level override the Call Group level. 

      Note: This option is available for the Enterprise package only. 

      Note: The corresponding additional features, such as Call Recording, Keyword Search, Numerical Data Redaction, and Speech to Text should be enabled in the System Subscriptions section before enabling on the Call Group level. 


      The following settings are available: 

      • Numerical Data Redaction: Allows you to perform redaction of any numeric data, such as bank account, credit card, or social security numbers, from the audio recording of the conversation or during the conversation. To turn on or turn off this feature select the “Enabled” or “Disabled” options respectively. 
      • Keyword Search: Allows you to search for phrases or keywords in audio recordings. To activate the feature, you need to have the Speech to Text enabled. To turn on or turn off this feature select the “Enabled” or “Disabled” options respectively. 
      • Operator Call Recording: Select the call recording option for related operators (All, Disabled, Incoming, Outgoing). 
      • Queue Call Recording: Select the call recording option for related queues (Active, Disabled). 
      • SIP Trunk Call Recording: Select the call recording option for SIP Trunks (All, Disabled, Incoming, Outgoing). 

      Click the “Save” button to complete the settings. 

      PL/DNPL

      The “PL/DNPL” tab allows you to add Present or Do Not Present lists to the Call Group. The corresponding PL or DNPL lists can be created in the “Present & Do Not Present Lists” section (PBX Management > Additional settings > Present & Do Not Present Lists section). 

      Select the Present or Do Not Present list that you would like to assign to the Call Group in the “Select PL/DNPL to apply to this CallGgroup” field. 

      Click the “Save” button to complete the settings. 


      To copy the existing PL/DNPL settings to another Call Group, check the “Copy PL/DNPL settings to other Call Groups” box and select the corresponding Call Groups in the “Select More Call Groups” field. 

      Click the “Save” button to complete the settings.