SIGN UP

Managing Accounts

Methods

AddAccount

Adds a new child account.

Please note that this function is restricted and disabled by default. To use it you need to contact our support team.

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.

  • session_id:

    string

    The API session ID 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 e-mail of the new account.

  • account_password:

    string

    The password length must be at least 6 symbols.

  • active:

    boolean
    Optional
    Defaults to false

    The child account activation flag (The admin permission required to activate the normal account only).

  • language_code:

    string
    Optional
    Defaults to 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 (Byelorussian), 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 to Etc/GMT

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

  • min_balance_to_notify:

    number
    Optional

    The min balance value to notify by email or SMS.

  • 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
    Defaults to false

    Are the VoxImplant notifications required? The default is false for a new child account.

  • tariff_changing_notifications:

    boolean
    Optional
    Defaults to false

    Are the VoxImplant tariff changing notifications required? The default is false for a new child account.

  • news_notifications:

    boolean
    Optional
    Defaults to false

    Are the VoxImplant news notifications required? The default is false for a new child account.

  • 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.

Returns

  • result:

    number

    1

  • account_id:

    number

    The account ID

  • api_key:

    string

    The account API key.

  • active:

    boolean

    The account activation flag.

Examples

request:

Add a new activated child account.

https://api.voximplant.com/platform_api/AddAccount/?account_name=my-account-name&account_email=my_email%40mail.ru&account_password=1234567&active=true&parent_account_name=myparent&parent_account_password=7654321

response:

success but activation is required to use the new account.

{
    "active": false,
    "result": 1,
    "api_key": "3175a161-b59a-4715-8d8d-4944585e2025",
    "account_id": 61
}

success.

{
    "active": true,
    "result": 1,
    "api_key": "7975a166-a591-8711-9d8d-9946685e2028",
    "account_id": 62
}

ChargeAccount

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

Parameters

  • Follow link for authentication parameter names and details.

  • phone_id:

    string

    The phone ID list separated by the ';' symbol or the 'all' value. You should specify the phones having the auto_charge=false.

  • phone_number:

    string

    Can be used instead of phone_id. The phone number list separated by the ';' symbol or the 'all' value. You should specify the phones having the auto_charge=false.

Returns

Examples

request:

Charge the frozen phone number: 79993330011

https://api.voximplant.com/platform_api/ChargeAccount/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_number=79993330011

Charge the all frozen phone numbers.

https://api.voximplant.com/platform_api/ChargeAccount/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_number=all

response:

The 74997058301 phone has been charged.

{
    "result": {
        "phones": [
            {
                "phone_id": 70,
                "is_charged": true,
                "deactivated": false,
                "phone_number": "74997058301"
            },
            {
                "phone_id": 131,
                "is_charged": false,
                "deactivated": false,
                "phone_number": "12055645250"
            },
            {
                "phone_id": 132,
                "is_charged": false,
                "deactivated": true,
                "phone_number": "18443325157"
            }
        ],
        "charged_amount": 500
    },
    "account_info": {
        "frozen": false,
        "balance": 1360,
        "currency": "RUR",
        "tariff_id": 1,
        "account_id": 52,
        "next_charge": "2015-03-13",
        "tariff_name": "default",
        "periodic_charge": 0
    }
}

CloneAccount

Clones a child account.

Please note that this function is restricted and disabled by default. To use it you need to contact our support team.

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.

  • session_id:

    string

    The API session ID 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 password length must be at least 6 symbols.

  • language_code:

    string
    Optional
    Defaults to 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 (Byelorussian), 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 to Etc/GMT

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

  • account_custom_data:

    string
    Optional

    The custom data.

  • account_first_name:

    string
    Optional

    The first name.

  • account_last_name:

    string
    Optional

    The last name.

Returns

Examples

request:

Clone a child account by the template.

https://api.voximplant.com/platform_api/CloneAccount/?account_name=account-template&new_account_name=my-account-name&new_account_email=my_email%40mail.ru&new_account_password=1234567&parent_account_api_key=3175a161-b59a-4715-8d8d-4944585e2025

response:

success.

