Get Contact

Each agent API request in TeleCMI platform includes agent login token. After getting the agent 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.

https://piopiy.telecmi.com/v1/getContact

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*token	string	Your agent token
*page	number	The Number of page per 10 record.
limit	number	The Number of record for request, By default the limit is 10.
name	string	The name of the contact.

Note

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",
            "inet_no": 1111112,
            "name": "Mike",
            "mobile": 9100000000,
            "tag": "callback",
            "time": 1629980029850,
            "remindme": 1630056656976,
            "status": "close"
        }
    ],
    "code": 200
}

Properties

These are the list of properties and its description

Property	Type	Description
agent	string	The agent ID for the saved contact
inet_no	number	The App ID
name	string	The name of the saved contact
mobile	number	The phone number of the saved contact
tag	string	The tag assigned for the saved contact
time	number	Timestamp of the saved contact
remindme	number	Timestamp for the next remainder
status	string	The current status of the saved contact

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	Invalid app id or secret, authentication failed, Missing parameter