API : PBX : Recording Get

Request

This request will return a single recording.

URL	https://api.telecomx.dk/pbx/recording/RECORDING_ID
Method	GET
Access level	PERSONAL, VIEWER, MANAGER, OWNER, RESELLER or ADMIN. PERSONAL may not access common recordings.
Param	RECORDING_ID	Id of the recording (24 hex-char string).

Query examples

https://api.telecomx.dk/pbx/recording/12345678901234567890AAAA

Response

JSON 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

{
  "_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
404	not_found	Recording not found
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : PBX : Recording Get

Request

Query examples

Response

Example

Errors