Ingress Hopper
- Alexander Conroy
This API allows you to manually add a lead into the Hopper. Some Agencies find using this works well with third party applications where a client showed interest for an immediate call, and already being a client or lead in the system TLD can initiate a higher priority auto outbound in an auto outbound campaign. There may be some use for removing a lead from a hopper should the client cancel their request quickly.
Endpoints: /api/ingress/hopper
Methods: POST, DELETE
API Version Support: v1
Security Notice: Please make sure to use API | Endpoint Protection when giving this access to third party systems as API Keys are unprotected unless specified.
The proper endpoint protection to set for an API using this Endpoint is /api/ingress/hopper
Data Formats Supported
form-data, x-www-form-urlencoded Form Parameters or JSON Body with Content-Type: application/json set.
Response Codes
200: Success and Warnings
400: Error
Add: Add a Lead to the Hopper
Endpoint: /api/ingress/hopper
Method: POST
Parameter | Required | Format | Description |
|---|---|---|---|
| ✓ | int | TLDialer Lead ID. Not TLDCRM Lead ID. |
| ✘ | string | Specifies a Campaign, Fallsback to Leads List Campaign ID. |
| ✘ | int | Priority for next Dial. |
JSON Request Object
{
"lead_id": 721,
"campaign_id": 10,
"priority": 50
}JSON Success Object
1JSON Error Object
{
"error": "Lead is already in the Hopper"
}Delete: Remove a Lead from the Hopper
Endpoint: /api/ingress/hopper
Method: DELETE
Parameter | Required | Format | Description |
|---|---|---|---|
| ✓ | int | TLDialer Lead ID. Not TLDCRM Lead ID. |
| ✘ | string | Specifies a Campaign, Fallsback to Leads List Campaign ID. |
JSON Request Object
JSON Success Object
Error JSON Error Object
Errors Possible
Error | Resolution |
|---|---|
No API ID Provided | Check API ID in Header or Parameters. See API | Using API ID and API Key |
No API Key Provided | Check API Key in Headers or Parameters. See API | Using API ID and API Key |
TLDialer Not Enabled | Contact TLD Support to Enable or Investigate. |
TLDialer Connection Error | Contact TLD Support to Investigate a Database Issue. |
Missing Lead ID | Check |
Lead does not Exist | Check |
Campaign does not Exist | Check |
Lead is already in the Hopper | Lead is already in the Hopper. |
Could not Add Lead to Hopper | Insertion Error. Contact TLD Support. |
Â