Table of Contents

API : PBX : Recording consent list

Introduction

A recording consent item handles getting the callers consent to record the call.

The consent is stored into the call variable consent as 1 for consent or 0 for rejected.

If PBX settings says consent is not required, this just continues without doing anything.

If a previous consent has already been given and it is still valid - this just sets the call variable consent to 1 and continous.

Request

This request returns a list of all of the customers recording consent items.

URL https://api.telecomx.dk/pbx/recordingconsent
Method GET
Access level VIEWER, MANAGE, OWNER if recording consent items belongs to the customer, RESELLER if customer belongs to the reseller, RESELLER_ADMIN or ADMIN.
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.
expandGoto [optional] True to expand goto id's into _id/type/number/name objects. Also sets full=true.
customer [optional] Id of customer to show value router items for. Defaults to the users own customer if not specified.
sort [optional] Which property to sort result by: number (default), name, redirect.

Query examples

https://api.telecomx.dk/pbx/recordingconsent
https://api.telecomx.dk/pbx/recordingconsent?customer=123458789012457890ABCD
https://api.telecomx.dk/pbx/recordingconsent?customer=123458789012457890ABCD&limit=20&offset=100
https://api.telecomx.dk/pbx/recordingconsent?filter=donald
https://api.telecomx.dk/pbx/recordingconsent?customer=12345678901234567890ABCD&expandGoto=true

Response

JSON object
Property Type Description
offset Number Index of the first recording consent item returned.
limit Number Number of recording consent items to return. Note that the actual number of returned items may be lower.
total Number Number of recording consent items that can be returned when offset and limit is not considered. This is to be used for paging through the data.
recordingConsents Array List of recording consent items, see definition below.
Recording consent object
Property Type Description
_id Id Unique id of the recording consent.
type String Always 'RECORDING_CONSENT'.
customer Id Id of the customer the recording consent belongs to.
name String Name/description of the recording consent.
number String The phone number to dial to reach this recording consent locally, null if it is not dial-able.
startAudio Id A PBX audio item to playback when the recording consent is entered. It is an override for the default in PBX settings, or the system default. Null if not used.
redirect String Number to redirect to when execution starts. Used to quickly circumvent the recording consent item.
notes String Notes about the recording consent item.
consentGivenMessage Id A PBX audio item to playback after the caller has given consent. Overrides PBX settings default and system default. Null if not used.
consentRejectedMessage Id A PBX audio item to playback after the caller has rejected consent. Overrides PBX settings default and system default. Null if not used.
goto Id Dialplan item to goto when done.
x Number X position in visual dialplan.
y Number Y position in visual dialplan.

Example

{
  offset: 0,
  limit: 50,
  total: 25,
  recordingConsent: [
    {
      _id: '12345678901234567890ABCD',
      type: 'RECORDING_CONSENT',
      customer: '12345678901234567890AAAA',
      name: 'Spørg efter samtykke til optagelse',
      number: '666',
      startAudio: '12345678901234567890BBBB',
      redirect: '',
      notes: '',
      consentGivenMessage: '12345678901234567890CCCC',
      consentRejectedMessage: '12345678901234567890DDDD',
      goto: '12345678901234567890FFFF',
      x: 2043,
      y: 1920
    },
    {
      ...
    }
  ]

Errors

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