Lead Upload

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. After getting the app id and secret, make a POST request to the below base URL to upload lead data to your TeleCMI Dialer campaigns. This API supports bulk uploading of leads with validation for phone numbers and other contact details.

Base URL

Send your POST method request with valid parameters, to the following base URL.

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

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*lead_name	string	A unique name for this lead campaign.
*inet_no	integer	Your App id.
*secret	string	Your app secret.
*users	array	An array of lead objects (Min: 1, Max: 1000).

Lead Object (users array)

Field	Type	Required	Description
*firstname	string	Yes	Lead's first name.
*lastname	string	Yes	Lead's last name.
*phone	string	Yes	Lead's phone number (including country code, e.g., 919876543210).
email	string	No	Lead's email address (valid format required).
comment	string	No	Additional notes or comments for the lead.
address	string	No	Lead's street address.
city	string	No	Lead's city.
country	string	No	Lead's country.
order_index	integer	No	The sequence order for this lead in the dialer.

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "lead_name": "Sales_Campaign_March_2026",
  "inet_no": 12345,
  "secret": "xxxx-xxxx-xxxx-xxxx",
  "users": [
    {
      "firstname": "John",
      "lastname": "Doe",
      "phone": "919876543210",
      "email": "john.doe@example.com",
      "comment": "Interested in Premium plan",
      "address": "123 Business St",
      "city": "Chennai",
      "country": "India",
      "order_index": 1
    },
    {
      "firstname": "Jane",
      "lastname": "Smith",
      "phone": "919876543211",
      "order_index": 2
    }
  ]
}

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	We received the request
400	Error	Lead Name Already Exists
400	Error	Duplicate phone numbers found
404	Error	Account Not Found (Invalid app id or secret)
422	Error	Parameter missing
422	Error	Invalid phone number
500	Error	Internal Server Error

Note

• Phone Format: Ensure phone numbers are provided with the country code but without the + prefix or special characters.
• Bulk Limit: You can upload up to 1000 leads in a single request.
• Unique Name: lead_name must be unique across your account's campaigns.