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.
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 String Id of customer the settings belongs to.
defaultMusicOnHold Sting Id of the default music on hold set to use, null for default. See Music on hold.
masterPinCode String Master pin code for hotdesking, limitations and * codes. 4-10 digits. Not visible for PERSONAL users.
defaultLanguage String ISO3166-1 2-char default language code, for audio/ui when no employee is associated, e.g. da, en etc.
defaultNumber String Default phone number to present on outbound calls, if no a-number was specified on an outbound call.
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.
recording - defaults for common recordings that does not belong to an employee
recording.mode String When to record calls:
ALWAYS - all calls are recorded,
DEMAND - only record when requested,
NEVER - cannot record.
recording.quality String Quality of call recordings:
NORMAL - 8Khz MP3 mono.
COMPACT - xKhz MP3 mono.
HIGH - 16Khz MP3 stereo (each part in separate channels).
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.
billing
billing.invoicedUntil Date Date until which user and services has been invoiced.
presentMobileOnLocalToMobile Boolean True to present mobile number on local calls to mobile phones.

Note that properties holding no value may be omitted from the object.

Example

{
  _id: '1234567890124567890AAAA',
  defaultMusicOnHold: '12345789012345678901234',
  masterPinCode: '1234567890',
  defaultLanguage: 'da',
  defaultNumber: '+4570305050',
  defaultVoiceAccount: '1234578901234567890DDDD',
  nationalPrefix: '+45',
  callerIdNameOutbound: 'CUSTOMER',
  voicemailBreakout: null,
  recording: {
    mode: 'ALWAYS',
    quality: 'NORMAL',
    retension: 7
  },
  billing: {
    invoicedUntil: '2019-01-01T00:00:00.000Z'
  },
  presentMobileOnLocalToMobile: false
}

Errors

Error code Message Description
404 customer Customer not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>