API : Reseller: Overview

Introduction

This request is used to get basics statistics on the products/services a reseller sells.

Request

URL	https://api.telecomx.dk/reseller/RESELLER_ID/overview
Method	GET, POST
Access level	RESELLER and ADMIN.
Param	RESELLER_ID	Id	Id of reseller.

Query example - GET

https://api.telecomx.dk/reseller/12345678901234567890ABCD/overview

Response

Field	Type	Description
customers	Number	Amount of customers this reseller has
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
sipAccounts.sipTrunks	Number	Amount of SIP trunks
sipAccounts.pbx	Number	Amount of PBXs
sipAccounts.down	Number	Offline SIP accounts (trunks and PBXs combined)
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.total	Number	Total MVNO accounts
mvnoAccounts.disabled	Number	Disabled MVNO accounts
internet.requests	Number	Internet requests
internet.total	Number	Active Internet connections
internet.down	Number	Down Internet connections
portings.in	Number	Inbound portings
portings.out	Number	Outbound portings
portings.failed	Number	Failed portings
products	Number	Amount of reseller products
sims	Number	Amount of unused SIM-cards

Example

{
  customers: 309,
  features: ['CUSTOMER','SIP','MVNO','PBX','DNS','INTERNET','IPTVPRIVATE','TCE'],
  sipAccounts: {
    total: 76,
    sipTrunks: 20,
    pbx: 56,
    down: 3
  },
  numbers: {
    total: 183,
    sip: 80,
    mvno: 86,
    international: 5,
    listed: 10,
    porting: 2
  },
  mvnoAccounts: {
    total: 85,
    disabled: 1
  },
  internet: {
    requests: 1,
    total: 5,
    down: 1
  },
  sims: 7,
  portings: {
    in: 5,
    out: 0,
    failed: 1,
    attention: 0
  },
  products: 9
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : Reseller: Overview

Introduction

Request

Query example - GET

Response

Example

Errors