Skip to main content

Get Contact

Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to retrieve the list of saved contact details.

Base URL

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

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*tokenstringYour user token
pagenumberThe Number of page per 10 record. By default the page is 1.
limitnumberThe Number of record for request, By default the limit is 10. Maximum limit is 10.
namestringThe name of the contact.
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

"token": "xxxx-xxx-xxxx-xxx-xxx",
"page": 1,
"limit": 10,
"name": "Mike"

Sample Response

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

"count": 1,
"contacts": [
"agent": "101_1111112",
"notes": [
"msg": "It is a Support Lead",
"date": 1629980029850,
"agent": "101_1111112"
"inet_no": 1111112,
"name": "Mike",
"mobile": 9100000000,
"tag": "callback",
"time": 1629980029850,
"remindme": 1630056656976,
"email": "[email protected]",
"info": "Sales",
"status": "Hot Lead"
"code": 200


These are the list of properties and its description

agentstringThe user ID for the saved contact
notesJSON arrayThe entire notes information of the caller or calle
msgstringThe notes information of the caller or calle
datenumberTimestamp of the added notes in UTC timezone
agentstringThe user ID for the added note
inet_nonumberThe App ID
namestringThe name of the saved contact
mobilenumberThe phone number of the saved contact
tagstringThe tag assigned for the saved contact
timenumberTimestamp of the saved contact in UTC timezone.
remindmenumberTimestamp for the next remainder in UTC timezone.
emailstringThe Email ID of the saved contact
infostringAdditional Information of the saved contact
statusstringThe current status of the saved contact

HTTP status codes

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

Status codeStatus TypeDescription
200SuccessWe received the request
404ErrorInvalid user token, Failed to authenticate token
400ErrorParameter missing, Parameter limit lesser then equals 10