Skip to main content

Add Notes

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 add notes to the particular caller number.

Base URL​

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

https://rest.telecmi.com/v2/user/notes/add

Required Parameters​

These are the required POST method parameters with description

Parameter NameTypeDescription
tokenstringYour user token
namestringThe name of the contact
fromnumberThe number the call came from
datenumberThe timestamp of current date and time in UTC time zone.
msgstringAdd note to the caller.
Note
All the above parameters are mandatory.

Sample JSON Request​

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"name": "Mike",
"from": 19170000000,
"date": 1644245110000,
"msg": "It is a Sales Lead"
}

Sample Response​

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

{
"status": "success",
"code": 200
}

Properties​

These are the list of properties and its description

PropertyTypeDescription
msgstringNotes added to the caller or calle

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