Skip to main content

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 NameTypeDescription
*tokenstringYour agent token
*pagenumberThe Number of page per 10 record.
limitnumberThe Number of record for request, By default the limit is 10.
namestringThe 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

PropertyTypeDescription
agentstringThe agent ID for the saved contact
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
remindmenumberTimestamp for the next remainder
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
400ErrorInvalid app id or secret, authentication failed, Missing parameter