Rate this page:

AccountInfo

Props

a2pSmsEnabled

Copy URL
a2pSmsEnabled: 

false

|

undefined

|

true

Whether to activate one-way SMS

accessEntries

Copy URL
accessEntries: 

string[]

The allowed access entries (the API function names)

accountCustomData

Copy URL
accountCustomData: 

string

|

undefined

The custom data

accountEmail

Copy URL
accountEmail: 

string

The account's email

accountFirstName

Copy URL
accountFirstName: 

string

|

undefined

The first name

accountId

Copy URL
accountId: 

number

The account's ID

accountLastName

Copy URL
accountLastName: 

string

|

undefined

The last name

accountName

Copy URL
accountName: 

string

The account's name

accountNotifications

Copy URL
accountNotifications: 

false

|

undefined

|

true

Whether Voximplant notifications are required

active

Copy URL
active: 

boolean

Whether the account is ctive

apiKey

Copy URL
apiKey: 

string

|

undefined

The account API key. Use password or api_key authentication to show the api_key

balance

Copy URL
balance: 

number

|

undefined

The account's money

billingAddressAddress

Copy URL
billingAddressAddress: 

string

|

undefined

The office address

billingAddressCountryCode

Copy URL
billingAddressCountryCode: 

string

|

undefined

The billing address country code (2 symbols, ISO 3166-1 alpha-2). Examples: US, RU, GB

billingAddressName

Copy URL
billingAddressName: 

string

|

undefined

The company or businessman name

billingAddressPhone

Copy URL
billingAddressPhone: 

string

|

undefined

The office phone number

billingAddressState

Copy URL
billingAddressState: 

string

|

undefined

The office state (US) or province (Canada), up to 100 characters. Examples: California, Illinois, British Columbia

billingAddressZip

Copy URL
billingAddressZip: 

string

|

undefined

The office ZIP

billingLimits

Copy URL
billingLimits: 

BillingLimits

The payments limits applicable to each payment method

callbackSalt

Copy URL
callbackSalt: 

string

|

undefined

If salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url has a salt field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud

callbackUrl

Copy URL
callbackUrl: 

string

|

undefined

If URL is specified, Voximplant cloud makes HTTP POST requests to it when something happens. For a full list of reasons see the type field of the structure. The HTTP request has a JSON-encoded body that conforms to the structure

created

Copy URL
created: 

Date

The UTC account created time in 24-h format: YYYY-MM-DD HH:mm:ss

creditLimit

Copy URL
creditLimit: 

number

|

undefined

The account's credit limit

currency

Copy URL
currency: 

string

|

undefined

The currency code (USD, RUR, EUR, …)

frozen

Copy URL
frozen: 

false

|

undefined

|

true

Whether account is blocked by Voximplant admins

languageCode

Copy URL
languageCode: 

string

|

undefined

The notification language code (2 symbols, ISO639-1). Examples: en, ru

location

Copy URL
location: 

string

|

undefined

The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10

minBalanceToNotify

Copy URL
minBalanceToNotify: 

number

|

undefined

The min balance value to notify by email or SMS

newsNotifications

Copy URL
newsNotifications: 

false

|

undefined

|

true

Whether Voximplant news notifications are required

sendJsError

Copy URL
sendJsError: 

false

|

undefined

|

true

Whether to send an email when a JS error occures

supportBankCard

Copy URL
supportBankCard: 

false

|

undefined

|

true

Whether Bank card payments are allowed

supportInvoice

Copy URL
supportInvoice: 

false

|

undefined

|

true

Whether Bank invoices are allowed

supportRobokassa

Copy URL
supportRobokassa: 

false

|

undefined

|

true

Whether Robokassa payments are allowed

tariffChangingNotifications

Copy URL
tariffChangingNotifications: 

false

|

undefined

|

true

Whether Voximplant plan changing notifications are required

withAccessEntries

Copy URL
withAccessEntries: 

false

|

undefined

|

true

Whether the admin user permissions are granted