Accounts

Methods

Adds a new child account.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

AddAccount example

Add a new activated child account.

Parameters

account_custom_data:
string
Optional
The custom data
account_email:
string
The unique email of the new account
account_first_name:
string
Optional
The first name
account_last_name:
string
Optional
The last name
account_name:
string
Account's name must be at least 5 and up to 20 characters long. Account's name should start with a letter and can contain latin characters in lowercase, digits, hyphen
account_notifications:
boolean
Optional
Defaults on: false
Whether Voximplant notifications are required. For a new child account, the default value is false
account_password:
string
The account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
active:
boolean
Optional
Defaults on: false
Whether the child account is active (The admin permission required to activate the normal account only)
language_code:
string
Optional
Defaults on: en
The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)
location:
string
Optional
Defaults on: Etc/GMT
The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
min_balance_to_notify:
decimal
Optional
The min balance value to notify by email or SMS. The default value is $5
news_notifications:
boolean
Optional
Defaults on: false
Whether Voximplant news notifications are required. For a new child account, the default value is false
parent_account_api_key:
string
The parent account API key
parent_account_email:
string
The parent account email that can be used instead of parent_account_id
parent_account_id:
number
The parent account ID
parent_account_name:
string
The parent account name that can be used instead of parent_account_id
parent_account_password:
string
The parent account password that can be used instead of parent_account_api_key
record_storage_id:
string
Optional
The record storage id
record_storage_name:
string
Optional
The record storage name that can be used instead of record_storage_id
tariff_changing_notifications:
boolean
Optional
Defaults on: false
Whether Voximplant plan changing notifications are required. For a new child account, the default value is false

Returns

account_id:
number
The account ID
active:
boolean
Whether the account is active
api_key:
string
The account API key
result:
number
1

Configures the account's plan.

Please note that when you change the billing plan, we reserve the subscription fee and taxes for the upcoming month. Read more in the Billing page.

ChangeAccountPlan example

Change the IM plan.

Parameters

plan_subscription_template_id:
number
Optional
The new plan ID with a price larger than the current plan's (see GetAvailablePlans)
plan_type:
string
The plan type to config. The possible values are IM, MAU

Returns

account_info:
ShortAccountInfoType
The current account state
result:
number
1

Charges the account in the manual mode. You should call the ChargeAccount function to charge the subscriptions having the auto_charge=false.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Accountant

ChargeAccount example

Charge the frozen phone number: 79993330011.

Parameters

phone_id:
intlist
The phone ID list separated by semicolons (;). Use the 'all' value to select all phone ids. You should specify the phones having the auto_charge=false
phone_number:
stringlist
The phone number list separated by semicolons (;). Use the 'all' value to select all phone numbers. Can be used instead of phone_id. You should specify the phones having the auto_charge=false

Returns

account_info:
ShortAccountInfoType
The current account state
result:
ChargeAccountResult
Result

Clones a child account.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Admin

CloneAccount example

Clone a child account by the template.

Parameters

account_custom_data:
string
Optional
The custom data
account_email:
string
The cloning account email that can be used instead of account_id
account_first_name:
string
Optional
The first name
account_id:
number
The cloning account ID
account_last_name:
string
Optional
The last name
account_name:
string
The cloning account name that can be used instead of account_id
language_code:
string
Optional
Defaults on: en
The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)
location:
string
Optional
Defaults on: Etc/GMT
The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
new_account_email:
string
The new account email
new_account_name:
string
The new account's name must be at least 5 and up to 20 characters long. Account's name should start with a letter and can contain latin characters in lowercase, digits, hyphen
new_account_password:
string
The new account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
parent_account_api_key:
string
The parent account API key
parent_account_password:
string
The parent account password that can be used instead of parent_account_api_key

Returns

result:
ClonedAccountType
Result

Gets the account documents and the verification states.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Accountant

Payer

GetAccountDocuments example

Parameters

child_account_id:
intlist
Optional
The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts
children_verifications_only:
boolean
Optional
Defaults on: false
Whether to get the children account verifications only
from_unverified_hold_until:
date
Optional
Unverified subscriptions hold until the date (from …) in format: YYYY-MM-DD
to_unverified_hold_until:
date
Optional
Unverified subscriptions hold until the date (… to) in format: YYYY-MM-DD
verification_name:
string
Optional
The required account verification name to filter
verification_status:
stringlist
Optional
The account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
with_details:
boolean
Optional
Defaults on: false
Whether to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)

Returns

