Rate this page:

AccountInfo

Props

a2pSmsEnabled
Optional
Copy URL
a2pSmsEnabled: 

boolean

Whether to activate one-way SMS

accessEntries
Optional
Copy URL
accessEntries: 

string[]

The allowed access entries (the API function names)

accountCustomData
Optional
Copy URL
accountCustomData: 

string

The custom data

accountEmail
Copy URL
accountEmail: 

string

The account's email

accountFirstName
Optional
Copy URL
accountFirstName: 

string

The first name

accountId
Copy URL
accountId: 

number

The account's ID

accountLastName
Optional
Copy URL
accountLastName: 

string

The last name

accountName
Copy URL
accountName: 

string

The account's name

accountNotifications
Optional
Copy URL
accountNotifications: 

boolean

Whether Voximplant notifications are required

active
Copy URL
active: 

boolean

Whether the account is active

apiKey
Optional
Copy URL
apiKey: 

string

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

balance
Optional
Copy URL
balance: 

number

The account's money

billingAddressAddress
Optional
Copy URL
billingAddressAddress: 

string

The office address

billingAddressCountryCode
Optional
Copy URL
billingAddressCountryCode: 

string

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

billingAddressName
Optional
Copy URL
billingAddressName: 

string

The company or businessman name

billingAddressPhone
Optional
Copy URL
billingAddressPhone: 

string

The office phone number

billingAddressState
Optional
Copy URL
billingAddressState: 

string

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

billingAddressZip
Optional
Copy URL
billingAddressZip: 

string

The office ZIP

billingLimits
Optional
Copy URL
billingLimits: 

BillingLimits

The payments limits applicable to each payment method

callbackSalt
Optional
Copy URL
callbackSalt: 

string

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
Optional
Copy URL
callbackUrl: 

string

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
Optional
Copy URL
creditLimit: 

number

The account's credit limit

currency
Optional
Copy URL
currency: 

string

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

frozen
Optional
Copy URL
frozen: 

boolean

Whether account is blocked by Voximplant admins

languageCode
Optional
Copy URL
languageCode: 

string

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

location
Optional
Copy URL
location: 

string

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

minBalanceToNotify
Optional
Copy URL
minBalanceToNotify: 

number

The minimum balance value to notify by email or SMS

newsNotifications
Optional
Copy URL
newsNotifications: 

boolean

Whether Voximplant news notifications are required

sendJsError
Optional
Copy URL
sendJsError: 

boolean

Whether to send an email when a JS error occurs

supportBankCard
Optional
Copy URL
supportBankCard: 

boolean

Whether Bank card payments are allowed

supportInvoice
Optional
Copy URL
supportInvoice: 

boolean

Whether Bank invoices are allowed

supportRobokassa
Optional
Copy URL
supportRobokassa: 

boolean

Whether Robokassa payments are allowed

tariffChangingNotifications
Optional
Copy URL
tariffChangingNotifications: 

boolean

Whether Voximplant plan changing notifications are required

withAccessEntries
Optional
Copy URL
withAccessEntries: 

boolean

Whether the admin user permissions are granted

Rate this page: