5.6.2 api phone calllog

The /api/phone/calllog helps you download or delete all or selected call records.

The function is part of the Phone/Call API function and the user has to be assigned the Phone/Call Access Monitoring privilege for authentication if required.

The call log provides the following information:

  • Call type
    • Incoming call (connected or declined)
    • Missed call (unanswered incoming call)
    • Completed elsewhere (incoming call answered via another device)
    • Outgoing call (regardless of the result)
    • Doorbell button
  • Contact type (icon contact setting)
  • Called / calling user ID
  • Call date and time


GET or POST Method

The function has no parameters.

The response is in the application/json format and includes the current device states:

ParameterDescription
idUnique record identification.
callType

Call type specification.

  • incoming
  • outgoing
  • missed
  • voicemail
  • completedElsewhere
  • doorbell button
devTypeInternal device identifier.
namePhone book user name specification.
dateCall record date.
durationCall duration in seconds.

The records are arranged from the newest to the oldest one according to the absolute call record time.

Caution

  • The field is empty if no logs are available.

Example:

{
  "success" : true,
  "result" : {
    "callLog" : [
      {
        "id" : ID,
        "callType" : "incoming",
        "devType" : "2-14-0-0",
        "name" : "Franta Vomáčka",
        "date" : "2027-11-06T12:23:52Z",
        "duration": 1514
      },
      {
        "id" : ID,
        "callType" : "incoming",
        "devType" : "4-13-1-2",
        "name" : "Pepa Vonášek",
        "date" : "2027-12-06T12:23:52Z",
        "duration": 15
      },
      ...
    ]
  }
}
Door bell
{
  "success" : true,
  "result" : {
    "callLog" : [
      {
        "id" : ID,
        "callType" : "doorbell",
        "date" : "2027-11-06T12:23:52Z"
      },
      ...
    ]
  }
}

DELETE Method

The function is part of the Phone/Call API function and the user has to be assigned the Phone/Call Access Control privilege for authentication if required.  

Request parameters:

Parameter

Description

id

Unique identifier of the record to be deleted.

Example:

{
  "success" : false,
  "error" : {
    "code" : 12,
    "param" : "id",
    "description" : "record not found"
  }
}