Fetch notes against Customer Number

This API allows you to fetch notes for a particular customer number.

Sample Request

curl --request GET \
     --url https://api.servetel.in/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 NameDescriptionData Type
client_numberNumber of the customer.String

Request Variables (Query Params)

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

Variable NameDescriptionData Type
limitNumber of records to be fetched.string
pageIndex of the page.string

Sample Response

{
    "count": 3,
    "limit": 10,
    "page": 1,
    "results": [
        {
            "_id": "6634878ca7cf3f2b6445a47a",
            "calldate": {
                "$date": {
                    "$numberLong": "1714718592000"
                }
            },
            "call_hint": "inbound",
            "notes": {
                "message": "jgasjdhjbajhd",
                "created_by": "client02",
                "name": "web4"
            },
            "readableTime": "03-05-2024 12:13:12",
            "date": "03-05-2024 12:13:12"
        },....
    }

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
countNumber of actual records fetched.String
limitNumber of records to be fetched.String
pageIndex of the page.String
results[]._idUnique ID of the note.String
results[].calldate.$date.$numberLongTime of the call.String
results[].call_hintType of the call. For example: Inbound, Outbound, etc.String
results[].notes.messageNote added to the call.String
results[].notes.created_byClient ID of the client.String
results[].notes.nameCompany name of the client.String
results[].dateOriginated date/time of the call.String
Language
Click Try It! to start a request and see the response here!