result:
[AccountVerifications]
The account verifications

Gets the account's info such as account_id, account_name, account_email etc.

GetAccountInfo example

Get the account's info.

Parameters

return_live_balance:
boolean
Optional
Defaults on: true
Whether to get the account's live balance

Returns

api_address:
string
The preferred address for the Management API requests
result:
AccountInfoType
Account's info as the AccountInfoType object instance

Gets the account plans with packages.

GetAccountPlans example

Get all account plans with packages.

Parameters

plan_subscription_template_id:
intlist
Optional
The plan ID list separated by semicolons (;)
plan_type:
stringlist
Optional
The plan type list separated by semicolons (;). The possible values are IM, MAU

Returns

result:
[AccountPlanType]

Gets the allowed plans to change.

GetAvailablePlans example

Get allowed IM plans to change.

Parameters

plan_subscription_template_id:
intlist
Optional
The plan ID list separated by semicolons (;)
plan_type:
stringlist
Optional
The plan type list separated by semicolons (;). The possible values are IM, MAU

Returns

result:
[PlanType]

Gets the info about all children accounts.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

GetChildrenAccounts example

Get the all children.

Parameters

active:
boolean
Optional
Whether the filter is active
brief_output:
boolean
Optional
Defaults on: false
Whether to output the account_id only
child_account_email:
string
Optional
The child account email to filter. You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email
child_account_id:
intlist
Optional
The account ID list separated by semicolons (;). You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email
child_account_name:
string
Optional
The child account name to filter. You need to specify at least one of the following parameters: child_account_id, child_account_name, child_account_email
count:
number
Optional
Defaults on: 20
The max returning record count
frozen:
boolean
Optional
Whether the filter is frozen
ignore_invalid_accounts:
boolean
Optional
Defaults on: false
Whether to ignore the invalid 'child_account_id' items
medium_output:
boolean
Optional
Defaults on: false
Whether to output the account_id, account_name, account_email only
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output
order_by:
string
Optional
Defaults on: child_account_name
The following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'
return_live_balance:
boolean
Optional
Defaults on: true
Whether to get the user live balance

Returns

count:
number
The returned user count
result:
[AccountInfoType]
total_count:
number
The total found user count

Gets the exchange rate on selected date (per USD).

GetCurrencyRate example

Get the current currency rate: RUR/USD.

Parameters

currency:
stringlist
The currency code list separated by semicolons (;). Examples: RUR, KZT, EUR, USD
date:
date
Optional
The date, format: YYYY-MM-DD

Returns

result:
ExchangeRates
The exchange rates

Get the recommended money amount to charge.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Accountant

Payer

GetMoneyAmountToCharge example

Get the recommended money amount to charge in USD.

Parameters

charge_date:
date
Optional
Defaults on: The current date
The next charge date, format: YYYY-MM-DD
currency:
string
Optional
Defaults on: The account currency
The currency name. Examples: USD, RUR, EUR

Returns

result:
GetMoneyAmountToChargeResult
Result

Gets the resource price.

GetResourcePrice example

Parameters

price_group_id:
intlist
Optional
Defaults on: all
The price group ID list separated by semicolons (;)
price_group_name:
string
Optional
Defaults on: all
The price group name template to filter
resource_param:
stringlist
Optional
The resource parameter list separated by semicolons (;). Example: a phone number list
resource_type:
stringlist
Optional
The resource type list separated by semicolons (;). The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, TTS_YANDEX, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, YANDEXASR, ASR, ASR_GOOGLE_ENHANCED

Returns

result:
[ResourcePrice]
The resource prices

Gets the subscription template price.

GetSubscriptionPrice example

Get the all subscription template prices.

Parameters

count:
number
Optional
The max returning record count
offset:
number
Optional
Defaults on: 0
The first N records are skipped in the output
subscription_template_id:
intlist
Optional
Defaults on: all
The subscription template ID list separated by semicolons (;)
subscription_template_name:
string
Optional
The subscription template name (example: SIP registration, Phone GB, Phone RU 495, …)
subscription_template_type:
string
Optional
The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION

Returns

result:
[SubscriptionTemplateType]
The subscription template prices

Edits the account's profile.

To call this method, make sure your service account has one of the following roles:

See Available Roles

Owner

Admin

Developer

Accountant

Payer

SetAccountInfo example

Change the account's password.

Parameters

