Table of Contents

API : PBX : Recording list

Request

This request returns a list of all of the employees recordings or common recordings. Recordings that belongs to an employee may only be accessed by the employee.

URL https://api.telecomx.dk/pbx/recording
Method GET
Access level PERSONAL, VIEWER, MANAGE, OWNER, RESELLER, ADMIN. VIEWER is required to access common recordings.
Query offset [optional] Index of the first item to return, default 0.
limit [optional] The number of items to return, default 50, min 1, max 1000.
filter [optional] Search query that will match against searchable fields.
from [optional] Date from which to include recordings (inclusive).
to [optional] Date until which to include recordings (inclusive).
followup [optional] True to only return recordings marked for follow up.
common [optional] True to instead list common recordings that are not associated with an employee.
customer [optional] Id of customer to list common recordings for (if RESELLER or ADMIN and common is true).

Query examples

https://api.telecomx.dk/pbx/recording
https://api.telecomx.dk/pbx/recording?limit=20&offset=100
https://api.telecomx.dk/pbx/recording?filter=70305050
https://api.telecomx.dk/pbx/recording?from=2019-01-01&to=2019-01-10&common=true&customer=12345678901234567890DEFA
https://api.telecomx.dk/pbx/recording?follow=true

Response

JSON object
offset Index of the first recording returned.
limit Number of recordings to return. Note that the actual number of returned recordings may be lower.
total Number of recordings that can be returned when offset and limit is not considered. This is to be used for paging through the data.
recordings Array of recordings, see definition below.
Recording object
_id Id Unique id of the recording.
customer Id Id of the customer it belongs to.
employee Id Id of the employee it belongs to. Null if recording is common.
extension Id Id of the extension it belongs to, if any.
channelId String Id of the channel the call was recorded on. Use to pair with PBX CDR.
callerChannelId String Id of calling channel, when call is inbound, otherwise null. Use to pair with PBX CDR.
date Date Date and time it was recorded.
expires Date Date and time when the recording will be auto deleted.
length Number Length in seconds.
quality String Recording quality - HIGH, NORMAL, COMPACT.
followUp Boolean True if recording is marked for follow up.
followUpNote String Optional followup note.
caller Object Caller data.
caller.number String Callers phone number.
caller.privacy Boolean Callers has secret number.
caller.name String Callers name, if available.
caller.type String Type of caller: EXTERNAL, SYSTEM, SIPPHONE, MOBILE.
caller.employee ObjectId Id of caller, if available.
callee Object Callee data.
callee.number String Called number.
callee.name String Callee name, if available.

Example - normal

{
  offset: 0,
  limit: 50,
  total: 25,
  recordings: [
    {
      "_id": "123457801234567890ABCC",
      "customer": "12345678901234567890ABCD",
      "employee": "12345678901234567890ABCE",
      "extension": "1234578901234567890ABCF",
      "channelId": "457t837w67t.47r7",
      "callerChannelId": null,
      "date": "2019-01-01T00:00:00.000Z",
      "expires": "2019-01-07T00:00:00.000Z",
      "length": 243,
      "quality": "NORMAL",
      "followUp": false,
      "followUpNote": null,
      "caller": {
        "number": "300",
        "privacy": false,
        "name": "Hans Hansen",
        "type": "SIPPHONE",
        "employee": "12345678901234567890AAAA"
      },
      "callee": {
        "number": "+45350203040",
        "name": "DR"
      }
    },
    {
      ...
    }
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level
500 internal_error <Unspecified>