Accounts
Methods
AddAccount
Adds a new child account.
To call this method, make sure your service account has one of the following roles:
Parameters
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_email:
string
The parent account email that can be used instead of parent_account_id
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
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_email:
string
The unique email of the new account
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
OptionalDefaults on: falseThe child account activation flag (The admin permission required to activate the normal account only)
language_code:
string
OptionalDefaults on: enThe 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
OptionalDefaults on: Etc/GMTThe account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
min_balance_to_notify:
decimal
OptionalThe min balance value to notify by email or SMS
account_custom_data:
string
OptionalThe custom data
account_first_name:
string
OptionalThe first name
account_last_name:
string
OptionalThe last name
account_notifications:
boolean
OptionalDefaults on: falseVoximplant notifications are required. For a new child account, false by default
tariff_changing_notifications:
boolean
OptionalDefaults on: falseVoximplant plan changing notifications are required. For a new child account, false by default
news_notifications:
boolean
OptionalDefaults on: falseVoximplant news notifications are required. For a new child account, false by default
record_storage_id:
string
OptionalThe record storage id
record_storage_name:
string
OptionalThe record storage name that can be used instead of record_storage_id
Returns
result:
number
1
account_id:
number
The account ID
api_key:
string
The account API key
active:
boolean
The account activation flag
CloneAccount
Clones a child account.
To call this method, make sure your service account has one of the following roles:
Parameters
account_id:
number
The cloning account ID
account_name:
string
The cloning account name that can be used instead of account_id
account_email:
string
The cloning account email that can be used instead of account_id
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
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_email:
string
The new account email
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
language_code:
string
OptionalDefaults on: enThe 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
OptionalDefaults on: Etc/GMTThe account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
account_custom_data:
string
OptionalThe custom data
account_first_name:
string
OptionalThe first name
account_last_name:
string
OptionalThe last name
Returns
result:
ClonedAccountType
Result
GetAccountInfo
Gets the account's info such as account_id, account_name, account_email etc.
Parameters
return_live_balance:
boolean
OptionalDefaults on: trueSet true to get the account's live balance
Returns
result:
Account's info as the AccountInfoType object instance
api_address:
string
The preferred address for the Management API requests
SetAccountInfo
Edits the account's profile.
To call this method, make sure your service account has one of the following roles:
Parameters
new_account_email:
string
OptionalThe new account email
new_account_password:
string
OptionalThe 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
language_code:
string
OptionalThe 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
OptionalThe account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
account_first_name:
string
OptionalThe first name
account_last_name:
string
OptionalThe last name
min_balance_to_notify:
decimal
OptionalThe min balance value to notify by email or SMS
account_notifications:
boolean
OptionalVoximplant notifications are required
tariff_changing_notifications:
boolean
OptionalSet to true to receive the emails about the Voximplant plan changing
news_notifications:
boolean
OptionalSet to true to receive the emails about the Voximplant news
send_js_error:
boolean
OptionalSet to true to receive the emails about a JS scenario error
billing_address_name:
string
OptionalThe company or businessman name
billing_address_country_code:
string
OptionalThe 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_address:
string
OptionalThe valid address that needs to be specified to pay for any services. It can't be deleted later, only changed
billing_address_zip:
string
OptionalThe office ZIP
billing_address_phone:
string
OptionalThe office phone number
account_custom_data:
string
OptionalThe custom data
callback_url:
string
OptionalIf URL is specified, Voximplant cloud will make 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 will have a JSON-encoded body that conforms to the AccountCallbacks structure
callback_salt:
string
OptionalIf salt string is specified, each HTTP request made by the Voximplant cloud toward the callback_url will have 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
store_outbound_sms:
boolean
OptionalSet to true to store outbound message texts. Default value is false
store_inbound_sms:
boolean
OptionalSet to true to store inbound message texts. Default value is false
Returns
result:
number
1
SetChildAccountInfo
Edits the account's profile.
Parameters
child_account_id:
intlist
The child account ID list separated by semicolon (;). Use the 'all' value to select all child accounts
child_account_name:
stringlist
The child account name list separated by semicolon (;). Can be used instead of child_account_id
child_account_email:
stringlist
The child account email list separated by semicolon (;). Can be used instead of child_account_id
new_child_account_email:
string
OptionalThe new child account email
new_child_account_password:
string
OptionalThe 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
account_notifications:
boolean
OptionalVoximplant notifications are required
tariff_changing_notifications:
boolean
OptionalSet to true to receive the emails about the Voximplant plan changing
news_notifications:
boolean
OptionalSet to true to receive the emails about the Voximplant news
active:
boolean
OptionalSet false to disable the child account
language_code:
string
OptionalThe 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
OptionalThe child account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10
min_balance_to_notify:
decimal
OptionalThe min balance value to notify by email or SMS
support_robokassa:
boolean
OptionalSet to true to allow the robokassa payments
support_bank_card:
boolean
OptionalSet to true to allow the bank card payments
support_invoice:
boolean
OptionalSet to true to allow the bank invoices
can_use_restricted:
boolean
OptionalSet to true to allow use restricted directions
min_payment_amount:
number
OptionalThe minimum payment amount
Returns
result:
number
1
GetCurrencyRate
Gets the exchange rate on selected date (per USD).
Parameters
currency:
stringlist
The currency code list separated by semicolon (;). Examples: RUR, EUR, USD
date:
date
OptionalThe date, format: YYYY-MM-DD
Returns
result:
The exchange rates
GetResourcePrice
Gets the resource price.
Parameters
resource_type:
stringlist
OptionalThe resource type list separated by semicolon (;). 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
price_group_id:
intlist
OptionalDefaults on: allThe price group ID list separated by semicolon (;)
price_group_name:
string
OptionalDefaults on: allThe price group name template to filter
resource_param:
stringlist
OptionalThe resource parameter list separated by semicolon (;). Example: a phone number list
Returns
result:
The resource prices
GetSubscriptionPrice
Gets the subscription template price.
Parameters
subscription_template_id:
intlist
OptionalDefaults on: allThe subscription template ID list separated by semicolon (;)
subscription_template_type:
string
OptionalThe subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION
subscription_template_name:
string
OptionalThe subscription template name (example: SIP registration, Phone GB, Phone RU 495, …)
count:
number
OptionalThe max returning record count
offset:
number
OptionalDefaults on: 0The first N records will be skipped in the output
Returns
result:
The subscription template prices
GetChildrenAccounts
Gets the info about all children accounts.
To call this method, make sure your service account has one of the following roles:
Parameters
child_account_id:
intlist
OptionalThe account ID list separated by semicolon (;). Use the 'all' value to select all accounts
child_account_name:
string
OptionalThe child account name part to filter
child_account_email:
string
OptionalThe child ccount email to filter
active:
boolean
OptionalThe active flag to filter
frozen:
boolean
OptionalThe frozen flag to filter
ignore_invalid_accounts:
boolean
OptionalDefaults on: falseSet true to ignore the invalid 'child_account_id' items
brief_output:
boolean
OptionalDefaults on: falseSet true to output the account_id only
medium_output:
boolean
OptionalDefaults on: falseSet true to output the account_id, account_name, account_email only
count:
number
OptionalDefaults on: 20The max returning record count
offset:
number
OptionalDefaults on: 0The first N records will be skipped in the output
order_by:
string
OptionalDefaults on: child_account_nameThe following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'
return_live_balance:
boolean
OptionalDefaults on: trueSet true to get the user live balance
Returns
result:
total_count:
number
The total found user count
count:
number
The returned user count
GetMoneyAmountToCharge
Get the recommended money amount to charge.
To call this method, make sure your service account has one of the following roles:
Parameters
currency:
string
OptionalDefaults on: The account currencyThe currency name. Examples: USD, RUR, EUR
charge_date:
date
OptionalDefaults on: The current dateThe next charge date, format: YYYY-MM-DD
Returns
result:
Result
ChargeAccount
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:
Parameters
phone_id:
intlist
The phone ID list separated by semicolon (;). 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 semicolon (;). 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
result:
Result
account_info:
The current account state
ChangeAccountPlan
Configures the account's plan.
Parameters
plan_type:
string
The plan type to config. The possible values are IM, MAU
plan_subscription_template_id:
number
OptionalThe new plan ID with a price larger than the current plan's (see GetAvailablePlans)
Returns
result:
number
1
account_info:
The current account state
GetAccountPlans
Gets the account plans with packages.
Parameters
plan_type:
stringlist
OptionalThe plan type list separated by semicolon (;). The possible values are IM, MAU
plan_subscription_template_id:
intlist
OptionalThe plan ID list separated by semicolon (;)
Returns
result:
GetAvailablePlans
Gets the allowed plans to change.
Parameters
plan_type:
stringlist
OptionalThe plan type list separated by semicolon (;). The possible values are IM, MAU
plan_subscription_template_id:
intlist
OptionalThe plan ID list separated by semicolon (;)
Returns
result:
GetAccountDocuments
Gets the account documents and the verification states.
To call this method, make sure your service account has one of the following roles:
Parameters
with_details:
boolean
OptionalDefaults on: falseSet true to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)
verification_name:
string
OptionalThe required account verification name to filter
verification_status:
stringlist
OptionalThe account verification status list separated by semicolon (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
from_unverified_hold_until:
date
OptionalUnverified subscriptions hold until the date (from …) in format: YYYY-MM-DD
to_unverified_hold_until:
date
OptionalUnverified subscriptions hold until the date (… to) in format: YYYY-MM-DD
child_account_id:
intlist
OptionalThe child account ID list separated by semicolon (;). Use the 'all' value to select all child accounts
children_verifications_only:
boolean
OptionalDefaults on: falseSet true to get the children account verifications only
Returns
result:
The account verifications