api:config:list
Table of Contents
API : Config List
Introduction
This request will return a list of all site wide configuration settings. Where a product is specified, it must always be a master product.
Request
| URL | https://api.telecomx.dk/config | |
|---|---|---|
| Method | GET | |
| Access level | ADMIN. | |
Query examples
https://api.telecomx.dk/config
Response
A single JSON object with one property per stored configuration key. Values are strings, numbers, ids or dates depending on the key.
| JSON object | |
|---|---|
| DSL & Fiber | |
| DslInitiationFeeProduct | Id of product for one time fee, for creating a DSL product |
| DslInstallServiceProduct | Id of product for one time fee for DSL with TDC technician install service |
| DslSpeedChangeFeeProduct | Id of product for one time fee for changing the speed of a DSL line |
| FiberInitiationFeeProduct | One time fee for creating a fiber line |
| FiberPoint2PointProduct | Point-2-point fiber product (fiber only), requires two addresses |
| SIP | |
| SipServerForNewAccounts | IP address of sip server newly created SIP accounts should be placed on |
| MVNO | |
| ChargedSmsProduct | Product to use for overchanged SMS messages (collections, payments, etc.) |
| SmsSingleProduct | Product to use for sent SMS messages when doing monthly invoicing and no bulk SMS product is included |
| MmsSingleProduct | Product to use for sent MMS messages when doing monthly invoicing and no bulk MMS product is included |
| MvnoDataProduct | Product to use for used data when doing monthly invoicing and no data is included or for usage beyond the data package |
| MvnoForceChangeFeeProduct | Product to invoice as a fee when the ratePlan is to be changed immediately |
| SmartWatchProduct | Product to use for invoicing smart watches |
| DataSharingSimProduct | Product to use for invoicing data sharing SIMs |
| PBX | |
| PbxUserMinimum | Min number of users to invoice for on a hosted PBX |
| PbxUserService | Product to use for invoicing PBX service |
| PbxUser | Product to use for invoicing PBX users |
| PbxUserService247 | Product to use for invoicing user service 24/7 |
| PbxRec6 | Product to use for invoicing PBX recording for 6 months pr. user |
| PbxRec24 | Product to use for invoicing PBX recording for 24 months pr. user |
| PbxDesktopAppVersion | Min required version of Communicator Desktop |
| PbxDesktopAppVersionTest | Min required version of Communicator Desktop test |
| PbxIosAppVersion | Min required version of Communicator iOS |
| PbxAndroidAppVersion | Min required version of Communicator Android |
| IPTV | |
| IpTvRequiredVersionANDROID | Min required playmaker version for Android |
| IpTvRequiredVersionANDROIDTV | Min required playmaker version for Android TV |
| IpTvRequiredVersionAPPLETV | Min required playmaker version for Apple TV |
| IpTvRequiredVersionIOS | Min required playmaker version for iOS |
| IpTvEpgCacheForceReloadAt | Date/time when the EPG cache was last forcefully reloaded |
| Misc | |
| MasterReseller | Id of the reseller to set as parentReseller when a reseller is deleted or no longer a reseller |
| TerminationProduct | Product to use when the system automatically creates current invoice lines when deleting a product with the remainder of the product |
| NumberPurchaseProduct | Product to use for invoicing a purchased number. |
| CallProduct | Product to use for invoicing calls. |
| CallNoVatProduct | Product to use for invoicing VAT exempt calls. |
| CallProductMvno | Product to use for invoicing MVNO calls. |
| CallNoVatProductMvno | Product to use for invoicing VAT exempt MVNO calls. |
| HumanTaskReferenceId | Auto-increment reference id for human tasks. |
| FileMaxStorageLimit | Max file storage size for a customer, in GB. |
| FileMaxSize | Max size pr. file in the file storage, in GB. |
| MitelRedirect | Redirect URL for Mitel. |
| PhoneBookExport-118 | Id used in latest phonebook data export to 118. |
| PhoneBookExport-p34 | Sequence number for phonebook data export to P34. |
| InternetRequestEmailRecipients | Comma list of e-mail addresses to notify when a request for Internet is received. |
| ordersEmail | Comma list of e-mail addresses to notify when a TCE units is ordered. |
| SystemNotificationEmailRecipients | Comma list of e-mail addresses to notify of important TCX system events. |
| Porting | |
| Porting1Product | Product to use for invoicing a single number or cancelled porting. |
| Porting10Product | Product to use for invoicing a porting of a 10-series (can be used multiple times e.g. for a 30 series). |
| Porting100Product | Product to use for invoicing a porting of a 100-series or bigger (can be used multiple times). |
| PortingErrorProduct | Product to use for invoicing when a porting is rejected or cancelled. |
| PortingQRId | Sequence number used for creating unique porting QR ids. |
| OCHTransactions | Sequence number for OCH transactions. |
| OCHTransactionsOriginatingOrderNumber | Sequence number for OCH originating order numbers. |
| SystemSmsProduct | Id of master product to use for invoicing SMS's sent through the system |
Example
{ "DslInitiationFeeProduct": "650000000000000000000101", "DslInstallServiceProduct": "650000000000000000000102", "DslSpeedChangeFeeProduct": "650000000000000000000103", "FiberInitiationFeeProduct": "650000000000000000000104", "FiberPoint2PointProduct": "650000000000000000000105", "SipServerForNewAccounts": "198.51.100.10", "ChargedSmsProduct": "650000000000000000000106", "SmsSingleProduct": "650000000000000000000107", "MmsSingleProduct": "650000000000000000000108", "MvnoDataProduct": "650000000000000000000109", "MvnoForceChangeFeeProduct": "650000000000000000000110", "SmartWatchProduct": "650000000000000000000111", "DataSharingSimProduct": "650000000000000000000112", "PbxUserMinimum": 5, "PbxUserService": "650000000000000000000113", "PbxUser": "650000000000000000000114", "PbxUserService247": "650000000000000000000115", "PbxRec6": "650000000000000000000116", "PbxRec24": "650000000000000000000117", "PbxDesktopAppVersion": 214, "PbxDesktopAppVersionTest": 215, "PbxIosAppVersion": 4.2, "PbxAndroidAppVersion": 4.2, "IpTvRequiredVersionANDROID": "2.14.0", "IpTvRequiredVersionANDROIDTV": "2.14.0", "IpTvRequiredVersionAPPLETV": "2.14.0", "IpTvRequiredVersionIOS": "2.14.0", "IpTvEpgCacheForceReloadAt": "2026-01-15T09:00:00.000Z", "MasterReseller": "650000000000000000000118", "TerminationProduct": "650000000000000000000119", "NumberPurchaseProduct": "650000000000000000000120", "CallProduct": "650000000000000000000121", "CallNoVatProduct": "650000000000000000000122", "CallProductMvno": "650000000000000000000123", "CallNoVatProductMvno": "650000000000000000000124", "HumanTaskReferenceId": 10234, "FileMaxStorageLimit": 100, "FileMaxSize": 2, "MitelRedirect": "https://mitel.example.dk/redirect", "PhoneBookExport-118": 731, "PhoneBookExport-p34": 88, "InternetRequestEmailRecipients": "internet@example.dk,noc@example.dk", "ordersEmail": "orders@example.dk", "SystemNotificationEmailRecipients": "noc@example.dk", "Porting1Product": "650000000000000000000125", "Porting10Product": "650000000000000000000126", "Porting100Product": "650000000000000000000127", "PortingErrorProduct": "650000000000000000000128", "PortingQRId": 2345, "OCHTransactions": 4523, "OCHTransactionsOriginatingOrderNumber": 118, "SystemSmsProduct": "650000000000000000000129" }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/config/list.txt · Last modified: by Mikkel Meerwaldt Jørgensen