com.innovaphone.calllist (App API)

This API is used for communication with call-list apps.

Write documentation

API model

Service info

The API doesn't define any service info.

Provider model

{
  "mt": "ApiModel",
  "api": "com.innovaphone.calllist",
  "model": {
  }
}

API messages

All messages are JSON objects that have a mandatory attribute "mt" that specifies the message type.

Requests

Subscribe

Caller declares that it is interested in call list entries.

Call list app will provide the requested amount of available call list entries.

Call list app wil also provide new entries at runtime.

count: Number of currently available entries that are to be returned immediately.

Example:

{
    "mt": "Subscribe",
    "count": 20
}

Responses

Update

Call list app sends this message in direct response to "Subscribe" message.

Call list app sends this message every time a new entries has been added.

entries: Array of call list entries.

Example:

{
    "mt": "Update",
    "entries": [
        {
          "cdr": 21173,
          "sip": "tac",
          "id": "c06ab5ee-cc1c-5c01-8a68-009033420759",
          "dir": "o",
          "node": "root",
          "phys": "",
          "cause": 0,
          "time": 1545391345000,
          "alert-duration": 12,
          "call-duration": 0,
          "conn-duration": 0,
          "billing-duration": 0,
          "call": "int",
          "remote": {
            "number": "40",
            "sip": "rh",
            "dn": "Ralf Hütter"
          },
          "status": "al"
        },
        {
          "cdr": 20713,
          "sip": "tac",
          "id": "2d61b691-9c1b-5c01-ed7a-009033420759",
          "dir": "i",
          "node": "root",
          "phys": "berlin",
          "cause": 0,
          "time": 1545313426000,
          "alert-duration": 7,
          "call-duration": 2814,
          "conn-duration": 2814,
          "billing-duration": 0,
          "call": "int",
          "remote": {
            "number": "683",
            "sip": "fs",
            "dn": "Florian Schneider"
          },
          "status": "co"
        },
    ]
}

Details:

dir: "i" (inbound call) or "o" (outbound call)
time: UTC timestamp
cause: the decimal disconnect reason of the call (see Reference:ISDN_Cause_Codes)
call: "int" (internal call) or "ext" (external call)
status: "co" (connected), "al" (alert), "er" (error) or "bu" (busy)

Clear

Call list app sends this message to subscriber when ever the call list (database) have been cleared.

Example:

{
    "mt": "Clear"
}