Ingress Send Relay
- Alexander Conroy
This API allows you to manually trigger a Relay. 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 by sending to a specific Relay in TLDialer, or to send a Relay to another configured webhook.
Endpoints: /api/ingress/relays/send
Methods: POST
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/relays/send
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: Send a Relay
Endpoint: /api/ingress/relays/send
Method: POST
Parameter | Required | Format | Description |
|---|---|---|---|
| ✓ | int | TLDCRM Lead ID |
| ✓ | int | Specifies a Relay to Send lead data through. |
| ✘ | int | If a Policy ID is present with no Lead ID we lookup the Lead ID via the Policy ID |
| ✘ | decimal (4 right digits) | If Price is set the Relay log will log a price. Useful for third party cost tracking via Relays. |
Note: This API will ignore Lead in Trash or Negative Statuses such a Merged.
JSON Request Lead Object
{
"lead_id": 3844794,
"relay_id": 86,
"price": "1.1234"
}JSON Request Policy Object
{
"policy_id": 235126,
"relay_id": 86,
"price": "1.1234"
}Note: If you provide a Policy ID and a Lead ID we will bypass the Policy lookup and just validate the Lead ID
JSON Success Object
{
"message": "Relay Sent",
"lead_id": 3844794,
"relay_id": 86,
"price": "1.1234"
}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. |
No Lead or Policy ID Provided. | Check |
No Relay ID Provided | Check |
Lead does not Exist | Check |
Policy does not Exist | Check |
Relay does not Exist | Check |
Relay is not active | Check Relay configuration under |
Â