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
| 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 |
| 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 |
| 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. |
| PhoneBookExport-118 | Id used in latest phonebook data export to 118. |
| 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 | Id of the newest PortingQRs document. This is used for creating unique ID's with mongo's FindAndModify. |
| SystemSmsProduct | Id of master product to use for invoicing SMS's sent through the system |
Example - normal
{ DslInitiationFeeProduct: '123457890ABCDEF12345678', DslInstallServiceProduct: '123457890ABCDEF12345678', DslSpeedChangeFeeProduct: '123457890ABCDEF12345678', FiberInitiationFeeProduct: '123457890ABCDEF12345678', SipServerForNewAccounts: '1.2.3.4', ChargedSmsProduct: '123457890ABCDEF12345678', SmsSingleProduct: '123457890ABCDEF12345678', MmsSingleProduct: '123457890ABCDEF12345678', MvnoDataProduct: '123457890ABCDEF12345678', MasterReseller: '123457890ABCDEF12345000', TerminationProduct: '123457890ABCDEF12345678', NumberPurchaseProduct: '123457890ABCDEF12345678', Porting1Product: '123457890ABCDEF12345678', Porting10Product: '123457890ABCDEF12345678', Porting100Product: '123457890ABCDEF12345678', PortingErrorProduct: '123457890ABCDEF12345678', PortingQRId: 2345, SystemSmsProduct: '1234567890ABCD1234567890'
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
api/config/list.txt · Last modified: 2023/08/01 13:15 by Joakim Andersen