{
    "result": {
        "users": [
            {
                "user_id": 664415,
                "user_name": "user1"
            }
        ],
        "active": true,
        "api_key": "06465b23-4e50-4d85-b2d9-dcc5acec48f5",
        "scenarios": [
            {
                "scenario_id": 15022,
                "scenario_name": "my-scenario"
            }
        ],
        "account_id": 7645,
        "acd_queues": [
            {
                "acd_queue_id": 117,
                "acd_queue_name": "reception1"
            }
        ],
        "acd_skills": [
            {
                "skill_id": 107,
                "skill_name": "manager1"
            }
        ],
        "admin_roles": [
            {
                "admin_role_id": 50,
                "admin_role_name": "role1"
            }
        ],
        "admin_users": [
            {
                "admin_user_id": 31,
                "admin_user_name": "guest1",
                "admin_user_api_key": "3e53d2ec-5b66-4745-bd57-38228f2935c8"
            }
        ],
        "account_name": "my-account-name",
        "applications": [
            {
                "rules": [
                    {
                        "rule_id": 22890,
                        "rule_name": "rule1"
                    }
                ],
                "application_id": 29378,
                "application_name": "app1.my-account-name.voximplant.com"
            }
        ],
        "account_email": "my_email@mail.ru"
    }
}

ConfirmAccountPasswordChange

Confirm the account password change. Use it after the call of the SendAccountPasswordChangeRequest method.

Parameters

  • account_id:

    number

    The account ID.

  • account_name:

    string

    The account name, can be used instead of account_id.

  • account_email:

    string

    The account email, can be used instead of account_id.

  • new_account_password:

    string
    Optional

    The password length must be at least 6 symbols.

  • code:

    string

    The verification code (auth token). The code will be sended to the specified email after the SendAccountPasswordChangeRequest method was called.

Returns

  • result:

    number

    1

Examples

request:

Set the new password.

https://api.voximplant.com/platform_api/ConfirmAccountPasswordChange/?account_email=mymail%40mail.ru&code=secr2t&new_account_password=newpswd

response:

Success.

{
    "result": 1
}

GetAccountDocuments

Gets the account documents and the verification states.

Parameters

  • Follow link for authentication parameter names and details.

  • with_details:

    boolean
    Optional
    Defaults to false

    Set true to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)

  • verification_name:

    string
    Optional

    The required account verification name to filter.

  • verification_status:

    string
    Optional

    The account verification status list separated by the ';' symbol. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED

  • from_unverified_hold_until:

    string
    Optional

    Unverified subscriptions hold until the date (from ...) in format: YYYY-MM-DD

  • to_unverified_hold_until:

    string
    Optional

    Unverified subscriptions hold until the date (... to) in format: YYYY-MM-DD

  • child_account_id:

    string
    Optional

    The child account ID list separated by the ';' symbol or the 'all' value.

  • children_verifications_only:

    boolean
    Optional
    Defaults to false

    Set true to get the children account verifications only.

Returns

Examples

request:

https://api.voximplant.com/platform_api/GetAccountDocuments/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_details=true

response:

{
    "result": [
        {
            "account_id": 1,
            "verifications": [
                {
                    "documents": [
                        {
                            "comment": "very low quality",
                            "uploaded": "2015-02-01 06:50:07",
                            "is_individual": true,
                            "account_document_id": 66,
                            "account_document_status": "REJECTED"
                        },
                        {
                            "uploaded": "2015-02-01 07:34:01",
                            "is_individual": true,
                            "account_document_id": 74,
                            "account_document_status": "IN_PROGRESS"
                        }
                    ],
                    "verification_name": "RU",
                    "verification_status": "IN_PROGRESS",
                    "unverified_hold_until": "2015-02-15"
                }
            ]
        }
    ]
}

GetAccountInfo

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

Parameters

  • Follow link for authentication parameter names and details.

  • return_live_balance:

    boolean
    Optional
    Defaults to true

    Set true to get the account's live balance.

Returns

  • result:

    Object

    Account's info as the AccountInfoType object instance.

  • api_address:

    string

    The preferred address for the http api requests.

GetChildrenAccounts

Gets the info about all children accounts.

Please note that this function is restricted and disabled by default. To use it you need to contact our support team.

