CONSTANTS & ENUMERATED TYPES

Several types are used in various objects throughout the API.

Constant Types

Constant types are represented as integer values. Each item in a constant type list will be returned in the following format:

For example:

GET ivrapi/System/TerminationDndTypes

{
  "status": "success",
  "message": "",
  "data": 
  [
    {
      "Id": 0,
      "Name": "Off"
    },
    {
      "Id": 1,
      "Name": "Do Not Disturb"
    },
    {
      "Id": 2,
      "Name": "Out of Service"
    }
  ]
}

Enumerated Types

Enumerated types are represented as names. Each item in an enumerated type list will be returned in the following format:

For example:
GET /System/AccountAliasTypes

{
  "status": "success",
  "message": "",
  "data": 
  [
    {
      "Id": 1,
      "Name": "Authentication",
      "EnumeratedTypeName": "aatAuthentication" <-------------
    },
    {
      "Id": 2,
      "Name": "Registration",
      "EnumeratedTypeName": "aatRegistration" <-------------
    }
  ]
}

Account Alias Types

• GET /System/AccountAliasTypes
  aatNone, aatAuthentication, aatRegistration

Account Status Types

• GET System/AccountStatusTypes
  astNone, astProvisioned, astInTransit, astInStock, astActive, astActivated, astExpired, astSuspended, astDeactivated

Account Types

• GET System/AccountTypes
  atNone, atStandard, atCorporateChild, atCorporateParent, atGroupLimitChild, atGroupLimitParent, atMLMChild, atMLMParent

Batch Generation Method Types

gmMostEfficient, gmMostRandom

Billing Entry Types

• GET System/BillingEntryTypes
  betNone, betPlacedCall, betPlacedCallPackaged, betVoucher, betVoucherPackaged, betCcCharge, betCCChargePackaged, betServiceCharge, betServiceChargePackaged, betAccountCredit, betAccountCreditPackaged, betPayment, betPaymentPackaged, betRefund, betRefundPackaged, betSms, betSmsPackaged, betMms, betMmsPackaged, betData, betDataPackaged, betUssd, betUssdPackaged

Billing Package Item Types

• GET System/BillingPackageItemTypes
  itNone, itBalance, itPackagedMinuteBalance, itBalanceAndMinutes

Billing Types

• GET System/BillingTypes
  btDebit, btLimitedCredit, btUnlimitedCredit

Call Types

• GET System/CallTypes
  or
• GET System/MobileChargesCallTypes (omits non-mobile types from the list)
  ctAllCallTypes, ctAny, ctVoice, ctVoiceForward, ctVoiceMail, ctVoiceMoCamel, ctVoiceMoCamelForward, ctVoiceMoCamelMobile, ctVoiceMoUssd, ctVoiceMoUssdForward, ctVoiceMoUssdMobile, ctVoiceMoUssdVoiceMail, ctVoiceMtCamel, ctVoiceMtCamelForward, ctVoiceMtCamelMobile, ctVoiceMtCamelVoiceMail, ctData, ctSmsMo, ctSmsMt, ctSmsMtSystem, ctUssdMo, ctUssdMtSystem, ctVoiceMoCamelHome, ctVoiceMtCamelHome, ctVoiceMtCamelRedirect, ctVoiceMtCamelRedirectMobile, ctVoiceMtCamelRedirectForward, ctVoiceMtCamelRedirectHome, ctVoiceMtCamelDetached

CAMEL MO Routing Types

• GET System/MobileCamelMoRoutingTypes
  cmoNone, cmoHome, cmoHost, cmoHomeHost

CAMEL MT Routing Types

• GET System/MobileCamelMtRoutingTypes
  cmtNone, cmtHome, cmtHost, cmtHomeHost, cmtMsisdn, cmtAuxMsisdn, cmtAuxMsisdnMsisdn

Charge Types

• GET System/ChargeTypes
  ctNone, ctImmediately, ctOnFirstUse, ctMonthly, ctEveryXDays

