Table of Contents

API : Reseller: Overview

Introduction

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

Most sections are only present when the reseller has the matching feature - see the pr. field notes below. If the requested customer is not ACTIVE, the response contains only the customers count.

Request

URL https://api.telecomx.dk/reseller/RESELLER_ID/overview
Method GET
Access level RESELLER if it is the reseller itself or a sub reseller.
RESELLER_ADMIN, ADMIN.
Param RESELLER_ID Id Id of the reseller (24 hex-char string).

Query example

https://api.telecomx.dk/reseller/650000000000000000000001/overview

Response

Field Type Description
customers Number Number of ACTIVE customers under the reseller, including the reseller itself.
products Number Number of products the reseller currently offers.
sims Number SIM cards in storage at the reseller or its customers. Only with the MVNO feature.
sipAccounts.total Number Active SIP accounts. Omitted when the reseller has no active SIP accounts. Only with the SIP feature.
sipAccounts.sipTrunks Number Amount of SIP trunks. Only with the SIP feature.
sipAccounts.pbx Number Amount of PBXs. Only with the SIP feature.
sipAccounts.down Number SIP trunks whose realtime status reports offline (PBX accounts carry no realtime status). Only with the SIP feature.
mvnoAccounts.total Number Total MVNO accounts. Only with the SIP feature.
mvnoAccounts.disabled Number Disabled MVNO accounts. Only with the SIP feature.
numbers.total Number Total phone numbers. Only with the SIP or MVNO feature.
numbers.sip Number Fixed (SIP) phone numbers. Only with the SIP or MVNO feature.
numbers.mvno Number MVNO phone numbers. Only with the SIP or MVNO feature.
numbers.international Number International phone numbers. Only with the SIP or MVNO feature.
numbers.listed Number Phone numbers listed in public phonebooks. Only with the SIP or MVNO feature.
portings.in Number Active inbound portings. Only with the SIP or MVNO feature.
portings.out Number Active outbound portings. Only with the SIP or MVNO feature.
portings.failed Number Inbound portings that were rejected or failed. Only with the SIP or MVNO feature.
dataSharingSimOrdered.count Number MVNO accounts with a data sharing SIM on order. Only with the SIP or MVNO feature.
accountsInPreCreating.count Number MVNO accounts still in the PRE_CREATING state. Only with the SIP or MVNO feature.
internet.requests Number Internet requests. Only with the INTERNET feature.
internet.accounts Number Internet connections. Only with the INTERNET feature.
internet.down Number Internet connections without link (point to point connections excluded). Only with the INTERNET feature.

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

Example

{
  "customers": 309,
  "products": 9,
  "sims": 7,
  "sipAccounts": {
    "total": 76,
    "sipTrunks": 20,
    "pbx": 56,
    "down": 3
  },
  "mvnoAccounts": {
    "total": 85,
    "disabled": 1
  },
  "numbers": {
    "total": 183,
    "sip": 80,
    "mvno": 86,
    "international": 5,
    "listed": 10
  },
  "portings": {
    "in": 5,
    "out": 0,
    "failed": 1
  },
  "dataSharingSimOrdered": {
    "count": 2
  },
  "accountsInPreCreating": {
    "count": 1
  },
  "internet": {
    "requests": 1,
    "accounts": 5,
    "down": 1
  }
}

Errors

Error code Message Description
400 bad_request Invalid reseller id
403 access_denied Insufficient access level, or the reseller does not exist or is outside your scope
500 internal_error <Unspecified>