Parameters

  • Follow link for authentication parameter names and details.

  • child_account_id:

    string
    Optional

    The account ID list separated by the ';' symbol or the 'all' value.

  • child_account_name:

    string
    Optional

    The child account name part to filter.

  • child_account_email:

    string
    Optional

    The child ccount email to filter.

  • active:

    boolean
    Optional

    The active flag to filter.

  • frozen:

    boolean
    Optional

    The frozen flag to filter.

  • ignore_invalid_accounts:

    boolean
    Optional
    Defaults to false

    Set true to ignore the invalid 'child_account_id' items.

  • brief_output:

    boolean
    Optional
    Defaults to false

    Set true to output the account_id only.

  • medium_output:

    boolean
    Optional
    Defaults to false

    Set true to output the account_id, account_name, account_email only.

  • count:

    number
    Optional
    Defaults to 20

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 0

    The first N records will be skipped in the output.

  • order_by:

    string
    Optional
    Defaults to child_account_name

    The following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'.

  • return_live_balance:

    boolean
    Optional
    Defaults to true

    Set true to get the user live balance.

Returns

  • result:

    [ AccountInfoType ]
  • total_count:

    number

    The total found user count.

  • count:

    number

    The returned user count.

Examples

request:

Get the all children.

https://api.voximplant.com/platform_api/GetChildrenAccounts/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac

Get the particular child.

https://api.voximplant.com/platform_api/GetChildrenAccounts/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&child_account_email=mychild%40gmail.com

GetCurrencyRate

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

Parameters

  • currency:

    string

    The currency code list separated by the ';' symbol. Examples: RUR, EUR, USD

  • date:

    string
    Optional

    The date, format: YYYY-MM-DD

Returns

Examples

request:

Get the current currency rate: RUR/USD.

https://api.voximplant.com/platform_api/GetCurrencyRate/?currency=RUR

Get the old currency rate: RUR/USD.

https://api.voximplant.com/platform_api/GetCurrencyRate/?currency=RUR&date=2014-03-17

Get the current currency rates: RUR/USD and EUR/USD.

https://api.voximplant.com/platform_api/GetCurrencyRate/?currency=RUR;EUR

response:

The RUR/USD.

{
    "result": {
        "RUR": 34.12
    }
}

The RUR/USD and EUR/USD.

{
    "result": {
        "EUR": 0.984,
        "RUR": 34.12
    }
}

GetMoneyAmountToCharge

Get the recommended money amount to charge.

Parameters

  • Follow link for authentication parameter names and details.

  • currency:

    string
    Optional
    Defaults to The account currency.

    The currency name. Examples: USD, RUR, EUR.

  • charge_date:

    string
    Optional
    Defaults to The current date.

    The next charge date, format: YYYY-MM-DD

Returns

Examples

request:

Get the recommended money amount to charge in USD.

https://api.voximplant.com/platform_api/GetMoneyAmountToCharge/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&currency=USD

response:

The account balance is 1$ + min_amount(7$) = amount(8$).

{
    "result": {
        "amount": 8,
        "min_amount": 7,
        "subscriptions": [
            {
                "subscription_type": "PHONE_NUM",
                "subscription_amount": 5,
                "subscription_description": "74997004411"
            },
            {
                "subscription_type": "PHONE_NUM",
                "subscription_amount": 3,
                "subscription_description": "15002229950"
            }
        ],
        "bank_card_amount_usd": 10,
        "robokassa_amount_rub": 500,
        "min_bank_card_amount_usd": 7,
        "min_robokassa_amount_rub": 500
    }
}

GetResourcePrice

Gets the resource price.

Parameters

  • Follow link for authentication parameter names and details.

  • resource_type:

    string
    Optional

    The resource type list separated by the ';' symbol. The possible values are: ASR, AUDIORECORD, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_IN_US, PSTN_IN_US_TF, PSTNOUT, SIPOUT, SIPOUTVIDEO, VOIPIN, VOIPOUT, VOIPOUTVIDEO

  • price_group_id:

    string
    Optional
    Defaults to all

    The price group ID list separated by the ';' symbol.

  • price_group_name:

    string
    Optional
    Defaults to all

    The price group name template to filter.

  • resource_param:

    string
    Optional

    The resource parameter list separated by the ';' symbol. Example: a phone number list.

