API : PBX : Audio : System defaults

Introduction

When a customer has not set its own recording consent message in the PBX settings (the field is null), the PBX plays a system default message. This request returns the ids of those default messages, so they can be played - for example with a play button next to each empty message field. The default messages are public audio files: play them as https://audio.telecomx.dk/AUDIO_ID.mp3.

The defaults depend on the consent mode (recording.consentMode): in opt-out mode the four consent questions tell the caller to press 0 to refuse recording.

Request

URL	https://api.telecomx.dk/pbx/audio/system-defaults
Method	GET
Access level	VIEWER or higher.
Query	language	`[optional]` Language of the messages: da or en. Any other or a missing value gives en - the PBX has system messages in Danish and English only.

Query example

https://api.telecomx.dk/pbx/audio/system-defaults?language=da

Response

JSON object
Property	Type	Description
language	String	Language of the messages.
OPT_IN	Object	The default message ids when consent is opt-in, keyed by the recording field of the PBX settings they stand in for: inboundConsentMessage, inboundDirectConsentMessage, outboundConsentMessage, onDemandConsentMessage, consentGivenMessage, consentRejectedMessage, storedConsentMessage.
OPT_OUT	Object	The same for opt-out consent.

Example

{
  language: 'da',
  OPT_IN: {
    inboundConsentMessage: '6a5ce50feefed513c934fe5a',
    inboundDirectConsentMessage: '6a5ce5d259b64613b5272a3e',
    outboundConsentMessage: '6a5ce8127db79e13b68b4034',
    onDemandConsentMessage: '6a5ce65e1ebc1c13cf2e245c',
    consentGivenMessage: '6a5ce3bd0f743913c7d9a1e8',
    consentRejectedMessage: '6aba9bb123dfdd1e06c847ed',
    storedConsentMessage: '6aba301877df091df42dfbcd'
  },
  OPT_OUT: {
    inboundConsentMessage: '6aba2fba9907b41df30b3ad7',
    ...
  }
}

Errors

Error code	Message	Description
401	unauthorized	Missing or invalid token
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents