Table of Contents

API : MVNO Deleted Accounts : List

Introduction

This request will return the list of deleted MVNO accounts that can still be recovered.

Request

URL https://api.telecomx.dk/mvno/deleted
Method GET
Access level RESELLER_ADMIN
ADMIN.
Query offset [optional] Index of the first MVNO account to return, default 0.
limit [optional] The number of MVNO accounts to return, default 100, min 1, max 500.
filter [optional] To filter the MVNO accounts, this can be used. Number, deviceType, simNumber (ICC), IMSI and notes will be searched.

Query examples

https://api.telecomx.dk/mvno/deleted
https://api.telecomx.dk/mvno/deleted?filter=81808&offset=10&limit=25

Response

JSON object
offset Index of the first MVNO account returned.
limit Number of MVNO accounts to return. Note that the actual number of MVNO accounts returned may be lower.
total Number of MVNO accounts that can be returned when offset and limit is not considered. This is to be used for paging through the data.
mvnoAccounts Array of MVNO accounts, see definition below
MVNO account object (JSON)
_id Id Unique MVNO account id.
state String The state of the MVNO account. Allowed values are 'ACTIVE', 'CREATING', 'BLOCKED'. If state is 'BLOCKED', then the account cannot handle calls/sms/mms/data.
number String The phone number (E.164 format) this MVNO account uses.
customer Id Customer ID
customerName String Customer name
reseller Id Reseller ID
resellerName String Reseller name
ratePlan Id Id of the rate plan used for billing.
ratePlanName String Name/description of the rate plan.
preterminateUntil Date Until this date, the MVNO account be recovered. This date is 30 days from when the voice account was deleted.
deleted Date When the account was deleted
pbx Number Id of hosted PBX cluster to use, null or 0 if not part of hosted PBX.
extension Id Id of extension the MVNO account belongs to on the hosted PBX (only if pbx>0).
extensionNumber String Extensions local number, or direct if no local number selected (only if pbx>0).
dnd Boolean True to not call phone when the extension it belongs to (if any) is called (only if pbx>0).
dataDisabled Boolean True if data has been disabled because the subscription data has been used up.
updating Boolean True if account is currently being updated and cannot be modified.
numberState String State of the phone number:
IN_USE - in normal use
PORTING_IN - is currently being ported in
PORTING_OUT - is currently being ported out
employee Id Id of employee the number is used by, if set.
employeeName String Name of the employee, if set.
name String Name of the user or usage if no employee is set.
porting Id Id of the porting, if the number for this accounts is currently part of a porting.
usageBlock Boolean True if highrate, international and roaming calls are blocked due to high usage or suspicion of fraud.
deviceType String Make and model of the phone used - if available.
startDate Date Date this MVNO account will be activated.
deleteDate Date Date this MVNO account will be deleted. Null if not determined
simNumber String Sim card ICC number.
imei String Mobile phone IMEI number.
socs Array Array of all active SOCS on the account, for debug (ADMIN only).
socsOverride Array Array of SOCS which must be overriden with another SOC (ADMIN only).
socsOverride[].soc String Name of SOC to replace.
socsOverride[].newSoc String Name of SOC to use instead.
socsOverride[].expireEOM Boolean True if the override must expire at the end of the month.
socsOverride[].startEOM Boolean True if the override should start during end of month update run.
socLimit Object Object containing details about the limits of the account's SOCs (ADMIN only)
data Number Data limit in megabytes
minutes Number Voice usage limit in minutes

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

Example - normal

{
  offset: 10,
  limit: 20,
  total: 123,
  mvnoAccounts:
  [
    {
      _id: '1234567890ABCDEF12345678',
      state: 'ACTIVE',
      number: '+4512345678',
      preterminateUntil: '2023-01-02T05:00:00.000Z',
      deleted: '2023-12-02T05:00:000Z',
      customer: '1234567890ABCD1234567890',
      customerName: 'Bente Bents Autodele',
      reseller: '2234567890ABCD1234567890',
      resellerName: 'Telenettet A/S',
      ratePlan: '123457890ABCDEF12345678',
      ratePlanName: 'Free speech, free SMS/MMS, 5Gb data',
      pbx: null,
      extension: null,
      extensionNumber: null,
      dnd: false,
      dataDisabled: false,
      updating: false,
      numberState: 'IN_USE',
      employee: '123457890ABCDEF12345678',
      employeeName: 'Hans Christian Anderson',
      name: null,
      porting: null,
      usageBlock: false,
      startDate: '2023-03-04T22:00.000Z',
      deleteDate: null,
      topUp: {
        data: 10734741824
      }
    },
    ...
  ]
}

Errors

Error code Message Description
403 access_denied Insufficient access level - no access to the customer.
500 internal_error Failed to lookup mvnoRT settings in Redis
500 internal_error <Unspecified error>