API : MVNO Account Get

Introduction

This request will return the specified MVNO account.

Request

URL	https://api.telecomx.dk/mvno/ACCOUNT_ID
Method	GET
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Param	ACCOUNT_ID	Id of the MVNO account (24 hex-char string) or E.164 phone number.

Query example

https://api.telecomx.dk/mvno/1234567890ABCDEF12345678

Response

Json object
_id	Id	Unique MVNO account id.
customer	Id	Id of customer the account belongs to.
state	String	The state of the MVNO account. Allowed values are 'ACTIVE', 'CREATING', 'DELETING', 'BLOCKED'. If state is 'BLOCKED', then the account cannot handle calls/sms/mms/data. If in state 'DELETING', it is currently under deletion.
type	String	Type of account - always 'MVNO'.
number	String	The phone number in E.164 format.
feature	Object	Settings that controls the features of the mobile phone (will overrule features set in ratePlan).
feature.highRate	Boolean	Permit calls towards high rated numbers (homeland only).
feature.international	Boolean	Permit calls towards international destinations.
feature.data	Boolean	Enable data for homeland.
feature.fiveG	Boolean	Enable 5G.
feature.publicIP	Boolean	Data connections gets a public IP address instead of a private NAT'ed IP.
feature.chargedServices	Boolean	Permit overcharged SMS and purchase of physical goods.
feature.voicemail	Boolean	Enable voicemail on stand-alone phones.
feature.secretNumber	Boolean	Secret a-number (do not present number).
feature.roaming	Boolean	Permit roaming (outside homeland).
feature.roamingData	Boolean	Enable data while roaming, if roaming is permitted.
feature.mms	Boolean	Enable MMS.
feature.dataTopUpSms	Boolean	If true, then a link allowing the MVNO account to buy top-up data, will be included in the SMS that warns the mobile user that they are approaching their data limit.
feature.smartWatchSim	Boolean	If true, then the MVNO account is allowed to add smartwatch (only TDC network).
feature.disableHdAudio	Boolean	If true, HD audio support is disabled.
mvnoSim	Object	SIM card settings - see below.
mvnoSim.simNumber	String	ICC number.
mvnoSim.imsi	String	IMSI number.
mvnoSim.network	String	Network provider: TELENOR, TDC.
mvnoSim.puk1	String	Puk code 1.
mvnoSim.puk2	String	Puk code 2.
mvnoSim.pin1	String	Pin code 1.
mvnoSim.pin2	String	Pin code 2.
mvnoSim.formFactor	String	Size of SIM card: 'MINI_MICRO', 'NANO', 'MINI_MICRO_NANO' or 'eSIM'.
mvnoSim.activationCode	String	eSIM activation code.
dataSharingSims	Array	List of add-on data sharing SIM cards, max 3, only TDC network.
dataSharingSims[].simNumber	String	ICC number
dataSharingSims[].imsi	String	IMSI number
dataSharingSims[].network	String	Network provider: TELENOR, TDC.
dataSharingSims[].puk1	String	Puk 1 code
dataSharingSims[].puk2	String	Puk 2 code
dataSharingSims[].pin1	String	Pin 1 code
dataSharingSims[].pin2	String	Pin 2 code
dataSharingSims[].formFactor	String	Size of SIM card: 'MINI_MICRO', 'NANO', 'MINI_MICRO_NANO' or 'eSIM'.
dataSharingSims[].activationCode	String	Activation code for QR when formFactor is eSIM.
dataSharingSims[].number	String	Phone number assigned to the SIM.
dataSharingSims[].name	String	Name of data sharing SIM, can be provided by the user
mvnoSimNetworkChangeTo	Object	SIM card data when changing network, otherwise null
mvnoSimNetworkChangeTo.simNumber	String	ICC SIM number
mvnoSimNetworkChangeTo.imsi	String	IMSI number - Billing identifier
mvnoSimNetworkChangeTo.network	String	Network provider: TELENOR, TDC.
mvnoSimNetworkChangeTo.puk1	String	Puk 1 code
mvnoSimNetworkChangeTo.puk2	String	Puk 2 code
mvnoSimNetworkChangeTo.pin1	String	Pin 1 code
mvnoSimNetworkChangeTo.pin2	String	Pin 2 code
mvnoSimNetworkChangeTo.formFactor	String	Size of SIM card: 'MINI_MICRO', 'NANO', 'MINI_MICRO_NANO' or 'eSIM'.
mvnoSimNetworkChangeTo.activationCode	String	Activation code for QR when formFactor is eSIM.
mvnoSimNetworkChangeTo.when	Date	Null until the change has been confirmed, then the Date it will happen.
mvnoSimNetworkChangeTo.socs	Array	List of SOCS that will be applied when change of network has completed.
Voicemail	Object	Voicemail settings, only if feature.voicemail is active and sipAccount and pbx is not.
voicemail.notify	String	Notification method: NONE, SMS, EMAIL, BOTH.
voicemail.email	String	E-mail address to send notification of new voicemail to, if enabled.
voicemail.emailFile	Boolean	True to include recording in e-mail.
voicemail.pin	String	Pincode to listen to voicemail from a foreign phone or via web.
voicemail.pinBlockedUntil	Date	If login with pin has been blocked due to too many failed login attempts, this is the date and time when the blocking will be lifted.
voicemail.defaultGreeting	String	Default greeting for stand alone voicemail.
voicemail.greetings	Array	Custom greetings for standalone voicemail.
voicemail.greetings[].key	String	Number to choose your greeting.
voicemail.greetings[].fileId	ObjectID	Id for audio file on audio server.
Misc
donorSimNumber	String	ICC number of the SIM card at the donor operator that currently has the phone number to port.
sipAccount	Id	Id of the SIP account (sip trunk) all calls are routed through (if used).
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).
dnd	Boolean	True to not call phone when the extension it belongs to (if any) is called (only if pbx>0).
ratePlan	Id	Id of the MVNO rate plan product this account should be invoiced by.
newRatePlan	Id	If a new rateplan should be applied at end of month, this is the plan.
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.
socsOverride[].setBySystem	Boolean	True if the override has been set automatically by the system.
notes	String	Note about the account (RESELLER/ADMIN only).
custom	Object	Optional custom data that 3rd parties may append, max. 4Kb.
billingCustomer	ObjectID	Alternate customer to bill this MVNO account to.
invoicedUntil	Date	The date the account has been invoiced until.
startDate	Date	Date this MVNO account will be activated.
deleteDate	Date	Date this MVNO account will be deleted. Null if not determined
employeeDeleteDate	Date	Given if the employee of the MVNO account is set to be deleted, and this MVNO account will be deleted at the same time.
info	Object	Informational - things that cannot be changed by the user.
info.updating	Boolean	True if accounting is waiting to be updated and cannot be changed.
info.dataDisabled	Boolean	True if data has been disabled for the rest of the month because it has been used up.
info.imei	String	Mobile phone IMEI number.
deviceType	String	Make and model of the phone used, if available.
info.usageBlock	Boolean	True if highRate, international and roaming has been blocked due to high usage. Can only be unset by Reseller or Admin users.
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.
employeeBillingCustomer	ObjectId	Id of the customer this employee's expenses are billed to
name	String	Name of the user or usage if no employee is set.
listed	Boolean	True if the number should be published in public phonebooks.
porting	Id	Id of the porting, if the number for this accounts is currently part of a porting.
purchaseInfo	Object	Purchase information (Admin only)
purchaseInfo.orderId	String	Order ID of the SIP Phone, references to external economic system
purchaseInfo.date	Date	Date the phone was purchased
purchaseInfo.paymentOption	String	How the phone is purchased or financed: BOUGHT or RENTED
purchaseInfo.serial	String
topUp	Object	Information about whether the mobile has been topped up with data this month.
data	Number	Additional data in bytes, purchased in addition to that in the ratePlan. Reset every month.
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
smartWatch	Object	Data for smart watch
smartWatch.eid	String	32 digit code for smartwatch
smartWatch.model	String	android or ios
smartWatch.number	String	Number assigned to smartwatch
smartWatch.state	String	Status of activation. NONE, CREATING, ORDERED, ACTIVE, FAILED or DELETING
smartWatch.createdAt	Date	Date for activation of smartwatch eSIM
invoicedUntil	Date	The date the smartwatch has been invoiced until.
smartWatch.orderState	String	Status of order. 'Cancelled', 'Partially Failed', 'Success', 'Failure', 'Blocked', 'Acknowledged' or 'Waiting'. Gets set by status response from TDC during activation
smartWatch.smartWatchSim	Object	Contains info for eSIM for smartwatch
smartWatch.smartWatchSim.simNumber	String	ICC for smartwatch
smartWatch.smartWatchSim.imsi	String	Imsi for smartwatch sim
smartWatch.smartWatchSim.pin1	String	Pin 1 code
smartWatch.smartWatchSim.pin2	String	Pin 2 code
smartWatch.smartWatchSim.puk1	String	Puk 1 code
smartWatch.smartWatchSim.puk2	String	Puk 2 code
smartWatch.smartWatchSim.network	String	Network provider, should always be TDC
smartWatch.smartWatchSim.formFactor	String	Size of SIM card. 'eSIM'. Should always be eSIM
smartWatch.smartWatchSim.activationCode	String	eSIM activation code.
restOfWorldRoaming	Object	Information regarding Rest-of-World (RoW) roaming
restOfWorldRoaming.productId	String	Product ID of the RoW package used by this mobile account
restOfWorldRoaming.productName	String	Name of the RoW product used by this mobile account
restOfWorldRoaming.productPrice	Number	Price of the RoW package when activated
restOfWorldRoaming.isOverride	Boolean	Whether this RoW-package is the one in the phone plan or has been overriden
restOfWorldRoaming.keepAfterExpire	Boolean	Whether this override only will be used for the next activation, or whether the override should be kept afterwards as well. Only reelvant when RoW-package is overwritten.

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

