API : TCE box Call log

Introduction

This request is used to return logged calls that has passed through the TCE box's CPR number application and handled by the CPR logger Windows application.

Call logs are stored for a maximum of 365 days.

Request

URL	https://api.telecomx.dk/tce/TCE_ID/calllog
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER or ADMIN
Param	TCE_ID	MAC address of TCE box.
Query	offset	`[optional]` Index of the first call to return, default 0.
	limit	`[optional]` The number of calls to return, default 100, min 1, max 500.
	filter	`[optional]` Remote, local or CPR number to search for.
	fromDate	`[optional]` Date and time from when to return calls, defaults to today at 00:00.
	toDate	`[optional]` Date and time until when to return calls, defaults to now. Max span between from and to dates is 7 days.

Query examples

https://api.telecomx.dk/tce/123456789012/callog
https://api.telecomx.dk/tce/123456789012/calllog?filter=64756453&fromDate=2016-01-01T00:00:00Z&toDate=2016-01-02T12:00:00Z&offset=100&limit=100

Response

JSON object
offset	Index of the first call returned.
limit	Number of calls to return. Note that the actual number of calls returned may be lower.
total	Number of calls that can be returned when offset and limit is not considered. This is to be used for paging through the data.
calls	Array of calls, see definition below.

Call object (JSON)
id	String	Unique call ID from TCE box.
remote	String	Phone number of the remote caller.
cpr	String	CPR number of the remote caller (only applies on inbound calls that went through the CPR entry app).
local	String	Local extension number that received the call (if any).
direction	String	Call direction: IN (inbound) or OUT (outbound).
started	Date	When the call started (first seen by TCE box or CPR logger Windows app).
input	Date	When the CPR entry application started on the TCE box. Null if the call did not pass through the CPR entry application.
returned	Date	when the call returned to the PBX from the CPR entry application on the TCE box. Null if the call did not pass through the CPR entry application.
answered	Date	When the call was answered by the local extension (inbound call) or when the callee answered the call (outbound call). Null if not answered.
ended	Date	When the call ended. Null if still ongoing or end of call was not seen.

Note that properties holding no value may be omitted from the object.

Example

{
  offset: 0,
  limit: 100,
  total: 79,
  calls:
  [
    {
      id : 'AIDD6E1602C7AA3348@10.10.33.2',
      remote : '70305099',
      cpr : '2203782145',
      local : '299',
      direction : 'IN',
      started : '2016-06-30T06:21:24.607Z',
      input : '2016-06-30T06:21:24.607Z',
      returned : '2016-06-30T06:21:30.721Z',
      answered : '2016-06-30T06:21:41.274Z',
      ended : '2016-06-30T06:21:51.612Z'
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	id	Not found
500	internal_error	<Unspecified>

WIKI

Table of Contents