Codec Types

• NOT IMPLEMENTED
  ctRtp, ctDtmf

Cost Types

• GET System/CostTypes
  ctInboundCost, ctOutboundCost

Disconnect Charge Types

• GET System/DisconnectChargeTypes
  dctFixedAmount, dctPercentage

Disconnect Codes

• NOT IMPLEMENTED
  dcIncomplete, dcNoLicense, dcNoModule, dcModuleNotRegistered, dcPortLimitExceeded, dcMaxCallsExceeded, dcShuttingDown, dcNoAnswer, dcBusy, dcComplete, dcRedirect

Endpoint Types

• GET System/EndpointTypes
  etNone, etPstn, etRegistered, etMsisdn, etAuxMsisdn, etMsrn, etVirtual

Event Log - Log Types

• NOT IMPLEMENTED
  ltApplication, ltSecurity

Event Log - Event Types

• NOT IMPLEMENTED
  etCritical, etWarning, etError, etInformation;

HLR Status Types

• GET System/HlrStatusTypes
  hstNone, hstNotProvisioned, hstProvisioned, hstCeased

IMSI Status Types

• GET System/ImsiStatusTypes
  istNone, istInactive, istActive, istCeased, istSuspended, istPending

Interrupt Call Types

• NOT IMPLEMENTED
  ictNone, ictReinviteLeg1, ictSilenceLeg2

Invoice Batch Types

• NOT IMPLEMENTED
  ibtAccountGroup, ibtAccount, ibtCustomerId, ibtAllAccounts

Minimum Balance Types

• GET System/MinimumBalanceTypes
  mtGE, mtLE

Mobile Charge Types

• NOT IMPLEMENTED
  mctPrimaryRate, mctUssdMo, mctUssdMtSystem, mctVoiceMoTransit, mctVoiceMtTransit, mctVoiceMoMtc, mctVoiceMtMtc, mctVoiceMoCamel, mctSmsMo, mctSmsMt, mctSmsMoTransit, mctSmsMtTransit, mctSmsMoIntermediary, mctSmsMtIntermediary, mctSmsMoInterworking, mctSmsMtInterworking, mctPdpSessionCreation, mctDataTransit, mctData

MT SMS Delivery Types

• GET System/MobileMtSmsDeliveryTypes
  dtQueue, dtDeliver, dtRelay

Notification Method Types

• GET System/MobileNotificationMethodTypes
  nmtNone, nmtMtUssd, nmtMtSms, nmtMtSmsFlash

Password Generation Types

• GET System/PasswordGenerationTypes
  pgtNone, pgtNumeric, pgtAlphanumeric, pgtStrong, pgtSameAsPin

Portal Types

• GET System/MobilePortalTypes
  ptNone, ptPartitionware, ptPartitionwareWithRtp

Rate Types

• GET System/RateTypes
  rtBillable, rtBlocked, rtNoCharge, rtCredit

Redirect Types

• NOT IMPLEMENTED
  rtIvrCa, rtTalkingSip, rtRedirectServer

Registration Types

• NOT IMPLEMENTED
  rtNone, rtDeny, rtAllow, rtChallenge

SIM Status Types

• GET System/MobileSimStatusTypes
  sstNone, sstInactive, sstActive, sstTerminated

SMS Number Types

• GET System/MobileSmsNumberTypes
  sntUnknown, sntInternational, sntNational, sntNetworkSpecific, sntSubscriber, sntAlphanumeric, sntAbbreviated, sntReserved

SMS Numbering Plan Types

• GET System/MobileSmsNumberingPlanTypes
  snpUnknown, snpIsdnE164, snpData, snpTelex, snpNational, snpPrivate, snpErmes, snpReserved

Termination Types

• GET System/MobileTerminationTypes
  ttNone, ttMsrn, ttMsisdn, ttAuxMsisdn

Username Generation Types

• GET System/UserNameGenerationTypes
  ugtNone, ugtNumeric, ugtAlphanumeric, ugtSameAsAccount