In This Article:

How to add and delete an API Plugin.

This feature enables Agents to send a Lead's information to a third-party CRM with a click of a button and without ending the phone call.

There are situations where you need to talk to a third-party Representative before transferring a call, this is helpful so the Transfer Representative can see the information of the Lead before receiving the transferred call.

 

Contents:

• Add an API Plugin
• Attach this Plugin to the Script
• Deleting an API Plugin

 

Add an API Plugin

1. ) Click the Apps main menu.

2.) Click the Plugins menu option.

3.) Click the Add Plugin button.

The Add a Plugin page will open.

4.) Make a selection in the Type field first as this selection changes the fields shown in the Add a Plugin section of this page.

• Select API Transfer from the drop-down options.

5.) Configure the following field in the Add a Plugin section:

• A: Name
  Enter a descriptive name for the API Plugin.
• B: Type
  Select API Transfer from the drop-down options.
  • There are different fields that will show in the Add a Plugin section of this page for each option.
• C: Plugin Label
  Enter a name for the Button.
  • For Example: Click Here!, Get Result!, Get Quotes!, Submit!, etc.
• D: Convoso Connect
  Select a Convoso Connect
  • Click here for more information. Adding a Convoso Connect
• E: Response Element Name
  Enter the provider's Response Element Name.
  • This should be supplied by the CRM.
    • For Example: in the string <result>success</result>, the element name will be 'result'
• F: Response Success Value
  Enter the provider's Response Success Value.
  • This should be supplied by the CRM.
    • For Example: in the string <result>success</result>, the value will be 'success'
• G: Override Transfer Number Type
  Select the location type for the Override Transfer Number.
  When enabled additional fields appear to further define this location.
  
  • Disable
  • API Response Element
    • Override Transfer Number Element Name:(ex: <transfer_number>8884565454</transfer_number>, element name will be 'transfer_number')
    • Override Number includes Country Code: A Yes or No toggle
  • Field
    • Override Transfer Number Field: A drop-down with Custom Phone Number Fields
• H: Plugin Failed Message
  Enter the message that indicates the process failed.
  • For Example: 'Failed to process request! or Lead not matched!'
• I: Action Options
  Select the Transfer Method this Plugin will do.
  • 3 Way Conference Call - Auto Dial
  • 3 Way Conference Call - Manual Dial
  • Blind Transfer
• J: Status
  To enable the Plugin, set it to Active.
• K: Delay Seconds
  If needed, enter the number of seconds before transferring the call.
• L: Transfer Number
  Enter the number for the transfer phone number for this Plugin. 
  • Ability to add multiple transfer numbers and prioritize the transfer number by percentage. The higher the percentage the higher the prioritization.

6.) Click the Create Plugin button.

Attach this Plugin to the Script 

• To learn more about changing Scripts, see Edit a Script.
• To learn more about how to auto-launch Scripts, Call Launch Settings for a Campaign.

1.) Click the CRM main menu

2.) Click the Scripts menu option.

The Show Scripts page will open.

3.) Click the Name of the Script, or click the Action drop-down in the Action column of the Script and select the Settings drop-down option.

The Edit Script page will open.

4.) Right-Click on any element of the Script.

5.) Click the Edit drop-down option.

The Edit Point window will open.

6.) In the Available Plugins field, select the API Plugin from the drop-down.

7.) Click the blue Insert button.

The Plugin will show in the Text field as part of the Script.

8.) Click the green Apply button to save the Script.
The Edit Point window will close.

The Plugin is now attached to the Script.

• Here is an example of the Script an Agent will see when they login to the Campaign:

Deleting an API Plugin

In order to delete the API Plugin, you need to remove or unassign it from other applications.

1.) Open the Show Plugins page and find the API Plugin.

2.) In the Action column of the Plugin, click the Action drop-down button.

3.) Click the Delete drop-down option.

A Deletion Confirmation window will open.

• If the API Plugin has not been removed from other applications, the window will show where the Plugin needs to be removed from.
• Click the View button to open a separate Browser Tab for the settings where this API Plugin is used.
  

• Return to the Browser Tab with the Deletion Confirmation window once the API Plugin is removed from other applications.

4.) Click the Refresh button, the window will confirm that you are sure you want to delete the Plugin.

• For multiple Items that the Plugin is attached to, each time you remove it from another application you can return to this page to click Refresh, then click View again for the next item. 

5.) Click the Delete button.

• Click the Cancel button to abort the deletion process.

The Deletion Success window will open.

6.) Click the Close button to close the window and return to the Show Plugins page.