Returns

Examples

request:

https://api.voximplant.com/platform_api/GetResourcePrice/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac
https://api.voximplant.com/platform_api/GetResourcePrice/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&resource_type=VOIPIN;VOIPOUT

Get the price to call to the phone number 79263332211

https://api.voximplant.com/platform_api/GetResourcePrice/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&resource_type=PSTNOUT&resource_param=79263332211

response:

The result filtered by the 79263332211 phone number.

{
    "result": [
        {
            "price_groups": [
                {
                    "price": 0.02,
                    "params": {
                        "allowed": [
                            ""
                        ]
                    },
                    "quantum": 60,
                    "price_group_id": 1,
                    "price_group_name": "Any VoIP in",
                    "num_resources_per_price": 60
                }
            ],
            "resource_type": "VOIPIN"
        },
        {
            "price_groups": [
                {
                    "price": 0.02,
                    "params": {
                        "allowed": [
                            ""
                        ]
                    },
                    "quantum": 60,
                    "price_group_id": 121,
                    "price_group_name": "VoIP Out",
                    "num_resources_per_price": 60
                }
            ],
            "resource_type": "VOIPOUT"
        }
    ]
}

The result filtered by the 79263332211 phone number.

{
    "result": [
        {
            "price_groups": [
                {
                    "price": 0.06,
                    "quant": 60,
                    "params": {
                        "allowed": [
                            "79"
                        ],
                        "forbidden": [
                            "7954",
                            "7997",
                            "7940"
                        ],
                        "requested": [
                            "79263332211"
                        ]
                    },
                    "price_group_id": 20,
                    "price_group_name": "Russia Mobile",
                    "num_resources_per_price": 60
                }
            ],
            "resource_type": "PSTNOUT"
        }
    ]
}

GetSubscriptionPrice

Gets the subscription template price.

Parameters

  • Follow link for authentication parameter names and details.

  • subscription_template_id:

    string
    Optional
    Defaults to all

    The subscription template ID list separated by the ';' symbol.

  • subscription_template_type:

    string
    Optional

    The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION.

  • subscription_template_name:

    string
    Optional

    The subscription template name (example: SIP registration, Phone GB, Phone RU 495, ...).

  • count:

    number
    Optional

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 0

    The first N records will be skipped in the output.

Returns

Examples

request:

Get the all subscription template prices.

https://api.voximplant.com/platform_api/GetSubscriptionPrice/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac

Get the SIP registration subscription template.

https://api.voximplant.com/platform_api/GetSubscriptionPrice/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&subscription_template_type=SIP_REGISTRATION

response:

Success.

{
    "count": 3,
    "result": [
        {
            "price": 293.855,
            "period": "0-1-0 0:0:0",
            "installation_price": 0,
            "subscription_template_id": 20,
            "subscription_template_name": "Phone BG",
            "subscription_template_type": "PHONE_NUM"
        },
        {
            "price": 1500,
            "period": "0-1-0 0:0:0",
            "installation_price": 3000,
            "subscription_template_id": 6,
            "subscription_template_name": "Phone RU TollFree",
            "subscription_template_type": "PHONE_NUM"
        },
        {
            "price": 587.71,
            "period": "0-1-0 0:0:0",
            "installation_price": 0,
            "subscription_template_id": 53,
            "subscription_template_name": "SIP registration",
            "subscription_template_type": "SIP_REGISTRATION"
        }
    ],
    "total_count": 51
}

SendAccountPasswordChangeRequest

Send the account password change request by email. The email will contain a random code that could be used in the ConfirmAccountPasswordChange method

Parameters

  • account_email:

    string

    The account email.

Returns

  • result:

    number

    1

Examples

request:

Send the account password change request with the default handler.

https://api.voximplant.com/platform_api/SendAccountPasswordChangeRequest/?account_email=mymail%40mail.ru

response:

Success.

{
    "result": 1
}

SetAccountDocument

