api:customer:overview
Table of Contents
API : Customer: Overview
Introduction
This request is used to get basics statistics on the products/services a customer has.
Request
| URL | https://api.telecomx.dk/customer/CUSTOMER_ID/overview | ||
|---|---|---|---|
| Method | GET, POST | ||
| Access level | VIEWER, MANAGER, OWNER, RESELLER and ADMIN. | ||
| Param | CUSTOMER_ID | Id | Id of customer. |
Query example - GET
https://api.telecomx.dk/customer/12345678901234567890ABCD/overview
Response
| Field | Type | Description |
|---|---|---|
| disabled | Boolean | True if customer is disabled |
| features | Array | List of features in the TelecomX platform that the customer has access to. CUSTOMER - Basics, addresses, financial, usage limits, employees SIP - SIP trunks MVNO - Mobile phones PBX - Hosted PBX, SIP phones, music on hold, Webhooks (auto-enables SIP, MVNO, CUSTOMER) TCE - Telecom Call Enhancer DNS - Domain management INTERNET - Fiber & xDSL TV - TV (old platform) IPTVPRIVATE - Private IPTV customer IPTVBUSINESS - Business IPTV customer FLEXCARE - FlexCare HealthTech ZEROTIER - ZeroTier networking EXTERNAL_LICENSES - external licenses |
| sipUsageLimit | Number | Combined maximum monthly usage in DKK for all SIP accounts |
| mvnoUsageLimit | Number | Maximum monthly usage in DKK for a MVNO account |
| sipChannelLimit | Number | Maximum number of concurrent calls the customer may conduct on SIP accounts |
| isReseller | Boolean | True if customer is a reseller |
| zerotier | Number | Number of Zerotier networks |
| products | Number | Number of products available to the customer |
| files | Number | Number of files stored in the file storage |
| presenceProxy | Number | Number of presence proxies |
| callNotification | Number | Number of call notification subscriptions |
| employees | Object | |
| employees.total | Number | Total employees |
| employees.disabled | Number | Disabled employees |
| sipAccounts | Object | |
| sipAccounts.total | Number | Total SIP accounts |
| sipAccounts.disabled | Number | Disabled SIP accounts |
| sipAccounts.down | Number | Offline SIP accounts |
| numbers | Object | |
| numbers.total | Number | Total phone numbers |
| numbers.sip | Number | SIP phone numbers |
| numbers.mvno | Number | MVNO phone numbers |
| numbers.international | Number | International phone numbers |
| numbers.listed | Number | Phone numbers listed in public phonebooks |
| numbers.porting | Number | Phone numbers being ported |
| mvnoAccounts | Object | |
| mvnoAccounts.total | Number | Total MVNO accounts |
| mvnoAccounts.disabled | Number | Disabled MVNO accounts |
| mvnoAccounts.dataDisabled | Number | MVNO accounts that has run out of data |
| pbx | Object | |
| pbx.dialplan | Number | Number of PBX dialplan items |
| pbx.extensions | Number | Number of PBX extensions |
| pbx.sipPhones.total | Number | PBX SIP Phones |
| pbx.sipPhones.down | Number | Down PBX SIP Phones |
| pbx.audio | Number | Number of audio files |
| pbx.moh.total | Number | Total Music On Hold classes |
| pbx.moh.private | Number | Private Music On Hold classes |
| pbx.variables | Number | System variables |
| pbx.switches | Number | System switches |
| internet | Object | |
| internet.requests | Number | Internet requests |
| internet.total | Number | Active Internet connections |
| internet.down | Number | Down Internet connections |
| portings | Object | |
| portings.in | Number | Inbound portings |
| portings.out | Number | Outbound portings |
| portings.failed | Number | Failed portings |
| portings.attention | Number | Portings that requires attention |
| iptv | Object | |
| iptv.packages | Number | Number of subscribed TV packages |
| iptv.channels | Number | Number of TV channels |
| iptv.stbs.total | Number | Total set top boxes |
| iptv.stbs.down | Number | Down set top boxes |
| iptv.ios | Number | Number of IOS devices |
| iptv.android | Number | Number of Android devices |
| iptv.web | Number | Number of web browsers |
| dns | Object | |
| dns.total | Number | Total domains |
| dns.failed | Number | Failed domains |
| dns.lowTtl | Number | Number of domains with a TTL less than 6 hours |
| Flexcare | Object | |
| flexcare.tabletProfiles | Number | Number of tablet profiles |
| flexcare.androidBoxProfiles | Number | Number of Android box profiles |
| flexcare.stbProfiles | Number | Number of STB profiles |
| flexcare.tablets | Number | Number of tablets |
| flexcare.androidBoxes | Number | Number of Android boxes |
| flexcare.stbs | Number | Number of STBs |
| flexcare.totalProfiles | Number | Total number of profiles |
| flexcare.totalDevices | Number | Total number of devices |
Example
{ disabled: false, features: ['CUSTOMER','SIP','MVNO','PBX','DNS','INTERNET','IPTVPRIVATE','FLEXCARE','ZEROTIER','EXTERNAL_LICENSES'], sipUsageLimit: 10000, mvnoUsageLimit: 2500, sipChannelLimit: 50, isReseller: false, employees: { total: 20, disabled: 2 }, sipAccounts: { total: 5, disabled: 0, down: 1 }, numbers: { total: 100, sip: 80, mvno: 15, international: 5, listed: 10, porting: 2 }, mvnoAccounts: { total: 15, disabled: 1 }, pbx: { dialplan: 23, extensions: 10, sipPhones: { total: 10, down: 1 }, audio: 32, moh: { total: 8, private: 2 }, variables: 5, switches: 2 }, internet: { requests: 1, total: 5, down: 1 }, portings: { in: 5, out: 0, failed: 1, attention: 0 }, tce: 1, presenceProxy: 1, callNotification: 2, iptv: { packages: 3, channels: 68, stbs: { total: 5, down: 1 }, ios: 2, android: 1, web: 3 }, dns: { total: 11, failed: 0, lowTtl: 0 } }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | not_found | Customer not found |
| 500 | internal_error | <Unspecified> |
api/customer/overview.txt · Last modified: 2026/05/10 12:49 by Per Møller