Example

{
  _id: '1234567890ABCDEF12345678',
  customer: '1234567890ABCDEF12345678',
  state: 'ACTIVE',
  type: 'MVNO',
  number: '+4512345678',
  feature: {
    highRate: true,
    international: true,
    data: true,
    chargedServices: false,
    publicIP: false,
    voicemail: false,
    secretNumber: false,
    fiveG: false,
    mms: true,
    roaming: true,
    roamingData: true,
    sendTopUpSms: true,
    disableHdAudio: false
  },
  mvnoSim: {
    simNumber: '8945020184621234567',
    imsi: '1234578901',
    network: 'TELENOR',
    puk1: '12345678',
    puk2: '12345678',
    pin1: '1234',
    pin2: '1234',
    formFactor: 'MINI_MICRO'
  },
  dataSharingSims: [],
  voicemail: {
    notify: 'BOTH',
    email: 'donald@duck.com',
    emailFile: true,
    pin: '1234567890'
  },
  sipAccount: '124567890ABCDEF12345678',
  pbx: 0,
  extension: null,
  dnd: false,
  ratePlan: '1234567890ABCDEF12345678',
  newRatePlan: '1234567890ABCDEF12345679',
  socs: [ 'SOC1','SOC2','SOC3',... ],
  socsOverride: [
    {
      soc: 'BADSOC',
      newSoc: 'GOODSOC',
      expireEOM: true
    },
    ...
  ],
  notes: 'This is a mobile phone account used by John Doe',
  custom: null,
  invoicedUntil: '2015-01-01T00:00:00.000Z',
  startDate: '2014-12-20T00:00:00.000Z',
  info: {
    updating: false,
    dataDisabled: false,
    imei: '1234567890123',
    deviceType: 'Apple iPhone 6'
  },
  numberState: 'IN_USE',
  employee: '123457890ABCDEF12345678',
  employeeName: 'Hans Christian Anderson',
  name: null,
  listed: false,
  porting: null,
  purchaseInfo: {
    orderId: '1238',
    date: '2020-20-20T00:00:00Z',
    paymentOption: 'RENTED'
  },
  topUp: {
    data: 1073741824
  },
  smartWatch: {
    eid: '12121212121212121212121212121212',
    model: 'ios',
    number: '+4522334455',
    state: 'ACTIVE',
    orderState: 'Successful',
    createdAt: '2020-20-20T00:00:00Z',
    invoicedUntil: '2020-20-20T00:00:00Z',
    smartWatchSim: 
       {
         simNumber: '8945020184621234567',
         imsi: '1234578901',
         network: 'TDC',
         puk1: '12345678',
         puk2: '12345678',
         pin1: '1234',
         pin2: '1234',
         formFactor: 'eSIM'
       }
  },
  restOfWorld: {
    productId: '1234567890ABCD1234567890'
    name: 'Verdenspakke 1 Gb - Autostart',
    isOverride: false,
    keepAfterExpire: true,
    price: 50
  }
}

Errors

Error code	Message	Description
404	mvnoAccount	MVNO account not found
403	access_denied	Insufficient access level

WIKI

Table of Contents

API : MVNO Account Get

Introduction

Request

Query example

Response

Example

Errors