Upload an account verification document. IMPORTANT: the method provides verification for the Russian Federation only. You should post the data with the 'multipart/form-data' content type.

Parameters

  • Follow link for authentication parameter names and details.

  • is_individual:

    boolean
    Optional
    Defaults to true

    Is individual, isn't legal entity?

  • account_document:

    application/octet-stream

    The document data. You should post the data with the 'application/octet-stream' or 'multipart/form-data' content type. Supported formats: JPG, JPEG, PNG, TIFF, PDF. Maximum size is 5 Mb. Uploaded documents available in documents section of the Control panel.

  • verification_name:

    string

    The account verification name.

  • individual_full_name:

    string
    Optional

    The full name of the individual.

  • individual_birth_date:

    string
    Optional

    The birth date in format: YYYY-MM-DD

  • individual_passport_series:

    string
    Optional

    The passport series of the individual.

  • individual_passport_number:

    string
    Optional

    The passport number of the individual.

  • individual_passport_issue_date:

    string
    Optional

    The passport issue date in format: YYYY-MM-DD

  • individual_passport_issued_by:

    string
    Optional

    The passport issued by.

  • individual_registration_address:

    string
    Optional

    The registration address of the individual.

  • legal_entry_full_name:

    string
    Optional

    The full name of the legal entry.

  • legal_entry_phone:

    string
    Optional

    The phone of the legal entry.

  • legal_entry_address:

    string
    Optional

    The legal address of the legal entry.

  • legal_entry_actual_address:

    string
    Optional

    The address of the legal entry.

  • ogrn:

    string
    Optional

    The OGRN of the legal entry.

  • inn:

    string
    Optional

    The INN of the legal entry.

Returns

  • result:

    number

    1

  • account_document_id:

    number

    The account document ID

Examples

request:

Use 'multipart/form-data' content type to post the 'account_document' data!

https://api.voximplant.com/platform_api/SetAccountDocument/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&verification_name=RU

response:

Success.

{
    "result": 1,
    "account_document_id": 45
}

SetAccountInfo

Edits the account's profile.

Parameters

  • Follow link for authentication parameter names and details.

  • new_account_email:

    string
    Optional
  • new_account_password:

    string
    Optional

    The password length must be at least 6 symbols.

  • 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 (Byelorussian), 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, GMT-8, GMT-08:00, GMT+10

  • account_first_name:

    string
    Optional

    The first name.

  • account_last_name:

    string
    Optional

    The last name.

  • mobile_phone:

    string
    Optional

    The mobile phone linked to the account.

  • min_balance_to_notify:

    number
    Optional

    The min balance value to notify by email or SMS.

  • account_notifications:

    boolean
    Optional

    Are the VoxImplant notifications required?

  • tariff_changing_notifications:

    boolean
    Optional

    Set to true to receive the emails about the VoxImplant tariff changing.

  • news_notifications:

    boolean
    Optional

    Set to true to receive the emails about the VoxImplant news.

  • send_js_error:

    boolean
    Optional

    Set to true to receive the emails about a JS scenario error.

  • billing_address_name:

    string
    Optional

    The company or businessman name.

  • 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_address:

    string
    Optional

    The office address.

  • billing_address_zip:

    string
    Optional

    The office ZIP.

  • billing_address_phone:

    string
    Optional

    The office phone number.

  • account_custom_data:

    string
    Optional

    The custom data.

  • callback_url:

    string
    Optional

    If 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
    Optional

    If 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

Returns

  • result:

    number

    1

Examples

request:

Change the account's password.

https://api.voximplant.com/platform_api/SetAccountInfo/?account_id=1&account_password=1234567&new_account_password=7654321

Change the account's email.

https://api.voximplant.com/platform_api/SetAccountInfo/?account_id=1&account_password=1234567&new_account_email=superman%40mail.ru

Set the billing address.

https://api.voximplant.com/platform_api/SetAccountInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&billing_address_name=your_company&billing_address_country_code=US&billing_address_zip=94086&billing_address_address=900%2C%20Kifer%20Road%2C%20Sunnyvale%2C%20CA&billing_address_phone=14445557777

Set the notification settings.

