Fetch notes against customer Number

Sample Request

curl --request GET \
     --url https://api-smartflo.tatateleservices.com/v1/call/notes/client_number \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Path Params)

The following parameter is required to fetch notes against Customer Number.

Variable Name	Description	Data Type
client_number	Number of the customer.	String

Request Variables (Query Params)

The following parameter is required to fetch notes against Customer Number.

Variable Name	Description	Data Type
limit	Number of records to be fetched.	string
page	Index of the page.	string

Sample Response

{
    "count": 2,
    "limit": 10,
    "page": 1,
    "results": [
        {
            "_id": "663a0a752b66f80b611f5d53",
            "calldate": {
                "$date": {
                    "$numberLong": "1715079792000"
                }
            },
            "call_hint": "inbound",
            "notes": {
                "message": "Hi, this is another test note.",
                "created_by": "TATA.CDP",
                "name": "TATACDPTEST"
            },
            "readableTime": "07-05-2024 16:33:12",
            "date": "07-05-2024 16:33:12"
        },......
    ]
}

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
count	Number of actual records fetched.	String
limit	Number of records to be fetched.	String
page	Index of the page.	String
results[]._id	Unique ID of the note.	String
results[].calldate.$date.$numberLong	Time of the call.	String
results[].call_hint	Type of the call. For example: Inbound, Outbound, etc.	String
results[].notes.message	Note added to the call.	String
results[].notes.created_by	Client ID of the client.	String
results[].notes.name	Company name of the client.	String
results[].date	Originated date/time of the call.	String