account_custom_data:
string
Optional
The custom data
account_first_name:
string
Optional
The first name
account_last_name:
string
Optional
The last name
account_notifications:
boolean
Optional
Whether Voximplant notifications are required
billing_address_address:
string
Optional
The valid address that needs to be specified to pay for any services. You cannot delete it later, only change
billing_address_country_code:
string
Optional
The billing address country code (2 symbols, ISO 3166-1 alpha-2). The following values are available: AF (Afghanistan), AL (Albania), DZ (Algeria), AS (American Samoa), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua and Barbuda), AR (Argentina), AM (Armenia), AW (Aruba), AU (Australia), AT (Austria), AZ (Azerbaijan), BH (Bahrain), BD (Bangladesh), BB (Barbados), BY (Belarus), BE (Belgium), BZ (Belize), BJ (Benin), BM (Bermuda), BT (Bhutan), BO (Bolivia), BA (Bosnia and Herzegovina), BW (Botswana), BV (Bouvet Island), BR (Brazil), IO (British Indian Ocean Territory), BN (Brunei), BG (Bulgaria), BF (Burkina Faso), BI (Burundi), KH (Cambodia), CM (Cameroon), CA (Canada), CV (Cape Verde), KY (Cayman Islands), CF (Central African Republic), TD (Chad), CL (Chile), CN (China), CX (Christmas Island), CO (Colombia), KM (Comoros), CG (Congo), CK (Cook Islands), CR (Costa Rica), HR (Croatia), CU (Cuba), CY (Cyprus), CZ (Czech Republic), DK (Denmark), DJ (Djibouti), DM (Dominica), DO (Dominican Republic), EC (Ecuador), EG (Egypt), SV (El Salvador), GQ (Equatorial Guinea), ER (Eritrea), EE (Estonia), ET (Ethiopia), FO (Faroe Islands), FJ (Fiji Islands), FI (Finland), FR (France), GF (French Guiana), PF (French Polynesia), TF (French Southern and Antarctic Lands), GA (Gabon), GE (Georgia), DE (Germany), GH (Ghana), GI (Gibraltar), GR (Greece), GL (Greenland), GD (Grenada), GP (Guadeloupe), GU (Guam), GT (Guatemala), GG (Guernsey), GN (Guinea), GY (Guyana), HT (Haiti), HM (Heard Island and McDonald Islands), HN (Honduras), HU (Hungary), IS (Iceland), IN (India), ID (Indonesia), IR (Iran), IQ (Iraq), IE (Ireland), IL (Israel), IT (Italy), JM (Jamaica), JP (Japan), JE (Jersey), JO (Jordan), KZ (Kazakhstan), KE (Kenya), KI (Kiribati), KR (Korea), KW (Kuwait), KG (Kyrgyzstan), LA (Laos), LV (Latvia), LB (Lebanon), LS (Lesotho), LR (Liberia), LY (Libya), LI (Liechtenstein), LT (Lithuania), LU (Luxembourg), MG (Madagascar), MW (Malawi), MY (Malaysia), MV (Maldives), ML (Mali), MT (Malta), MH (Marshall Islands), MQ (Martinique), MR (Mauritania), MU (Mauritius), YT (Mayotte), MX (Mexico), FM (Micronesia), MD (Moldova), MC (Monaco), MN (Mongolia), ME (Montenegro), MS (Montserrat), MA (Morocco), MZ (Mozambique), MM (Myanmar), NA (Namibia), NR (Nauru), NP (Nepal), NL (Netherlands), AN (Netherlands Antilles), NC (New Caledonia), NZ (New Zealand), NI (Nicaragua), NE (Niger), NG (Nigeria), NU (Niue), NF (Norfolk Island), KP (North Korea), MP (Northern Mariana Islands), NO (Norway), OM (Oman), PK (Pakistan), PW (Palau), PS (Palestinian Authority), PA (Panama), PG (Papua New Guinea), PY (Paraguay), PE (Peru), PH (Philippines), PN (Pitcairn Islands), PL (Poland), PT (Portugal), PR (Puerto Rico), QA (Qatar), RE (Reunion), RO (Romania), RU (Russia), RW (Rwanda), WS (Samoa), SM (San Marino), SA (Saudi Arabia), SN (Senegal), RS (Serbia), SC (Seychelles), SL (Sierra Leone), SG (Singapore), SK (Slovakia), SI (Slovenia), SB (Solomon Islands), SO (Somalia), ZA (South Africa), GS (South Georgia and the South Sandwich Islands), ES (Spain), LK (Sri Lanka), SD (Sudan), SR (Suriname), SZ (Swaziland), SE (Sweden), CH (Switzerland), SY (Syria), ST (Sao Tome and Principe), TW (Taiwan), TJ (Tajikistan), TZ (Tanzania), TH (Thailand), TG (Togo), TK (Tokelau), TO (Tonga), TT (Trinidad and Tobago), TN (Tunisia), TR (Turkey), TM (Turkmenistan), TC (Turks and Caicos Islands), TV (Tuvalu), UG (Uganda), UA (Ukraine), AE (United Arab Emirates), GB (United Kingdom), US (United States), UY (Uruguay), UZ (Uzbekistan), VU (Vanuatu), VA (Vatican City), VE (Venezuela), VN (Vietnam), VI (Virgin Islands), WF (Wallis and Futuna), EH (Western Sahara), YE (Yemen), ZM (Zambia), ZW (Zimbabwe), AX (Aland Islands)
billing_address_name:
string
Optional
The company or businessman name
billing_address_phone:
string
Optional
The office phone number
billing_address_zip:
string
Optional
The office ZIP
callback_salt:
string
Optional
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
callback_url:
string
Optional
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 AccountCallback structure. The HTTP request has a JSON-encoded body that conforms to the AccountCallbacks structure
language_code:
string
Optional
The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)
location:
string
Optional
The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
min_balance_to_notify:
decimal
Optional
The min balance value to notify by email or SMS
new_account_email:
string
Optional
The new account email
new_account_password:
string
Optional
The new account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
news_notifications:
boolean
Optional
Whether to receive the emails about the Voximplant news
send_js_error:
boolean
Optional
Whether to receive the emails about a JS scenario error
store_inbound_sms:
boolean
Optional
Whether to store incoming message texts. Default value is false
store_outbound_sms:
boolean
Optional
Whether to store outgoing message texts. Default value is false
tariff_changing_notifications:
boolean
Optional
Whether to receive the emails about the Voximplant plan changing