https://api.voximplant.com/platform_api/SetAccountInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&language_code=en&location=GMT-8&min_balance_to_notify=1.50&tariff_changing_notifications=true&news_notifications=true

response:

Success.

{
    "result": 1
}

SetChildAccountInfo

Edits the account's profile.

Please note that this function is restricted and disabled by default. To use it you need to contact our support team.

Parameters

  • Parent's authentication parameter names and details.

  • child_account_id:

    string

    The child account ID list separated by the ';' symbol or the 'all' value.

  • child_account_name:

    string

    The child account name list separated by the ';' symbol. Can be used instead of child_account_id.

  • child_account_email:

    string

    The child account email list separated by the ';' symbol. Can be used instead of child_account_id.

  • new_child_account_email:

    string
    Optional

    The new child account email.

  • new_child_account_password:

    string
    Optional

    The new child account password.

  • account_notifications:

    boolean
    Optional

    Are the VoxImplant notifications required?

  • tariff_changing_notifications:

    boolean
    Optional

    Set to true to receive the emails about the VoxImplant tariff changing.

  • news_notifications:

    boolean
    Optional

    Set to true to receive the emails about the VoxImplant news.

  • active:

    boolean
    Optional

    Set false to disable the child account.

  • 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 (Byelorussian), 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, GMT-8, GMT-08:00, GMT+10

  • min_balance_to_notify:

    number
    Optional

    The min balance value to notify by email or SMS.

  • support_robokassa:

    boolean
    Optional

    Set to true to allow the robokassa payments.

  • support_bank_card:

    boolean
    Optional

    Set to true to allow the bank card payments.

  • support_invoice:

    boolean
    Optional

    Set to true to allow the bank invoices.

  • can_use_restricted:

    boolean
    Optional

    Set to true to allow use restricted directions.

Returns

  • result:

    number

    1

Examples

request:

Disable the child account.

https://api.voximplant.com/platform_api/SetChildAccountInfo/?account_id=1&account_password=1234567&child_account_id=1321&active=false

response:

Success.

{
    "result": 1
}

TransferMoneyToChildAccount

Transfer the parent account's money to the child account or transfer the child's money to the parent account if the money amount is negative.

Please note that this function is restricted and disabled by default. To use it you need to contact our support team.

Parameters

  • Follow link for authentication parameter names and details.

  • child_account_id:

    string

    The child account ID list separated by the ';' symbol.

  • amount:

    number

    The money amount, $. The absolute amount value must be equal or greater than 0.01

  • currency:

    string
    Optional

    The amount currency (the parent account currency by default). Examples: RUR, EUR, USD.

  • strict_mode:

    boolean
    Optional
    Defaults to true

    Returns error if strict_mode is true and an child account or the parent account hasn't enough money.

  • child_transaction_description:

    string
    Optional
    Defaults to From parent account/To parent account

    The child account transaction description.

  • parent_transaction_description:

    string
    Optional
    Defaults to From child account: ${child_account_name}/To child account: ${child_account_name}

    The parent account transaction description. The following macro available: ${child_account_id}, ${child_account_name}

  • payment_reference:

    string
    Optional

    The external payment reference (extra info).

  • check_duplicate_reference_from:

    string
    Optional

    Specify the date in 24-h format: YYYY-MM-DD HH:mm:ss to skip the duplicate transaction.

Returns

  • result:

    number

    1

  • balance:

    number

    The updated parent's account balance.

Examples

request:

Transfer 5.67 $ to the child account 1 and transfer 5.67 $ to the child account 2 too. The parent account spends 2*5.67= 11.34 $ in total.

https://api.voximplant.com/platform_api/TransferMoneyToChildAccount/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&child_account_id=1;2&amount=5.67&currency=USD

Transfer 5.67 $ from the child account 1 to the parent account.

https://api.voximplant.com/platform_api/TransferMoneyToChildAccount/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&child_account_id=1&amount=-5.67&currency=USD

Transfer the all money from the child account 1 to the parent account.

https://api.voximplant.com/platform_api/TransferMoneyToChildAccount/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&child_account_id=1&amount=-10000000&strict_mode=false

response:

Success

{
    "result": 1,
    "balance": 105.8977
}