ViciDial

Overview

This guide outlines how to configure a seamless plugin from Taalk to ViciDial using the ViciDial Non-Agent API. This integration enables Taalk’s AI Agents to automatically push leads into a live ViciDial campaign based on call outcomes, data capture, or business logic.

Use Case

When Taalk’s AI Agent captures key information — such as contact details, vehicle data, or address — you can push that information directly into your ViciDial list in real time, allowing for human follow-up or further AI-assisted automation.

Integration Endpoint

Base URL

http://{vici_id}.viciadmin.com/vicidial/

HTTP Method

POST

Sample URL Format

http://{vici_id}.viciadmin.com/vicidial/non_agent_api.php?source=Taalk&user=apiadmin&pass=roiapi2022&function=add_lead&phone_number=&phone_code=1&list_id=900&campaign_id=Closer&first_name=&last_name=&address1=&city=&state=&postal_code=&VehicleMake=&VehicleModel=<vehicle_model|taalk_vehiclemodel>&VehicleYear=&VehicleMileage=&comments=&custom_fields=Y&taalk_vendor_lead_code=RTAI</vehicle_model|taalk_vehiclemodel>

Implementation Notes

•Replace < > placeholders with dynamic data from your Taalk contact profile or AI Agent transcript parsing.

•Taalk can map internal fields like Taalk_VehicleModel to the required API parameter through your plugin setup.

•Custom fields must be preconfigured in your ViciDial list if you use the custom_fields=Y option.

Example Dynamic Injection in Taalk Plugin

{
  "plugin_url": "http://{vici_id}.viciadmin.com/vicidial/non_agent_api.php",
  "method": "POST",
  "params": {
    "source": "Taalk",
    "user": "apiadmin",
    "pass": "roiapi2022",
    "function": "add_lead",
    "phone_number": "",
    "phone_code": "1",
    "list_id": "900",
    "campaign_id": "Closer",
    "first_name": "",
    "last_name": "",
    "address1": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "VehicleMake": "",
    "VehicleModel": "",
    "VehicleYear": "",
    "VehicleMileage": "",
    "comments": "",
    "custom_fields": "Y",
    "taalk_vendor_lead_code": "RTAI"
  }
}

Best Practices

•Throttle Injection: Use throttling if injecting at scale to avoid rate limits or overload on ViciDial.

•Log Responses: Always log the response from ViciDial for audit and error-tracking.

•Custom Field Mapping: Ensure all custom fields in the URL match pre-existing fields in ViciDial’s system or the lead will be partially rejected.

•Campaign Readiness: Confirm the list_id and campaign_id exist and are actively configured to accept new leads.

Next Steps

To set this up in your Taalk instance:

1. Download from Taalk Marketplace for default plugin Templates

2. Create a Plugin from the Ground Up

2.1.Navigate to Plugins > Create New Plugin.

2.2.Choose “Webhook Trigger” and use the POST method with the parameters shown above.

2.3.Map your AI Agent-captured variables to the appropriate query parameters.

2.4.Test the injection with a known lead to confirm successful API call.

5. Attach the plugin to you AI Agent