Returns

result:
number
1

Edits the account's profile.

SetChildAccountInfo example

Disable the child account.

Parameters

account_notifications:
boolean
Optional
Whether Voximplant notifications are required
active:
boolean
Optional
Whether to enable the child account
can_use_restricted:
boolean
Optional
Whether to allow use restricted directions
child_account_email:
stringlist
The child account email list separated by semicolons (;). Can be used instead of child_account_id
child_account_id:
intlist
The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts
child_account_name:
stringlist
The child account name list separated by semicolons (;). Can be used instead of child_account_id
language_code:
string
Optional
The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)
location:
string
Optional
The child account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
min_balance_to_notify:
decimal
Optional
The min balance value to notify by email or SMS
new_child_account_email:
string
Optional
The new child account email
new_child_account_password:
string
Optional
The new child account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
news_notifications:
boolean
Optional
Whether to receive the emails about the Voximplant news
support_bank_card:
boolean
Optional
Whether to allow the bank card payments
support_invoice:
boolean
Optional
Whether to allow the bank invoices
support_robokassa:
boolean
Optional
Whether to allow the robokassa payments
tariff_changing_notifications:
boolean
Optional
Whether to receive the emails about the Voximplant plan changing

Returns

result:
number
1

Methods

AddAccount

AddAccount example

Parameters

account_custom_data:

account_email:

account_first_name:

account_last_name:

account_name:

account_notifications:

account_password:

active:

language_code:

location:

min_balance_to_notify:

news_notifications:

parent_account_api_key:

parent_account_email:

parent_account_id:

parent_account_name:

parent_account_password:

record_storage_id:

record_storage_name:

tariff_changing_notifications:

Returns

account_id:

active:

api_key:

result:

ChangeAccountPlan

ChangeAccountPlan example

Parameters

plan_subscription_template_id:

plan_type:

Returns

account_info:

result:

ChargeAccount

ChargeAccount example

Parameters

phone_id:

phone_number:

Returns

account_info:

result:

CloneAccount

CloneAccount example

Parameters

account_custom_data:

account_email:

account_first_name:

account_id:

account_last_name:

account_name:

language_code:

location:

new_account_email:

new_account_name:

new_account_password:

parent_account_api_key:

parent_account_password:

Returns

result:

GetAccountDocuments

GetAccountDocuments example

Parameters

child_account_id:

children_verifications_only:

from_unverified_hold_until:

to_unverified_hold_until:

verification_name:

verification_status:

with_details:

Returns

result:

GetAccountInfo

GetAccountInfo example

Parameters

return_live_balance:

Returns