api:pbx:settings:get
Table of Contents
API : PBX: Settings Get
Introduction
This request will return the generel PBX settings for a customer.
Request
| URL | https://api.telecomx.dk/pbx/settings/CUSTOMER_ID | |
|---|---|---|
| URL | https://api.telecomx.dk/pbx/settings | |
| Method | GET | |
| Access level | PERSONAL, VIEWER, MANAGER or OWNER if user belongs to the customer RESELLER if customer belongs to the reseller RESELLER_ADMIN ADMIN |
|
| Param | CUSTOMER_ID | Id of the customer (24 hex-char string) (RESELLER/ADMIN only). |
Query example
https://api.telecomx.dk/pbx/settings/1234567890ABCDEF12345678 https://api.telecomx.dk/pbx/settings
Response
| Field | Type | Description |
|---|---|---|
| _id | Id | Id of customer the settings belongs to. |
| defaultMusicOnHold | Id | Id of the default music on hold set to use, null for default. See MusicOnHold. |
| masterPinCode | String | Master pin code for spying, limitations and other * codes. 4-10 digits. |
| defaultLanguage | String | ISO3166-1 2-char default language code, for audio/ui when no employee is associated. |
| defaultNumber | String | Default phone number to present on outbound calls, if no a-number was specified. |
| defaultVoiceAccount | Id | Id of default SIP account to invoice calls to when an outbound call does not present a phone number that belongs to a PBX trunk. |
| nationalPrefix | String | National prefix for the country the hosted PBX belongs to. Used to determine if a call is international and in UI to remove prefix for readability, null if not used. |
| callerIdNameOutbound | String | How to handle caller ID name on outbound calls: AS_IS - Send as is CUSTOMER - always show customer name (default) PREFIX - Prefix with customer name if extension has a user, otherwise use customer name |
| voicemailBreakout | ObjectId | Id of dialplan item to redirect to if a caller presses '0' during voicemail greeting or recording. |
| presentMobileOnLocalToMobile | Boolean | True to present mobile phone number when calling a mobile phone. |
| billing | Object | Billing settings |
| billing.invoicedUntil | Date | Date until which user and services has been invoiced. |
| recording | Object | Recording setting for customer wide recording of calls and handling of consent. |
| recording.mode | String | When to record calls: |
| ALWAYS - all calls are recorded | ||
| NEVER - no PBX wide recording | ||
| recording.quality | String | Quality of call recordings: |
| NORMAL - 48Khz Opus. | ||
| COMPACT - 24Khz Opus. | ||
| HIGH - 64Khz Opus. | ||
| recording.retension | Number | Number of days to store recording: 1, 3, 7, 14 or 30 days. For COMPACT quality 90, 180, 365 & 730 days are also available. |
| recording.transcribe | String | Automatic transcription of calls that are recorded PBX wide (COMMON): |
| DISABLED - no automatic transcription | ||
| TRANSCRIBE - automatic transcription | ||
| TRANSCRIBE_AND_SUMMARIZE - automatic transcription and AI summarization | ||
| recording.consentRequired | Boolean | True if consent to record is required from the other party. |
| recording.localCall | String | If the other party is local then: |
| NEVER - never record local parties | ||
| ALWAYS - automatically consent | ||
| ALWAYS_WORK - automatically consent when presence is not OFF_WORK or HOLIDAY | ||
| CONSENT - ask for consent | ||
| recording.consentPeriod | Number | Consent options that shall be used when asking for consent: |
| 0 - press 1 for consent for this call, press 0 to reject recording or wait. | ||
| 1 - press 1 for consent for this call, 2 for consent for the next month, 0 to reject recording or wait. | ||
| 3 - press 1 for consent for this call, 2 for consent for the next 3 months, 0 to reject recording or wait. | ||
| 6 - press 1 for consent for this call, 2 for consent for the next 6 months, 0 to reject recording or wait. | ||
| 12 - press 1 for consent for this call, 2 for consent for the next 12 months, 0 to reject recording or wait. | ||
| recording.inboundConsentMessage | Id | Id of consent message to be played on inbound calls when customer recording is enabled. Null to use system default message. |
| recording.inboundDirectConsentMessage | Id | Id of consent message to be played on inbound calls directly to an employee who is recording. Null to use system default message. |
| recording.outboundConsentMessage | Id | Id of consent message to be played on outbound calls by an employee who is recording. Null to use system default message. |
| reocrding.onDemandConsentMessage | Id | Id of consent message to be played in call when an employee mid-call starts recording. Null to use system default message. |
| recording.consentGivenMessage | Id | Id of message to be played after consent has been given. Null to use system default message. |
| recording.consentRejectedMessage | ObjectId | Id of message to be played after consent has been rejected. Null to use system default message. |
| recording.consentMode | String | How consent is obtained when consentRequired is true: OPT_IN (default, also when null) - the other party must press 1 (or 2) to consent, OPT_OUT - the other party is told the call is recorded and is recorded unless they press 0. Opt-out is not a consent; see Recording consent records. In opt-out mode the system default consent messages are the opt-out versions, see System defaults. |
| recording.storedConsentMessage | Id | Id of message played on the bridge (both parties hear it) when a call is recorded on a consent the caller gave in an earlier call. Null to use system default message (“Samtalen optages baseret på tidligere samtykke.”). |
| recording.consentSms | Object | SMS sent to the party that gave consent (pressed 1 or 2), when their number is a Danish mobile number. Not sent in opt-out mode when the party did not press 0, nor when an earlier consent is reused. Sent from the customer's name (max 11 characters) and invoiced to the customer as an ordinary SMS. Null for no SMS. |
| recording.consentSms.enabled | Boolean | True to send the SMS. |
| recording.consentSms.message | String | Text of the SMS, max 300 characters. Required when enabled is true. |
| recording.robotExtensions | Array | List of ids of extensions that if involved in a bridge shall not trigger start of recording. |
| recording.permissions | Object | Employee recording permissions. |
| recording.permissions.transcribe | Boolean | True if employees are allowed to transcribe recordings. |
| recording.permissions.summarize | Boolean | True if employees are allowed to summarize recordings. |
| video | Object | Video calls for the customer's devices. A device only uses video when this is enabled and the device itself allows video. |
| video.enabled | Boolean | True if video calls are allowed. |
| guestCalls | Object | Guest video invites: employees may invite an outsider to a 1:1 video call by a link. Absent or disabled means no invites can be sent. |
| guestCalls.enabled | Boolean | True if guest video invites are allowed. Only takes effect when video.enabled is true. |
Note that properties holding no value may be omitted from the object.
Example
{ _id: '12345678901234567890ABCD', defaultMusicOnHold: ObjectId('12345789012345678901234'), masterPinCode: '1234567890', defaultLanguage: 'en', defaultNumber: '+4570305050', defaultVoiceAccount: ObjectId('1234578901234567890DDDD'), nationalPrefix: '+45', callerIdNameOutBound: 'CUSTOMER', voicemailBreakout: ObjectId('123456789012345678901111'), presentMobileOnLocalToMobile: false, video: { enabled: true }, guestCalls: { enabled: false }, billing: { invoiceUntil: '2019-01-01T00:00:00.000Z' }, recording: { mode: 'ALWAYS', quality: 'NORMAL', retension: 7, transcribe: 'DISABLED', consentRequired: true, localCall: 'ALWAYS', consentPeriod: 3, inboundConsentMessage: '12345678901234567890AAAA', inboundDirectConsentMessage: '12345678901234567890BBBB', outboundConsentMessage: '12345678901234567890CCCC', onDemandConsentMessage: '12345678901234567890DDDD', consentGivenMessage: '1234567890123457890EEEE', consentRejectedMessage: '12345678901234567890FFFF', consentMode: 'OPT_IN', storedConsentMessage: null, consentSms: { enabled: true, message: 'Dit samtykke er registeret. Se mere omkring vores privatlivspolitik og hvordan du kan tilbagekalde og søge aktindsigt på vores hjemmeside https://eksempel.dk' }, robotExtensions: [], permissions: { transcribe: false, summarize: false } } }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | customer | Customer not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/settings/get.txt · Last modified: by Telecom X AI