Lead Upload Custom

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. This documentation covers the endpoints for creating leads in the TeleCMI Dialer system. Use this endpoint when you want to provide your own unique identifiers (UUIDs) for each lead.

Base URL

Send your POST method request with valid parameters and application/json content type, to the following base URL.

https://rest.telecmi.com/v3/leads/add-custom

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*lead_name	string	Unique name for this lead group/campaign.
*inet_no	integer	Your account identification number.
*secret	string	API authentication token.
*leads	array	Array of lead objects (Min: 1, Max: 1000).

Lead Object (leads array)

Field	Type	Required	Description
*lead_id	string	Yes	Must be a valid UUID. Used as the primary key.
*phone	string	Yes	Lead phone number (e.g., 919876543210).
firstname	string	No	First name of the lead.
lastname	string	No	Last name of the lead.
email	string	No	Email address (must be a valid format).
comment	string	No	Additional notes.
address	string	No	Physical address.
city	string	No	City.
country	string	No	Country.

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "lead_name": "Sales_Q2_Campaign",
  "inet_no": 1111112,
  "secret": "your_api_secret_token",
  "leads": [
    {
      "lead_id": "550e8400-e29b-41d4-a716-446655440000",
      "phone": "919876543210",
      "firstname": "John",
      "email": "john.doe@example.com"
    }
  ]
}

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
  "code": 200,
  "msg": "Leads Added Successfully"
}

Properties

These are the list of properties and its description

Property	Type	Description
code	number	The response code.
msg	string	Leads Added Successfully

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status code	Status Type	Description
200	Success	Leads Added Successfully
400	Error	Duplicate lead_id Found
400	Error	lead_id Already Exists
400	Error	Duplicate Phone Numbers Found
400	Error	Lead Name Already Exists
404	Error	Account Not Found (Invalid secret or inet_no)
422	Error	Schema validation failed (e.g., missing required field)