Get 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 retrieve the list of existing notes.

Base URL

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

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

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
token	string	Your user token
phone_number	number	The phone number of the caller or calle
date	number	The timestamp of current date and time in UTC timezone

Note

All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "token": "xxxx-xxxx-xxxx-xxxx",
  "phone_number": 19170000000,
  "date": 1644245110000
}

Sample Response

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

{
    "notes": [
        {
            "msg": "Its Sales Lead",
            "date": 1644244583796,
            "agent": "103_1111111"
        },
        {
            "msg": "Follow up call made",
            "date": 1644244588263,
            "agent": "103_1111111"
        },
        {
            "msg": "Follow up call made",
            "date": 1644245110000,
            "agent": "103_1111111"
        }
    ],
    "code": 200,
    "name": "Mike",
    "tag": ""
}

Properties

These are the list of properties and its description

Property	Type	Description
msg	string	The caller existing note.
date	number	Timestamp of the saved note in UTC timezone.
agent	number	The User ID

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
404	Error	Invalid user token, Failed to authenticate token
400	Error	Parameter missing