How authentication works

Most of VoxImplant http api requires authentication and authorization that connects api calls to your account. In order to authenticate, identify your account by passing one of following argument to http api call:
  • account_id
    The account ID
  • account_name
    The account name
  • account_email
    The account email
In order to provide security, authorization info should be also provided by passing one of following argument to http api call:
  • api_key
    The account API key.
  • account_password
    The account password.
  • session_id
    The API session ID.
Additionally, a special kind of user account called "Administrator user" can be created for authentication. This account type extends common VoxImplant user account with security permissions and http api login capabilities. Using administrator users credentials instead of account credentials allows to fine-tune application security. Administrstor user name and id are not always unique across accounts and servers. If administrator user name or id is used, corresponding account must be specified by additionally providing either account_id, account_name or account_email.
  • admin_user_id
    Administrator user can be specified instead of auth info for fine-grained access.
  • admin_user_name
    Verbose name that can be used instead of admin_user_id.
  • admin_user_api_key
    If admin user name or id is specified, this parameter is used for authorization.
  • admin_user_password
    Can be used instead of admin_user_api_key for authorization.

Account's authentication

/Logon

DESCRIPTION
Gets a temporary session ID (and a permanent 'api_key') to work with the API.
URL
https://api.voximplant.com/platform_api/Logon
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.

Request example: Logon by email.

https://api.voximplant.com/platform_api/Logon/?account_email=test%40mail.ru&account_password=1234567
RESPONSE
JSON object with the following fields:
  • result (string)
    The temporary session ID.
  • api_key (string)
    The permanent account (or admin user) access ID.
  • account_id (number)
    The account's ID.
  • account_name (string)
    The account's name.
  • debugger_address (string)
Response example: The brief account profile.
{
  "result" : "f3b93c1f-7f35-4569-a8ee-b75e3f6387ca",
  "account_email" : "test@mail.ru",
  "account_id" : 1,
  "balance" : 4,
  "api_key" : "eec36d6c-a0eb-46b5-a006-1c2b65343bac",
  "account_name" : "test",
  "credit_limit" : 0,
  "frozen" : false
}

/Logout

DESCRIPTION
Forgets the session ID.
URL
https://api.voximplant.com/platform_api/Logout
METHOD
GET
PARAMETERS
  • account_id required
  • session_id required

Request example: Logout.

https://api.voximplant.com/platform_api/Logout/?account_id=1&session_id=f3b93c1f-7f35-4569-a8ee-b75e3f6387ca
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

Managing Accounts

/AddAccount*

DESCRIPTION

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

Adds a new account.
URL
https://api.voximplant.com/platform_api/AddAccount
METHOD
GET
PARAMETERS
  • parent_account_id required
    The parent account ID.
  • parent_account_name required
    The parent account name that can be used instead of parent_account_id.
  • parent_account_email required
    The parent account email that can be used instead of parent_account_id.
  • parent_account_api_key required
    The parent account API key.
  • parent_account_password required
    The parent account password that can be used instead of parent_account_api_key.
  • session_id required
    The API session ID that can be used instead of parent_account_api_key.
  • account_name required
    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 required
  • account_password required
    The password length must be at least 6 symbols.
  • active
    The child account activation flag (The admin permission required to activate the normal account only). Defaults to false
  • language_code
    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) Defaults to en
  • location
    The account location (timezone). Examples: America/Los_Angeles, GMT-8, GMT-08:00, GMT+10 Defaults to Etc/GMT
  • min_balance_to_notify
    The min balance value to notify by email or SMS.
  • account_custom_data
    The custom data.
  • account_first_name
    The first name.
  • account_last_name
    The last name.
  • account_notifications
    Are the VoxImplant notifications required? The default is false for a new child account. Defaults to true
  • tariff_changing_notifications
    Are the VoxImplant tariff changing notifications required? The default is false for a new child account. Defaults to true
  • news_notifications
    Are the VoxImplant news notifications required? The default is false for a new child account. Defaults to true

Request example: Add a new normal account.

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

Request example: 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
JSON object with the following fields:
  • result (number)
    1
  • account_id (number)
    The account ID
  • api_key (string)
    The account API key.
  • active (boolean)
    The account activation flag.
Response example: success but activation is required to use the new account.
{
  "result" : 1,
  "account_id" : 61,
  "api_key" : "3175a161-b59a-4715-8d8d-4944585e2025",
  "active" : false
}
Response example: success.
{
  "result" : 1,
  "account_id" : 62,
  "api_key" : "7975a166-a591-8711-9d8d-9946685e2028",
  "active" : true
}

/CloneAccount*

DESCRIPTION

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

Clones a child account.
URL
https://api.voximplant.com/platform_api/CloneAccount
METHOD
GET
PARAMETERS
  • account_id required
    The cloning account ID.
  • account_name required
    The cloning account name that can be used instead of account_id.
  • account_email required
    The cloning account email that can be used instead of account_id.
  • parent_account_api_key required
    The parent account API key.
  • parent_account_password required
    The parent account password that can be used instead of parent_account_api_key.
  • session_id required
    The API session ID that can be used instead of parent_account_api_key.
  • new_account_name required
    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 required
    The new account email.
  • new_account_password required
    The password length must be at least 6 symbols.
  • language_code
    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) Defaults to en
  • location
    The account location (timezone). Examples: America/Los_Angeles, GMT-8, GMT-08:00, GMT+10 Defaults to Etc/GMT
  • account_custom_data
    The custom data.
  • account_first_name
    The first name.
  • account_last_name
    The last name.

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

/GetAccountInfo

DESCRIPTION
Gets the account's profile.
URL
https://api.voximplant.com/platform_api/GetAccountInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • return_live_balance
    Set true to get the account's live balance. Defaults to true
RESPONSE
JSON object with the following fields:

/SetAccountInfo

DESCRIPTION
Edits the account's profile.
URL
https://api.voximplant.com/platform_api/SetAccountInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • new_account_email
  • new_account_password
    The password length must be at least 6 symbols.
  • language_code
    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
    The account location (timezone). Examples: America/Los_Angeles, GMT-8, GMT-08:00, GMT+10
  • account_first_name
    The first name.
  • account_last_name
    The last name.
  • min_balance_to_notify
    The min balance value to notify by email or SMS.
  • account_notifications
    Are the VoxImplant notifications required?
  • tariff_changing_notifications
    Set to true to receive the emails about the VoxImplant tariff changing.
  • news_notifications
    Set to true to receive the emails about the VoxImplant news.
  • send_js_error
    Set to true to receive the emails about a JS scenario error.
  • billing_address_name
    The company or businessman name.
  • billing_address_country_code
    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), CS (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
    The office address.
  • billing_address_zip
    The office ZIP.
  • billing_address_phone
    The office phone number.
  • account_custom_data
    The custom data.

Request example: Change the account's password.

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

Request example: Change the account's email.

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

Request example: 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

Request example: 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
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SetChildAccountInfo*

DESCRIPTION

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

Edits the account's profile.
URL
https://api.voximplant.com/platform_api/SetChildAccountInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • child_account_id required
    The child account ID list separated by the ';' symbol or the 'all' value.
  • child_account_name required
    The child account name list separated by the ';' symbol. Can be used instead of child_account_id.
  • child_account_email required
    The child account email list separated by the ';' symbol. Can be used instead of child_account_id.
  • new_child_account_email
    The new child account email.
  • account_notifications
    Are the VoxImplant notifications required?
  • tariff_changing_notifications
    Set to true to receive the emails about the VoxImplant tariff changing.
  • news_notifications
    Set to true to receive the emails about the VoxImplant news.
  • active
    Set false to disable the child account.
  • language_code
    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
    The child account location (timezone). Examples: America/Los_Angeles, GMT-8, GMT-08:00, GMT+10
  • min_balance_to_notify
    The min balance value to notify by email or SMS.
  • support_robokassa
    Set to true to allow the robokassa payments.
  • support_bank_card
    Set to true to allow the bank card payments.
  • support_invoice
    Set to true to allow the bank invoices.
  • can_use_restricted
    Set to true to allow use restricted directions.

Request example: Disable the child account.

https://api.voximplant.com/platform_api/SetChildAccountInfo/?account_id=1&account_password=1234567&child_account_id=1321&active=false
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/ConfirmAccountPasswordChange

DESCRIPTION
Confirm the account password change
URL
https://api.voximplant.com/platform_api/ConfirmAccountPasswordChange
METHOD
GET
PARAMETERS
  • account_id required
    The account ID.
  • account_name required
    The account name, can be used instead of account_id.
  • account_email required
    The account email, can be used instead of account_id.
  • new_account_password
    The password length must be at least 6 symbols.
  • code required
    The verification code (auth token).

Request example: Set the new password.

https://api.voximplant.com/platform_api/ConfirmAccountPasswordChange/?account_email=mymail%40mail.ru&code=secr2t&new_account_password=newpswd
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SendAccountPasswordChangeRequest

DESCRIPTION
Send the account password change request by email. The email will contain a random code.
URL
https://api.voximplant.com/platform_api/SendAccountPasswordChangeRequest
METHOD
GET
PARAMETERS
  • account_email required
    The account email.

Request example: Send the account password change request with the default handler.

https://api.voximplant.com/platform_api/SendAccountPasswordChangeRequest/?account_email=mymail%40mail.ru
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/GetCurrencyRate

DESCRIPTION
Gets the exchange rate on selected date (per USD).
URL
https://api.voximplant.com/platform_api/GetCurrencyRate
METHOD
GET
PARAMETERS
  • currency required
    The currency code list separated by the ';' symbol. Examples: RUR, EUR, USD
  • date
    The date, format: YYYY-MM-DD

Request example: Get the current currency rate: RUR/USD.

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

Request example: Get the old currency rate: RUR/USD.

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

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

https://api.voximplant.com/platform_api/GetCurrencyRate/?currency=RUR;EUR
RESPONSE
JSON object with the following fields:
Response example: The RUR/USD.
{
  "result" : {
    "RUR" : 34.12
  }
}
Response example: The RUR/USD and EUR/USD.
{
  "result" : {
    "EUR" : 0.984,
    "RUR" : 34.12
  }
}

/GetResourcePrice

DESCRIPTION
Gets the resource price.
URL
https://api.voximplant.com/platform_api/GetResourcePrice
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • resource_type
    The resource type list separated by the ';' symbol. The following values are possible: 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
    The price group ID list separated by the ';' symbol. Defaults to all
  • price_group_name
    The price group name template to filter. Defaults to all
  • resource_param
    The resource parameter list separated by the ';' symbol. Example: a phone number list.

Request example:

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

Request example:

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

Request example: 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
JSON object with the following fields:
Response example: The result filtered by the 79263332211 phone number.
{
  "result" : [
    {
      "price_groups" : [
        {
          "price" : 0.02,
          "num_resources_per_price" : 60,
          "quantum" : 60,
          "params" : {
            "allowed" : [
              ""
            ]
          },
          "price_group_name" : "Any VoIP in",
          "price_group_id" : 1
        }
      ],
      "resource_type" : "VOIPIN"
    },
    {
      "price_groups" : [
        {
          "price" : 0.02,
          "num_resources_per_price" : 60,
          "quantum" : 60,
          "params" : {
            "allowed" : [
              ""
            ]
          },
          "price_group_name" : "VoIP Out",
          "price_group_id" : 121
        }
      ],
      "resource_type" : "VOIPOUT"
    }
  ]
}
Response example: The result filtered by the 79263332211 phone number.
{
  "result" : [
    {
      "price_groups" : [
        {
          "price" : 0.06,
          "num_resources_per_price" : 60,
          "quant" : 60,
          "params" : {
            "requested" : [
              "79263332211"
            ],
            "allowed" : [
              "79"
            ],
            "forbidden" : [
              "7954",
              "7997",
              "7940"
            ]
          },
          "price_group_name" : "Russia Mobile",
          "price_group_id" : 20
        }
      ],
      "resource_type" : "PSTNOUT"
    }
  ]
}

/GetSubscriptionPrice

DESCRIPTION
Gets the subscription template price.
URL
https://api.voximplant.com/platform_api/GetSubscriptionPrice
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • subscription_template_id
    The subscription template ID list separated by the ';' symbol. Defaults to all
  • subscription_template_type
    The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION.
  • subscription_template_name
    The subscription template name (example: SIP registration, Phone GB, Phone RU 495, ...).
  • count
    The max returning record count.
  • offset
    The record count to omit. Defaults to 0

Request example: Get the all subscription template prices.

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

Request example: 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
JSON object with the following fields:
Response example: Success.
{
  "result" : [
    {
      "installation_price" : 0,
      "period" : "0-1-0 0:0:0",
      "price" : 293.855,
      "subscription_template_id" : 20,
      "subscription_template_type" : "PHONE_NUM",
      "subscription_template_name" : "Phone BG"
    },
    {
      "installation_price" : 3000,
      "period" : "0-1-0 0:0:0",
      "price" : 1500,
      "subscription_template_id" : 6,
      "subscription_template_type" : "PHONE_NUM",
      "subscription_template_name" : "Phone RU TollFree"
    },
    {
      "installation_price" : 0,
      "period" : "0-1-0 0:0:0",
      "price" : 587.71,
      "subscription_template_id" : 53,
      "subscription_template_type" : "SIP_REGISTRATION",
      "subscription_template_name" : "SIP registration"
    }
  ],
  "total_count" : 51,
  "count" : 3
}

/GetChildrenAccounts*

DESCRIPTION

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

Gets the children accounts.
URL
https://api.voximplant.com/platform_api/GetChildrenAccounts
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • child_account_id
    The account ID list separated by the ';' symbol or the 'all' value.
  • child_account_name
    The child account name part to filter.
  • child_account_email
    The child ccount email to filter.
  • active
    The active flag to filter.
  • frozen
    The frozen flag to filter.
  • ignore_invalid_accounts
    Set true to ignore the invalid 'child_account_id' items. Defaults to false
  • brief_output
    Set true to output the account_id only. Defaults to false
  • medium_output
    Set true to output the account_id, account_name, account_email only. Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0
  • order_by
    The following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'. Defaults to child_account_name
  • return_live_balance
    Set true to get the user live balance. Defaults to true

Request example: Get the all children.

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

Request example: 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
RESPONSE
JSON object with the following fields:
  • result ([AccountInfoType])
  • total_count (number)
    The total found user count.
  • count (number)
    The returned user count.

/TransferMoneyToChildAccount*

DESCRIPTION

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

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.
URL
https://api.voximplant.com/platform_api/TransferMoneyToChildAccount
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • child_account_id required
    The child account ID list separated by the ';' symbol.
  • amount required
    The money amount, $. The absolute amount value must be equal or greater than 0.01
  • currency
    The amount currency (the parent account currency by default). Examples: RUR, EUR, USD.
  • strict_mode
    Returns error if strict_mode is true and an child account or the parent account hasn't enough money. Defaults to true
  • child_transaction_description
    The child account transaction description. Defaults to From parent account/To parent account
  • parent_transaction_description
    The parent account transaction description. The following macro available: ${child_account_id}, ${child_account_name} Defaults to From child account: ${child_account_name}/To child account: ${child_account_name}
  • payment_reference
    The external payment reference (extra info).
  • check_duplicate_reference_from
    Specify the date in format YYYY-MM-DD hh:mm:ss to skip the duplicate transaction.

Request example: 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¤cy=USD

Request example: 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¤cy=USD

Request example: 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
JSON object with the following fields:
  • result (number)
    1
  • balance (number)
    The new account balance.
Response example: Success
{
  "result" : 1,
  "balance" : 105.8977
}

/GetMoneyAmountToCharge

DESCRIPTION
Get the recommended money amount to charge.
URL
https://api.voximplant.com/platform_api/GetMoneyAmountToCharge
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • currency
    The currency name. Examples: USD, RUR, EUR. Defaults to The account currency.
  • charge_date
    The next charge date, format: YYYY-MM-DD Defaults to The current date.

Request example: 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¤cy=USD
RESPONSE
JSON object with the following fields:
Response example: The account balance is 1$ + min_amount(7$) = amount(8$).
{
  "result" : {
    "bank_card_amount_usd" : 10,
    "amount" : 8,
    "subscriptions" : [
      {
        "subscription_amount" : 5,
        "subscription_description" : "74997004411",
        "subscription_type" : "PHONE_NUM"
      },
      {
        "subscription_amount" : 3,
        "subscription_description" : "15002229950",
        "subscription_type" : "PHONE_NUM"
      }
    ],
    "min_amount" : 7,
    "robokassa_amount_rub" : 500,
    "min_robokassa_amount_rub" : 500,
    "min_bank_card_amount_usd" : 7
  }
}

/ChargeAccount

DESCRIPTION
Charges the account in the manual mode. You should call the ChargeAccount function to charge the subscriptions having the auto_charge=false.
URL
https://api.voximplant.com/platform_api/ChargeAccount
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_id required
    The phone ID list separated by the ';' symbol or the 'all' value. You should specify the phones having the auto_charge=false.
  • phone_number required
    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.

Request example: 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

Request example: 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
JSON object with the following fields:
Response example: The 74997058301 phone has been charged.
{
  "result" : {
    "charged_amount" : 500,
    "phones" : [
      {
        "is_charged" : true,
        "phone_number" : "74997058301",
        "deactivated" : false,
        "phone_id" : 70
      },
      {
        "is_charged" : false,
        "phone_number" : "12055645250",
        "deactivated" : false,
        "phone_id" : 131
      },
      {
        "is_charged" : false,
        "phone_number" : "18443325157",
        "deactivated" : true,
        "phone_id" : 132
      }
    ]
  },
  "account_info" : {
    "next_charge" : "2015-03-13",
    "tariff_id" : 1,
    "account_id" : 52,
    "periodic_charge" : 0,
    "balance" : 1360,
    "tariff_name" : "default",
    "frozen" : false,
    "currency" : "RUR"
  }
}

/GetAccountDocuments

DESCRIPTION
Gets the account documents and the verification states.
URL
https://api.voximplant.com/platform_api/GetAccountDocuments
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • with_details
    Set true to view the uploaded document statuses. (The flag is ignored with the child_account_id=all) Defaults to false
  • verification_name
    The required account verification name to filter.
  • verification_status
    The account verification status list separated by the ';' symbol. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  • from_unverified_hold_until
    Unverified subscriptions hold until the date (from ...) in format: YYYY-MM-DD
  • to_unverified_hold_until
    Unverified subscriptions hold until the date (... to) in format: YYYY-MM-DD
  • child_account_id
    The child account ID list separated by the ';' symbol or the 'all' value.
  • children_verifications_only
    Set true to get the children account verifications only. Defaults to false

Request example:

https://api.voximplant.com/platform_api/GetAccountDocuments/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_details=true
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "account_id" : 1,
      "verifications" : [
        {
          "unverified_hold_until" : "2015-02-15",
          "documents" : [
            {
              "account_document_id" : 66,
              "account_document_status" : "REJECTED",
              "is_individual" : true,
              "uploaded" : "2015-02-01 06:50:07",
              "comment" : "very low quality"
            },
            {
              "account_document_id" : 74,
              "account_document_status" : "IN_PROGRESS",
              "is_individual" : true,
              "uploaded" : "2015-02-01 07:34:01"
            }
          ],
          "verification_status" : "IN_PROGRESS",
          "verification_name" : "RU"
        }
      ]
    }
  ]
}

/SetAccountDocument

DESCRIPTION
Upload an account verification document. You should post the data with the 'multipart/form-data' content type!
URL
https://api.voximplant.com/platform_api/SetAccountDocument
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • is_individual
    Is individual, isn't legal entity? Defaults to true
  • account_document required
    The document data. You should post the data with the 'application/octet-stream' or 'multipart/form-data' content type!
  • verification_name required
    The account verification name.
  • individual_full_name
    The full name of the individual.
  • individual_birth_date
    The birth date in format: YYYY-MM-DD
  • individual_passport_series
    The passport series of the individual.
  • individual_passport_number
    The passport number of the individual.
  • individual_passport_issue_date
    The passport issue date in format: YYYY-MM-DD
  • individual_passport_issued_by
    The passport issued by.
  • individual_registration_address
    The registration address of the individual.
  • legal_entry_full_name
    The full name of the legal entry.
  • legal_entry_phone
    The phone of the legal entry.
  • legal_entry_address
    The legal address of the legal entry.
  • legal_entry_actual_address
    The address of the legal entry.
  • ogrn
    The OGRN of the legal entry.
  • inn
    The INN of the legal entry.

Request example: 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
JSON object with the following fields:
  • result (number)
    1
  • account_document_id (number)
    The account document ID
Response example: Success.
{
  "result" : 1,
  "account_document_id" : 45
}

Managing Admin Roles

/AddAdminRole

DESCRIPTION
Adds a new admin role.
URL
https://api.voximplant.com/platform_api/AddAdminRole
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • admin_role_name required
    The admin role name. The length must be less than 50.
  • admin_role_active
    The admin role enable flag. If false the allowed and denied entries have no affect. Defaults to true
  • like_admin_role_id
    The admin role ID list separated by the ';' symbol or the 'all' value. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries).
  • like_admin_role_name
    The admin role name that can be used instead of like_admin_role_id. The name specifies a role from which the new role automatically copies all permissions (allowed_entries and denied_entries).
  • allowed_entries
    The list of allowed access entries separated by the ';' symbol (the API function names).
  • denied_entries
    The list of denied access entries separated by the ';' symbol (the API function names).

Request example: Add a new admin role with the GetAccountInfo and GetCallHistory permissions.

https://api.voximplant.com/platform_api/AddAdminRole/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&admin_role_name=read_only&allowed_entries=GetAccountInfo;GetCallHistory
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • admin_role_id (number)
    The new admin role ID.
Response example:
{
  "result" : 1,
  "admin_role_id" : 10
}

/DelAdminRole

DESCRIPTION
Deletes the admin role.
URL
https://api.voximplant.com/platform_api/DelAdminRole
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • admin_role_id required
    The admin role ID list separated by the ';' symbol or the 'all' value.
  • admin_role_name required
    The admin role name to delete, can be used instead of admin_role_id.

Request example: Delete the admin role.

https://api.voximplant.com/platform_api/DelAdminRole/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&admin_role_id=10
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/SetAdminRoleInfo

DESCRIPTION
Edits the admin role. You may edit
URL
https://api.voximplant.com/platform_api/SetAdminRoleInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • admin_role_id required
    The admin user to edit.
  • admin_role_name required
    The admin role to edit, can be used instead of admin_role_id.
  • new_admin_role_name
    The new admin role name. The length must be less than 50.
  • admin_role_active
    The admin role enable flag. If false the allowed and denied entries have no affect.
  • entry_modification_mode
    The modification mode of the permission lists (allowed_entries and denied_entries). The following values are possible: add, del, set. Defaults to set
  • allowed_entries
    The list of allowed access entry changes separated by the ';' symbol (the API function names).
  • denied_entries
    The list of denied access entry changes separated by the ';' symbol (the API function names).
  • like_admin_role_id
    The admin role ID list separated by the ';' symbol or the 'all' value. The list specifies the roles from which the allowed_entries and denied_entries will be merged.
  • like_admin_role_name
    The admin role name, can be used instead of like_admin_role_id. The name specifies a role from which the allowed_entries and denied_entries will be merged.

Request example: Allow the all permissions except the DelUser and DelApplication.

https://api.voximplant.com/platform_api/SetAdminRoleInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&admin_role_id=1&entry_modification_mode=set&allowed_entries=all&denied_entries=DelUser;DelApplication
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetAdminRoles

DESCRIPTION
Gets the admin roles.
URL
https://api.voximplant.com/platform_api/GetAdminRoles
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • admin_role_id
    The admin role ID to filter.
  • admin_role_name
    The admin role name part to filter.
  • admin_role_active
    The admin role active flag to filter.
  • with_entries
    Set true to get the permissions. Defaults to false
  • with_account_roles
    Set false to omit the account roles. Defaults to true
  • with_parent_roles
    Set false to omit the parent roles. Defaults to true
  • with_system_roles
    Set false to omit the system roles. Defaults to true
  • included_admin_user_id
    The attached admin user ID list separated by the ';' symbol or the 'all' value.
  • excluded_admin_user_id
    The not attached admin user ID list separated by the ';' symbol or the 'all' value.
  • full_admin_users_matching
    Set false to get roles with partial admin user list matching. Defaults to false
  • showing_admin_user_id
    The admin user to show in the 'admin_users' field output.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two admin roles attached to the admin_user_id=22.

https://api.voximplant.com/platform_api/GetAdminRoles/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_entries=true&showing_admin_user_id=11&included_admin_user_id=22&count=2
RESPONSE
JSON object with the following fields:
  • result ([AdminRoleType])
  • total_count (number)
    The total found admin role count.
  • count (number)
    The returned admin role count.
Response example:
{
  "result" : [
    {
      "allowed_entries" : [
        "GetAccountInfo",
        "GetCallHistory"
      ],
      "denied_entries" : [
      ],
      "admin_role_name" : "read_only",
      "admin_role_id" : 10,
      "admin_role_active" : true,
      "system_role" : false,
      "modified" : "2014-12-05 10:27:30",
      "admin_users" : [
      ]
    },
    {
      "allowed_entries" : [
      ],
      "denied_entries" : [
        "GetScenarios",
        "DelScenario",
        "AddScenario",
        "SetScenarioInfo"
      ],
      "admin_role_name" : "hide_scripts",
      "admin_role_id" : 3,
      "admin_role_active" : true,
      "system_role" : true,
      "modified" : "2014-12-01 01:06:35",
      "admin_users" : [
        {
          "admin_user_id" : 11
        }
      ]
    }
  ],
  "total_count" : 2,
  "count" : 2
}

Managing Admin Users

/AddAdminUser

DESCRIPTION
Adds a new admin user.
URL
https://api.voximplant.com/platform_api/AddAdminUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • new_admin_user_name required
    The admin user name. The length must be less than 50.
  • admin_user_display_name required
    The admin user display name. The length must be less than 256.
  • new_admin_user_password required
    The admin user password. The length must be at least 6 symbols.
  • admin_user_active
    The admin user enable flag. Defaults to true
  • admin_role_id
    The attaching admin role ID list separated by the ';' symbol or the 'all' value.
  • admin_role_name
    The attaching admin role name that can be used instead of admin_role_id.

Request example: Add a new admin user.

https://api.voximplant.com/platform_api/AddAdminUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&new_admin_user_name=adm1&admin_user_display_name=adm1&new_admin_user_password=1234567&admin_role_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • admin_user_id (number)
    The new admin user ID.
  • admin_user_api_key (string)
    The admin user API key.
Response example:
{
  "result" : 1,
  "admin_user_api_key" : "02486488-add3-4567-b72f-6259f9a9c92f",
  "admin_user_id" : 1
}

/DelAdminUser

DESCRIPTION
Deletes the admin user.
URL
https://api.voximplant.com/platform_api/DelAdminUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • required_admin_user_id required
    The admin user ID list separated by the ';' symbol or the 'all' value.
  • required_admin_user_name required
    The admin user name to delete, can be used instead of required_admin_user_id.

Request example: Delete the admin user.

https://api.voximplant.com/platform_api/DelAdminUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/SetAdminUserInfo

DESCRIPTION
Edits the admin user.
URL
https://api.voximplant.com/platform_api/SetAdminUserInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • required_admin_user_id required
    The admin user to edit.
  • required_admin_user_name required
    The admin user to edit, can be used instead of required_admin_user_id.
  • new_admin_user_name
    The new admin user name. The length must be less than 50.
  • admin_user_display_name
    The new admin user display name. The length must be less than 256.
  • new_admin_user_password
    The new admin user password. The length must be at least 6 symbols.
  • admin_user_active
    The admin user enable flag.

Request example: Edit the admin user password.

https://api.voximplant.com/platform_api/SetAdminUserInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=1&new_admin_user_password=7654321
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetAdminUsers

DESCRIPTION
Gets the admin users.
URL
https://api.voximplant.com/platform_api/GetAdminUsers
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • required_admin_user_id
    The admin user ID to filter.
  • required_admin_user_name
    The admin user name part to filter.
  • admin_user_display_name
    The admin user display name part to filter.
  • admin_user_active
    The admin user active flag to filter.
  • with_roles
    Set true to get the attached admin roles. Defaults to false
  • with_access_entries
    Set true to get the admin user permissions. Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two first admin users.

https://api.voximplant.com/platform_api/GetAdminUsers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_access_entries=true&count=2
RESPONSE
JSON object with the following fields:
  • result ([AdminUserType])
  • total_count (number)
    The total found admin user count.
  • count (number)
    The returned admin user count.
Response example:
{
  "result" : [
    {
      "admin_user_name" : "adm1",
      "admin_user_id" : 1,
      "access_entries" : [
        "GetAccountInfo",
        "GetCallHistory"
      ],
      "admin_user_active" : true,
      "modified" : "2014-12-05 10:27:30",
      "admin_user_display_name" : "adm1"
    },
    {
      "admin_user_name" : "adm2",
      "admin_user_id" : 2,
      "access_entries" : [
        "GetAccountInfo",
        "SetAccountInfo"
      ],
      "admin_user_active" : true,
      "modified" : "2014-12-05 10:27:30",
      "admin_user_display_name" : "adm2"
    }
  ],
  "total_count" : 2,
  "count" : 2
}

/AttachAdminRole

DESCRIPTION
Attach the admin role list to the admin user list.
URL
https://api.voximplant.com/platform_api/AttachAdminRole
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • required_admin_user_id required
    The admin user ID list separated by the ';' symbol or the 'all' value.
  • required_admin_user_name required
    The admin user name to bind, can be used instead of required_admin_user_id.
  • admin_role_id required
    The attached admin role ID list separated by the ';' symbol or the 'all' value.
  • admin_role_name required
    The admin role name to attach, can be used instead of admin_role_id.
  • mode
    The merge mode. The following values are possible: add, del, set. Defaults to set

Request example: Bind the all admin users with the admin roles 1, 2 and 3.

https://api.voximplant.com/platform_api/AttachAdminRole/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&required_admin_user_id=all;&admin_role_id=1;2;3
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

Managing Applications

/AddApplication

DESCRIPTION
Adds a new account's application.
URL
https://api.voximplant.com/platform_api/AddApplication
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_name required
    The short application name in format [a-z][a-z0-9-]{1,79}
  • im_enabled
    Is the instant messaging (IM) enabled? Defaults to false
  • im_roster_type
    The roster type (IM users list type). The following values are possible: personal, group. Defaults to personal
  • busy_on_call
    The busy_on_call flag. Defaults to false

Request example: Add a new application.

https://api.voximplant.com/platform_api/AddApplication/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_name=myapp1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • application_id (number)
    The application ID
  • application_name (string)
    The full application name
Response example: Returned 'application_name' is the full application name.
{
  "result" : 1,
  "application_name" : "myapp1.test.voximplant.com",
  "application_id" : 1
}

/DelApplication

DESCRIPTION
Deletes the account's application.
URL
https://api.voximplant.com/platform_api/DelApplication
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id required
    The application ID list separated by the ';' symbol or the 'all' value.
  • application_name required
    The application name list separated by the ';' symbol. Can be used instead of appliction_id.

Request example: Delete the application 1 and 3.

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

Request example: Delete the all applications.

https://api.voximplant.com/platform_api/DelApplication/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=all
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SetApplicationInfo

DESCRIPTION
Edits the account's application.
URL
https://api.voximplant.com/platform_api/SetApplicationInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id required
    The application ID.
  • required_application_name required
    Can be used instead of application_id.
  • application_name
    The new short application name in format [a-z][a-z0-9-]{1,79}
  • im_enabled
    Is the instant messaging (IM) enabled?
  • im_roster_type
    The roster type (IM users list type). The following values are possible: personal, group.
  • busy_on_call
    The busy_on_call flag.

Request example: Change the application name.

https://api.voximplant.com/platform_api/SetApplicationInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=1&application_name=myapp11
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • application_name (string)
    The new full application name
Response example: Returned 'application_name' is the new full application name.
{
  "result" : 1,
  "application_name" : "myapp11.test.voximplant.com"
}

/GetApplications

DESCRIPTION
Gets the account's applications.
URL
https://api.voximplant.com/platform_api/GetApplications
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id
    The application ID to filter.
  • application_name
    The application name part to filter.
  • im_enabled
    Is the instant messaging (IM) enabled?
  • im_roster_type
    The roster type (IM users list type) to filter. The following values are possible: personal, group.
  • user_id
    The binding user ID to filter.
  • excluded_user_id
    The excluded binding user ID to filter.
  • showing_user_id
    Specify the binding user ID value to show it in the 'users' array output.
  • with_rules
    Set true to get binding rules info. Defaults to false
  • with_scenarios
    Set true to get binding rules and scenarios info. Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two applications, but skip the first one.

https://api.voximplant.com/platform_api/GetApplications/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2
RESPONSE
JSON object with the following fields:
  • result ([ApplicationInfoType])
  • total_count (number)
    The total found application count.
  • count (number)
    The returned application count.
Response example:
{
  "result" : [
    {
      "application_name" : "myapp2.test.voximplant.com",
      "im_enabled" : false,
      "modified" : "2013-09-09 14:12:12",
      "application_id" : 2
    },
    {
      "application_name" : "myapp3.test.voximplant.com",
      "im_enabled" : false,
      "modified" : "2013-09-09 14:12:46",
      "application_id" : 3
    }
  ],
  "total_count" : 17,
  "count" : 2
}

Managing Authorized IPs

/AddAuthorizedAccountIP

DESCRIPTION
Adds a new authorized IP4 or network to the white/black list.
URL
https://api.voximplant.com/platform_api/AddAuthorizedAccountIP
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • authorized_ip required
    The authorized IP4 or network.
  • allowed
    Set false to add the IP to the blacklist. Defaults to true

Request example: Add the 92.255.220.0/24 network to the white list.

https://api.voximplant.com/platform_api/AddAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/DelAuthorizedAccountIP

DESCRIPTION
Removes the authorized IP4 or network from the white/black list.
URL
https://api.voximplant.com/platform_api/DelAuthorizedAccountIP
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • authorized_ip required
    The authorized IP4 or network to remove. Set the 'all' value to remove the all items.
  • contains_ip required
    Can be used instead of autharized_ip. Specify the parameter to remove the networks that contains the particular IP4.
  • allowed
    Set true to remove the network from the white list. Set false to remove the network from the black list. Omit the parameter to remove the network from the all lists.

Request example: Delete the 92.255.220.0/24 network from the all lists.

https://api.voximplant.com/platform_api/DelAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24
RESPONSE
JSON object with the following fields:
  • result (number)
    The removed network count.
Response example: The network was removed.
{
  "result" : 1
}

/GetAuthorizedAccountIPs

DESCRIPTION
Gets the authorized IP4 or network.
URL
https://api.voximplant.com/platform_api/GetAuthorizedAccountIPs
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • authorized_ip
    The authorized IP4 or network to filter.
  • allowed
    The allowed flag to filter.
  • contains_ip required
    Specify the parameter to filter the networks that contains the particular IP4.
  • count
    The max returning record count. Defaults to 50
  • offset
    The record count to omit. Defaults to 0

Request example: Show the all items.

https://api.voximplant.com/platform_api/GetAuthorizedAccountIPs/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac
RESPONSE
JSON object with the following fields:
  • total_count (number)
    The total found network count.
  • count (number)
    The returned network count.
Response example:
{
  "result" : [
    {
      "authorized_ip" : "92.255.220.0\/24",
      "allowed" : "true",
      "created" : "2015-02-01 20:10:15"
    },
    {
      "authorized_ip" : "92.255.220.10",
      "allowed" : "false",
      "created" : "2015-02-01 20:10:17"
    }
  ],
  "total_count" : 2,
  "count" : 2
}

/CheckAuthorizedAccountIP

DESCRIPTION
Tests whether the IP4 is banned or allowed.
URL
https://api.voximplant.com/platform_api/CheckAuthorizedAccountIP
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • authorized_ip required
    The IP4 to test.

Request example:

https://api.voximplant.com/platform_api/CheckAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24
RESPONSE
JSON object with the following fields:
  • result (boolean)
    True if IP is allowed.
  • authorized_ip (string)
    The matched authorized IP or network (if found).
Response example: The IP is allowed.
{
  "result" : true,
  "authorized_ip" : "92.255.0.0\/16"
}
Response example: The IP is forbidden.
{
  "result" : false,
  "authorized_ip" : "92.255.0.0\/16"
}
Response example: The IP isn't allowed.
{
  "result" : false
}

Managing Call Lists

/CreateCallList

DESCRIPTION
Adds a new CSV file for processing. To send a file, use the request body. To set the call time constraints, use the options __start_execution_time and __end_execution_time in CSV file. Time format HH24:MM
URL
https://api.voximplant.com/platform_api/CreateCallList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID.
  • priority required
    Priority tasks
  • max_simultaneous required
    Number simultaneously processed tasks.
  • num_attempts required
    Number of attempts.
  • name required
    File name.
  • file_content required
    Send as Body Request or multiform.
  • interval_seconds
    Interval between call attempts in seconds. The default is 0.
  • queue_id
    Queue Id. For processing list with PDS must specify the ID of the queue.
  • avg_waiting_sec
    Average waiting time in the queue(seconds). Default is 1
  • encoding
    Encoding file. The default is UTF-8.
  • delimiter
    Separator values. The default is ';'

Request example: Add a new CSV file.

https://api.voximplant.com/platform_api/CreateCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=22071&max_simultaneous=100&num_attempts=1&interval_seconds=1&priority=1&name=test_name
RESPONSE
JSON object with the following fields:
  • result (boolean)
    true
  • count (number)
    The number of stored records
  • list_id (number)
    The list ID.
Response example:
{
  "result" : true,
  "list_id" : 1,
  "count" : 1
}

/CreateManualCallList

DESCRIPTION
Adds a new CSV file for manual processing. To send a file, use the request body. To start processing calls, use the function StartNextCallTask.
URL
https://api.voximplant.com/platform_api/CreateManualCallList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID.
  • priority required
    Priority tasks
  • max_simultaneous required
    Number simultaneously processed tasks.
  • num_attempts required
    Number of attempts.
  • name required
    File name.
  • file_content required
    Send as Body Request or multiform.
  • interval_seconds
    Interval between call attempts in seconds. The default is 0.
  • encoding
    Encoding file. The default is UTF-8.
  • delimiter
    Separator values. The default is ';'

Request example: Add a new CSV file.

https://api.voximplant.com/platform_api/CreateManualCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=22071&max_simultaneous=100&num_attempts=1&interval_seconds=1&priority=1&name=test_name
RESPONSE
JSON object with the following fields:
  • result (boolean)
    true
  • count (number)
    The number of stored records
  • list_id (number)
    The list ID.
Response example:
{
  "result" : true,
  "list_id" : 1,
  "count" : 1
}

/StartNextCallTask

DESCRIPTION
Start processing the next task
URL
https://api.voximplant.com/platform_api/StartNextCallTask
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • list_id required
    The list Id. Сan use a set of identifiers with the separator ";"
  • custom_params
    The custom param. Use to transfer the call initiator parameters to the scenario.

Request example: Start next call task

https://api.voximplant.com/platform_api/StartNextCallTask/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    true
  • list_id (number)
    The list id.
Response example:
{
  "result" : 1,
  "list_id" : 1
}

/AppendToCallList

DESCRIPTION
Appending new task to existing call list.
URL
https://api.voximplant.com/platform_api/AppendToCallList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • list_id required
    The call list ID
  • list_name required
    Can be used instead of list_id. The unique name call list
  • file_content required
    Send as Body Request or multiform.
  • encoding
    Encoding file. The default is UTF-8.
  • delimiter
    Separator values. The default is ';'

Request example: Append new tasks to existing call list.

https://api.voximplant.com/platform_api/AppendToCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=22071&list_id=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
    true
  • count (number)
    The number of stored records
  • list_id (number)
    The list ID.
Response example:
{
  "result" : true,
  "list_id" : 1,
  "count" : 1
}

/GetCallLists

DESCRIPTION
Get all lists of outgoing calls registered user
URL
https://api.voximplant.com/platform_api/GetCallLists
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • name
    Find call lists by name
  • is_active
    Find only active call lists
  • from_date
    The UTC from date filter in format YYYY-MM-DD HH:mm:SS
  • to_date
    The UTC to date filter in format YYYY-MM-DD HH:mm:SS
  • type_list
    The type of call list. Available values: AUTOMATIC and MANUAL
  • count
    The max returning record count.
  • offset
    The record count to omit.

Request example: Get all lists registered by user

https://api.voximplant.com/platform_api/GetCallLists/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac
RESPONSE
JSON object with the following fields:
  • result (array)
    Array of lists.
  • count (number)
    The returned call list count.
  • total_count (number)
    The total found call list count.
Response example:
{
  "result" : [
    {
      "rule_id" : 2,
      "num_attempts" : 1,
      "list_id" : 1,
      "user_id" : 1,
      "max_simultaneous" : 100,
      "interval_seconds" : 1,
      "dt_submit" : "2014-06-03 12:33:34",
      "list_name" : "test_name",
      "priority" : 1,
      "dt_complete" : "2014-06-03 14:32:57"
    }
  ],
  "total_count" : 1,
  "count" : 1
}

/GetCallListDetails

DESCRIPTION
Get details of the tasks of outgoing calls. Default return CSV file.
URL
https://api.voximplant.com/platform_api/GetCallListDetails
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • list_id required
    The list ID.
  • count
    Maximum number of entries in the result
  • offset
    Offset from beginning of the list
  • output
    Output format (CSV/JSON/XLS). Default CSV
  • encoding
    Encoding of the output file. Default UTF-8
  • delimiter
    Separator values. The default is ';'

Request example: Get all lists registered by user

https://api.voximplant.com/platform_api/GetCallListDetails/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1&output=json
RESPONSE
JSON object with the following fields:
  • result ([CallListDetailType])
    Array of tasks for the roll call.
  • count (number)
    The number of tasks.
Response example:
{
  "result" : [
    {
      "start_execution_time" : "",
      "status_id" : 2,
      "list_id" : 270,
      "finish_execution_time" : "",
      "result_data" : "true",
      "attmepts_left" : 0,
      "custom_data" : "{\"first_name\":\"f_name\",\"phone\":\"1234567890\",\"age\":\"28\",\"last_name\":\"l_name\"}",
      "last_attempt" : "2014-06-03 12:33:49",
      "status" : "In progress"
    }
  ],
  "count" : 1
}

/StopCallListProcessing

DESCRIPTION
Stop processing the task list
URL
https://api.voximplant.com/platform_api/StopCallListProcessing
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • list_id required
    The list Id.

Request example: Cancel list with id = 1

https://api.voximplant.com/platform_api/StopCallListProcessing/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
    true
  • msg (string)
    Result message.
Response example:
{
  "result" : true,
  "msg" : "Tasks canceled."
}

/RecoverCallList

DESCRIPTION
Restore processing the task list
URL
https://api.voximplant.com/platform_api/RecoverCallList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • list_id required
    The list Id.

Request example: Restore list with id = 1

https://api.voximplant.com/platform_api/RecoverCallList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&list_id=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
    true
  • count_recovery (number)
    Number restored tasks
Response example:
{
  "result" : true,
  "count_recovery" : 2
}

Managing History

/GetCallHistory

DESCRIPTION
Gets the call history.
URL
https://api.voximplant.com/platform_api/GetCallHistory
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • from_date required
    The from date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • to_date required
    The to date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • timezone
    The selected timezone or the 'auto' value (will be used the account location). Defaults to Etc/GMT
  • call_session_history_id
    The call session history ID list separated by the ';' symbol.
  • application_id
    The application ID.
  • application_name
    The application name, can be used instead of application_id.
  • user_id
    The user ID list separated by the ';' symbol.
  • rule_name
    The rule name to filter.
  • remote_number
    The remote number list separated by the ';' symbol.
  • local_number
    The local number list separated by the ';' symbol.
  • call_session_history_custom_data
    The custom_data to filter sessions.
  • with_calls
    Set true to get binding calls. Defaults to false
  • with_records
    Set true to get binding records. Defaults to false
  • with_other_resources
    Set true to get other resources usage. Defaults to true
  • child_account_id
    The child account ID list separated by the ';' symbol or the 'all' value.
  • children_calls_only
    Set true to get the children account calls only. Defaults to false
  • with_header
    Set false to get a CSV file without the column names if the output=csv Defaults to true
  • desc_order
    Set true to get records in the descent order. Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0
  • output
    The output format. The following values available: json, csv Defaults to json
  • is_async
    Set true to get records in the asynchronous mode (for csv output only). See GetHistoryReports, DownloadHistoryReport. Defaults to false

Request example: Get the first call session history record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC

https://api.voximplant.com/platform_api/GetCallHistory/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&from_date=2012-01-01%2000%3A00%3A00&to_date=2014-01-01%2000%3A00%3A00&count=1&timezone=Etc/GMT
RESPONSE
JSON object with the following fields:
  • result ([CallSessionInfoType])
    The CallSessionInfoType records in sync mode or 1 in async mode.
  • total_count (number)
    The total found call session count (sync mode).
  • count (number)
    The returned call session count (sync mode).
  • timezone (string)
    The used timezone.
  • history_report_id (number)
    The history report ID (async mode).
Response example:
{
  "result" : [
    {
      "duration" : 6,
      "account_id" : 1,
      "user_id" : 1,
      "calls" : [
        {
          "duration" : 4,
          "transaction_id" : 0,
          "incoming" : false,
          "start_time" : "2013-07-21 15:04:19",
          "remote_number_type" : "pstn",
          "local_number" : "test1",
          "remote_number" : "7111",
          "direction" : "Russia",
          "successful" : true,
          "call_id" : 14
        },
        {
          "duration" : 4,
          "transaction_id" : 0,
          "incoming" : true,
          "start_time" : "2013-07-21 15:04:20",
          "record_url" : "http:\/\/1.2.3.4\/records\/\/2013\/07\/21\/224cf30d83f569da.1374419057.0.flv",
          "remote_number_type" : "pstn",
          "local_number" : "7111",
          "remote_number" : "test1",
          "successful" : true,
          "call_id" : 15
        }
      ],
      "initiator_address" : "192.168.15.103",
      "call_session_history_id" : 14,
      "log_file_url" : "http:\/\/1.2.3.4\/logs\/\/2013\/07\/21\/150417_6226d04fa72789c3.1374719057.0.log",
      "application_id" : 2,
      "media_server_address" : "192.168.15.103",
      "start_date" : "2013-07-21 15:04:17"
    },
    {
      "duration" : 6,
      "account_id" : 1,
      "user_id" : 1,
      "calls" : [
        {
          "duration" : 4,
          "transaction_id" : 0,
          "incoming" : false,
          "start_time" : "2013-07-21 15:04:46",
          "remote_number_type" : "pstn",
          "local_number" : "test1",
          "remote_number" : "7111",
          "direction" : "Russia",
          "successful" : true,
          "call_id" : 16
        },
        {
          "duration" : 3,
          "transaction_id" : 0,
          "incoming" : true,
          "start_time" : "2013-07-21 15:04:47",
          "record_url" : "http:\/\/1.2.3.4\/records\/\/2013\/07\/21\/9586a463e96f7847.1374419086.0.flv",
          "remote_number_type" : "pstn",
          "local_number" : "7111",
          "remote_number" : "test1",
          "successful" : true,
          "call_id" : 17
        }
      ],
      "active" : false,
      "initiator_address" : "192.168.15.103",
      "debugger_url" : "some_name",
      "call_session_history_id" : 15,
      "log_file_url" : "http:\/\/0.0.0.0\/logs\/\/2013\/07\/21\/150444_507b8174ef0041de.1374419084.0.log",
      "application_id" : 2,
      "media_server_address" : "192.168.15.103",
      "start_date" : "2013-07-21 15:04:44"
    }
  ],
  "total_count" : 934,
  "timezone" : "Etc\/GMT",
  "count" : 2
}
Response example:
{
  "result" : 1,
  "history_report_id" : 12
}

/GetHistoryReports

DESCRIPTION
Gets the history report statuses.
URL
https://api.voximplant.com/platform_api/GetHistoryReports
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • history_report_id
    The history report ID to filter
  • history_type
    The history report type list separated by the ';' symbol or the 'all' value. The following values are possible: calls, transactions. Defaults to calls
  • created_from
    The UTC creation from date filter in format YYYY-MM-DD HH:mm:SS
  • created_to
    The UTC creation to date filter in format YYYY-MM-DD HH:mm:SS
  • is_completed
    Is report completed?
  • desc_order
    Set true to get records in the descent order. Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the all reports statuses.

https://api.voximplant.com/platform_api/GetHistoryReports/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&history_type=all
RESPONSE
JSON object with the following fields:
  • result ([HistoryReportType])
  • total_count (number)
    The total found reports count.
  • count (number)
    The returned reports count.
Response example:
{
  "result" : [
    {
      "history_report_id" : 34,
      "created" : "2015-10-07 18:40:01",
      "history_type" : "calls",
      "format" : "csv",
      "completed" : "2015-10-07 18:40:02",
      "error" : {
        "msg" : "No disc space.",
        "code" : 24
      }
    },
    {
      "history_report_id" : 35,
      "calculated_data" : {
        "session_count" : 12,
        "total_session_count" : 12
      },
      "created" : "2015-10-07 18:40:05",
      "file_name" : "call_history_2015-09-07_(12_of_12).csv",
      "history_type" : "calls",
      "format" : "csv",
      "completed" : "2015-10-07 18:40:06",
      "store_until" : "2015-10-14",
      "download_size" : 687,
      "file_size" : 2511,
      "last_downloaded" : "2015-10-07 18:40:18",
      "download_count" : 1
    },
    {
      "history_report_id" : 36,
      "calculated_data" : {
        "total_transaction_count" : 120,
        "account_id" : 1,
        "end_balance" : "8.15 USD",
        "transaction_count" : 120,
        "start_balance" : "10.2 USD"
      },
      "created" : "2015-10-07 18:40:10",
      "file_name" : "transaction_history_2015-09-07_(10.2_8.15).csv",
      "history_type" : "transactions",
      "format" : "csv",
      "completed" : "2015-10-07 18:40:11",
      "store_until" : "2015-10-14",
      "download_size" : 698,
      "file_size" : 3511,
      "last_downloaded" : "2015-10-07 18:40:19",
      "download_count" : 2
    },
    {
      "history_report_id" : 37,
      "created" : "2015-10-07 18:40:15",
      "history_type" : "transactions",
      "format" : "csv"
    }
  ],
  "total_count" : 7,
  "count" : 3
}

/DownloadHistoryReport

DESCRIPTION
Downloads the required history report.
URL
https://api.voximplant.com/platform_api/DownloadHistoryReport
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • history_report_id required
    The history report ID.

Request example: Download the completed history report with id = 1

https://api.voximplant.com/platform_api/DownloadHistoryReport/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&history_report_id=1
RESPONSE
JSON object with the following fields:
  • unknown (unknown)
    See the HTTP Content-Type header instead.

/GetTransactionHistory

DESCRIPTION
Gets the transaction history.
URL
https://api.voximplant.com/platform_api/GetTransactionHistory
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • from_date required
    The from date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • to_date required
    The to date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • timezone
    The selected timezone or the 'auto' value (will be used the account location). Defaults to Etc/GMT
  • transaction_id
    The transaction ID list separated by the ';' symbol.
  • payment_reference
    The external payment reference to filter.
  • transaction_type
    The transaction type list separated by the ';' symbol. The following values are possible: periodic_charge, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, robokassa_payment, gift, add_money, subscription_cancel, adjustment, wire_transfer, refund.
  • user_id
    The user ID list separated by the ';' symbol.
  • child_account_id
    The child account ID list separated by the ';' symbol or the 'all' value.
  • children_transactions_only
    Set true to get the children account transactions only. Defaults to false
  • users_transactions_only
    Set true to get the users' transactions only. Defaults to false
  • desc_order
    Set true to get records in the descent order.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0
  • output
    The output format. The following values available: json, csv Defaults to json
  • is_async
    Set true to get records in the asynchronous mode (for csv output only). See GetHistoryReports, DownloadHistoryReport. Defaults to false

Request example: Get the three transactions record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC with the 'gift' or 'money_distribution' types.

https://api.voximplant.com/platform_api/GetTransactionHistory/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&from_date=2012-01-01%2000%3A00%3A00&to_date=2014-01-01%2000%3A00%3A00&count=3&transaction_type=gift%3Bmoney_distribution&timezone=Etc/GMT
RESPONSE
JSON object with the following fields:
  • result ([TransactionInfoType])
  • total_count (number)
    The total found transaction count.
  • count (number)
    The returned transaction count.
  • timezone (string)
    The used timezone.
  • history_report_id (number)
    The history report ID (async mode).
Response example:
{
  "result" : [
    {
      "performed_at" : "2013-09-13 14:34:37",
      "transaction_id" : 51,
      "amount" : 5,
      "account_id" : 1,
      "currency" : "USD",
      "transaction_type" : "gift",
      "transaction_description" : "Gift"
    },
    {
      "performed_at" : "2013-10-01 13:10:51",
      "transaction_id" : 9784,
      "amount" : -0.05,
      "account_id" : 1,
      "currency" : "USD",
      "transaction_type" : "money_distribution",
      "transaction_description" : "To identity: ivan"
    },
    {
      "performed_at" : "2013-10-01 13:13:19",
      "transaction_id" : 9786,
      "amount" : 0.01,
      "account_id" : 1,
      "currency" : "USD",
      "transaction_type" : "money_distribution",
      "transaction_description" : "From identity: maria"
    }
  ],
  "total_count" : 7,
  "timezone" : "Etc\/GMT",
  "count" : 3
}
Response example:
{
  "result" : 1,
  "history_report_id" : 13
}

/GetACDHistory

DESCRIPTION
Gets the ACD history.
URL
https://api.voximplant.com/platform_api/GetACDHistory
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • from_date required
    The UTC from date filter in format YYYY-MM-DD HH:mm:SS
  • to_date required
    The UTC to date filter in format YYYY-MM-DD HH:mm:SS
  • acd_session_history_id
    The ACD session history ID list separated by the ';' symbol.
  • acd_queue_id
    The ACD queue ID list to filter separated by the ';' symbol.
  • user_id
    The user ID list to filter separated by the ';' symbol.
  • operator_hangup
    Set true to get the calls terminated by the operator.
  • unserviced
    The unserviced calls by the operator.
  • min_waiting_time
    The min waiting time filter.
  • rejected
    The rejected calls by the 'max_queue_size', 'max_waiting_time' threshold.
  • with_events
    Set true to get the binding events. Defaults to false
  • with_header
    Set false to get a CSV file without the column names if the output=csv Defaults to true
  • desc_order
    Set true to get records in the descent order.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0
  • output
    The output format. The following values available: json, csv Defaults to json

Request example: Get the two ACD session history records from the 2012-01-01 00:00:00 to the 2014-04-01 00:00:00

https://api.voximplant.com/platform_api/GetACDHistory/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&from_date=2012-01-01%2000%3A00%3A00&to_date=2014-01-01%2000%3A00%3A00&with_events=true&count=2
RESPONSE
JSON object with the following fields:
  • result ([ACDSessionInfoType])
  • total_count (number)
    The total found ACD session count.
  • count (number)
    The returned ACD session count.
Response example:
{
  "result" : [
    {
      "acd_session_history_id" : 123,
      "operator_hangup" : false,
      "unserviced" : false,
      "rejected" : false,
      "begin_time" : "2014-03-20 17:41:33",
      "acd_queue_id" : 1,
      "priority" : 100,
      "account_id" : 1,
      "in_service_duration" : 36,
      "user_id" : 661885,
      "waiting_duration" : 161,
      "after_service_duration" : 0,
      "events" : [
        {
          "user_id" : 661884,
          "acd_session_event_id" : 54,
          "time" : "2014-03-20 17:43:15",
          "type" : "OPERATOR_UNREACHABLE"
        }
      ]
    },
    {
      "acd_session_history_id" : 124,
      "account_id" : 1,
      "rejected" : false,
      "unserviced" : true,
      "begin_time" : "2014-03-20 17:44:35",
      "waiting_duration" : 3028,
      "acd_queue_id" : 1,
      "priority" : 100
    }
  ],
  "total_count" : 2,
  "count" : 2
}

Managing PSTN blacklist

/AddPstnBlackListItem

DESCRIPTION
Add a new phone number to the PSTN blacklist.
URL
https://api.voximplant.com/platform_api/AddPstnBlackListItem
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • pstn_blacklist_phone required
    The phone number in format e164.

Request example:

https://api.voximplant.com/platform_api/AddPstnBlackListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&pstn_blacklist_phone=123456789
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • pstn_blacklist_id (number)
    The PSTN black list item ID.
Response example:
{
  "result" : 1,
  "pstn_blacklist_id" : 1
}

/SetPstnBlackListItem

DESCRIPTION
Update the PSTN blacklist item.
URL
https://api.voximplant.com/platform_api/SetPstnBlackListItem
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • pstn_blacklist_id required
    The PSTN black list item ID.
  • pstn_blacklist_phone required
    The new phone number in format e164.

Request example:

https://api.voximplant.com/platform_api/SetPstnBlackListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&pstn_blacklist_phone=123456789&pstn_blacklist_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example:
{
  "result" : 1
}

/DelPstnBlackListItem

DESCRIPTION
Remove phone number from the PSTN blacklist.
URL
https://api.voximplant.com/platform_api/DelPstnBlackListItem
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • pstn_blacklist_id required
    The PSTN black list item ID.

Request example:

https://api.voximplant.com/platform_api/DelPstnBlackListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&pstn_blacklist_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example:
{
  "result" : 1
}

/GetPstnBlackList

DESCRIPTION
Add a new phone number to the PSTN blacklist.
URL
https://api.voximplant.com/platform_api/GetPstnBlackList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • pstn_blacklist_id
    The PSTN black list item ID for filter.
  • pstn_blacklist_phone
    The phone number in format e164 for filter.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example:

https://api.voximplant.com/platform_api/GetPstnBlackList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac
RESPONSE
JSON object with the following fields:
  • total_count (number)
    The total found phone numbers count.
  • count (number)
    The returned phone numbers count.
Response example:
{
  "result" : [
    {
      "pstn_blacklist_id" : 1,
      "pstn_blacklist_phone" : "123456789"
    }
  ],
  "total_count" : 1,
  "count" : 1
}

Managing Phone Numbers

/AttachPhoneNumber

DESCRIPTION
Attach the phone number to the account. To attach the German, Italian phone numbers you should specify the phone_owner_* parameters.
URL
https://api.voximplant.com/platform_api/AttachPhoneNumber
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_count required
    The phone count to attach.
  • phone_number required
    The phone number that can be used instead of phone_count. See the GetNewPhoneNumbers function.
  • country_code required
    The country code.
  • phone_category_name required
    The phone category name. See the GetPhoneNumberCategories function.
  • country_state
    The country state. See the GetPhoneNumberCategories and GetPhoneNumberCountryStates functions.
  • phone_region_id required
    The phone region ID. See the GetPhoneNumberRegions function.
  • regulation_address_id
    The phone regulation address ID.

Request example: Attach the one US phone number to the account 1.

https://api.voximplant.com/platform_api/AttachPhoneNumber/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=US&phone_category_name=GEOGRAPHIC&country_state=CA&phone_region_id=1100&phone_count=1

Request example: Attach the '74953332211' phone number to the account 1.

https://api.voximplant.com/platform_api/AttachPhoneNumber/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=RU&phone_category_name=GEOGRAPHIC&phone_region_id=4&phone_number=74953332211
RESPONSE
JSON object with the following fields:
Response example: Success
{
  "result" : 1,
  "phone_numbers" : [
    {
      "phone_number" : "74953332266",
      "phone_id" : 12
    },
    {
      "phone_number" : "74953335599",
      "phone_id" : 14
    }
  ]
}
Response example: The account verification required: RU
{
  "error" : {
    "msg" : "Account verification required.",
    "code" : 281,
    "details" : {
      "verification_name" : "RU"
    }
  }
}
Response example: The overdue account verification in progress.
{
  "error" : {
    "msg" : "Account verification in progress.",
    "code" : 282
  }
}

/BindPhoneNumberToApplication

DESCRIPTION
Bind the phone number to the application or unbind the phone number from the application. You should specify the application_id or application_name if you specify the rule_name.
URL
https://api.voximplant.com/platform_api/BindPhoneNumberToApplication
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_id required
    The phone ID list separated by the ';' symbol or the 'all' value.
  • phone_number required
    The phone number list separated by the ';' symbol that can be used instead of phone_id.
  • application_id required
    The application ID.
  • application_name required
    The application name that can be used instead of application_id.
  • rule_id
    The rule ID.
  • rule_name
    The rule name that can be used instead of rule_id.
  • bind
    Bind or unbind? Defaults to true

Request example: Bind the phone 1 to the application 1.

https://api.voximplant.com/platform_api/BindPhoneNumberToApplication/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_id=1&application_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/DeactivatePhoneNumber

DESCRIPTION
Deactivates the phone number.
URL
https://api.voximplant.com/platform_api/DeactivatePhoneNumber
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_id required
    The phone ID.
  • phone_number required
    The phone number that can be used instead of phone_id.

Request example: Deactivate the phone 1.

https://api.voximplant.com/platform_api/DeactivatePhoneNumber/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/SetPhoneNumberInfo

DESCRIPTION
Configure the phone number.
URL
https://api.voximplant.com/platform_api/SetPhoneNumberInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_id required
    The phone ID list separated by the ';' symbol or the 'all' value.
  • phone_number required
    The phone number that can be used instead of phone_id.
  • auto_charge required
    Is auto charge enable?

Request example: Enable the auto charging.

https://api.voximplant.com/platform_api/SetPhoneNumberInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_id=1&auto_charge=true
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetPhoneNumbers

DESCRIPTION
Gets the account phone numbers.
URL
https://api.voximplant.com/platform_api/GetPhoneNumbers
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_id
    The particular phone ID to filter
  • application_id
    The application ID.
  • application_name
    The application name that can be used instead of application_id.
  • is_bound_to_application
    Is a phone bound to an application.
  • phone_template
    The phone number start to filter
  • country_code
    The country code list separated by the ';' symbol.
  • phone_category_name
    The phone category name. See the GetPhoneNumberCategories function.
  • canceled
    The flag of the canceled (deleted) subscription to filter.
  • deactivated
    The flag of the deactivated (frozen) subscription to filter.
  • auto_charge
    The auto_charge flag to filter.
  • from_phone_next_renewal
    The UTC from 'phone_next_renewal' date filter in format: YYYY-MM-DD
  • to_phone_next_renewal
    The UTC to 'phone_next_renewal' date filter in format: YYYY-MM-DD
  • from_phone_purchase_date
    The UTC from 'phone_purchase_date' date filter in format: YYYY-MM-DD hh:mm:ss
  • to_phone_purchase_date
    The UTC to 'phone_purchase_date' date filter in format: YYYY-MM-DD hh:mm:ss
  • child_account_id
    The child account ID list separated by the ';' symbol or the 'all' value.
  • children_phones_only
    Set true to get the children phones only. Defaults to false
  • verification_name
    The required account verification name to filter.
  • verification_status
    The account verification status list separated by the ';' symbol. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  • from_unverified_hold_until
    Unverified phone hold until the date (from ...) in format: YYYY-MM-DD
  • to_unverified_hold_until
    Unverified phone hold until the date (... to) in format: YYYY-MM-DD
  • can_be_used
    Can the unverified account use the phone?
  • order_by
    The following values are available: 'phone_number' (ascent order), 'phone_price' (ascent order), 'phone_country_code' (ascent order), 'deactivated' (deactivated first, active last), 'purchase_date' (descent order), 'phone_next_renewal' (ascent order), 'verification_status', 'unverified_hold_until' (ascent order), 'verification_name'.
  • sandbox
    Flag allows you to display only the numbers of the sandbox, real numbers, or all numbers .The following values are possible: 'all', 'true', 'false'.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the two attached phone numbers.

https://api.voximplant.com/platform_api/GetPhoneNumbers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&count=2
RESPONSE
JSON object with the following fields:
  • total_count (number)
    The total found phone count.
  • count (number)
    The returned phone count.
Response example:
{
  "result" : [
    {
      "auto_charge" : true,
      "can_be_used" : false,
      "category_name" : "GEOGRAPHIC",
      "phone_country_code" : "RU",
      "phone_purchase_date" : "2013-10-10 04:02:47",
      "required_verification" : "RU",
      "verification_status" : "REQUIRED",
      "deactivated" : false,
      "unverified_hold_until" : "2013-10-24",
      "canceled" : false,
      "phone_next_renewal" : "2013-11-10",
      "phone_number" : "74957893798",
      "phone_price" : 0.45,
      "phone_id" : 1
    },
    {
      "auto_charge" : false,
      "can_be_used" : true,
      "category_name" : "GEOGRAPHIC",
      "phone_country_code" : "US",
      "phone_purchase_date" : "2013-08-28 14:13:36",
      "application_id" : 1,
      "deactivated" : true,
      "canceled" : false,
      "application_name" : "app1.myaccount191.voximplant.com",
      "phone_next_renewal" : "2013-09-28",
      "phone_number" : "12055645250",
      "phone_price" : 0.4,
      "phone_id" : 3
    }
  ],
  "total_count" : 4,
  "count" : 2
}

/GetNewPhoneNumbers

DESCRIPTION
Gets the new phone numbers.
URL
https://api.voximplant.com/platform_api/GetNewPhoneNumbers
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code.
  • phone_category_name required
    The phone category name. See the GetPhoneNumberCategories function.
  • country_state
    The country state. See the GetPhoneNumberCategories and GetPhoneNumberCountryStates functions.
  • phone_region_id required
    The phone region ID. See the GetPhoneNumberRegions function.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the two new fixed Russian phone numbers at max.

https://api.voximplant.com/platform_api/GetNewPhoneNumbers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=RU&phone_category_name=GEOGRAPHIC&phone_region_id=1&count=2
RESPONSE
JSON object with the following fields:
  • result ([NewPhoneInfoType])
  • total_count (number)
    The total found phone count.
  • count (number)
    The returned phone count.
Response example:
{
  "result" : [
    {
      "phone_country_code" : "RU",
      "phone_installation_price" : 10.2,
      "phone_period" : "0-1-0 0:0:0",
      "phone_number" : "74957893798",
      "phone_category_name" : "GEOGRAPHIC",
      "phone_price" : 0.45,
      "phone_id" : 10
    },
    {
      "phone_country_code" : "RU",
      "phone_installation_price" : 11.3,
      "phone_period" : "0-1-0 0:0:0",
      "phone_number" : "78332606030",
      "phone_category_name" : "GEOGRAPHIC",
      "phone_price" : 0.5,
      "phone_id" : 12
    }
  ],
  "total_count" : 400,
  "count" : 2
}

/GetPhoneNumberCategories

DESCRIPTION
Gets the phone number categories.
URL
https://api.voximplant.com/platform_api/GetPhoneNumberCategories
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code
    The country code.
  • sandbox
    Flag allows you to display phone number categories only of the sandbox, real or all .The following values are possible: 'all', 'true', 'false'.

Request example: Get the all phone number categories.

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

Request example: Get the phone number categories in Russia.

https://api.voximplant.com/platform_api/GetPhoneNumberCategories/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=RU
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "country_code" : "RU",
      "can_list_phone_numbers" : true,
      "phone_categories" : [
        {
          "phone_category_name" : "GEOGRAPHIC",
          "country_has_states" : false
        },
        {
          "phone_category_name" : "MOBILE",
          "country_has_states" : false
        }
      ],
      "phone_prefix" : "7"
    },
    {
      "country_code" : "US",
      "can_list_phone_numbers" : false,
      "phone_categories" : [
        {
          "phone_category_name" : "GEOGRAPHIC",
          "country_has_states" : true
        },
        {
          "phone_category_name" : "TOLLFREE",
          "country_has_states" : false
        }
      ],
      "phone_prefix" : "1"
    }
  ]
}

/GetPhoneNumberCountryStates

DESCRIPTION
Gets the phone number country states.
URL
https://api.voximplant.com/platform_api/GetPhoneNumberCountryStates
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code.
  • phone_category_name required
    The phone category name. See the GetPhoneNumberCategories function.
  • country_state
    The country state code (example: AL, CA, ... ).

Request example: Get the USA states.

https://api.voximplant.com/platform_api/GetPhoneNumberCountryStates/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=US&phone_category_name=GEOGRAPHIC

Request example: Get the AL (Alabama) state info.

https://api.voximplant.com/platform_api/GetPhoneNumberCountryStates/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=US&phone_category_name=GEOGRAPHIC&country_state=AL
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "country_state_name" : "Alabama",
      "country_state" : "AL"
    },
    {
      "country_state_name" : "California",
      "country_state" : "CA"
    }
  ]
}

/GetPhoneNumberRegions

DESCRIPTION
Gets the country regions of the phone numbers.
URL
https://api.voximplant.com/platform_api/GetPhoneNumberRegions
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code.
  • phone_category_name required
    The phone category name. See the GetPhoneNumberCategories function.
  • country_state
    The country state code (example: AL, CA, ... ).
  • omit_empty
    Set to 'false' to show the all regions (with and without phone numbers in stock). Defaults to true
  • phone_region_id
    The phone region ID to filter.
  • phone_region_name
    The phone region name to filter.
  • phone_region_code
    The region phone prefix to filter.

Request example: Get the Russian regions of the phone numbers.

https://api.voximplant.com/platform_api/GetPhoneNumberRegions/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=RU&phone_category_name=GEOGRAPHIC
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "phone_region_id" : 1,
      "phone_count" : 1123,
      "phone_installation_price" : 10.2,
      "phone_region_name" : "Moscow",
      "phone_period" : "0-1-0 0:0:0",
      "required_verification" : "RU",
      "phone_price" : 0.45,
      "verification_status" : "REQUIRED",
      "phone_region_code" : "499"
    },
    {
      "phone_region_id" : 3,
      "phone_count" : 95,
      "phone_installation_price" : 2,
      "phone_region_name" : "Novosibirsk",
      "phone_period" : "0-1-0 0:0:0",
      "phone_price" : 0.5,
      "phone_region_code" : "383"
    }
  ]
}

/GetActualPhoneNumberRegion

DESCRIPTION
Gets actual info the country region of the phone numbers.
URL
https://api.voximplant.com/platform_api/GetActualPhoneNumberRegion
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code.
  • phone_category_name required
    The phone category name. See the GetPhoneNumberCategories function.
  • phone_region_id required
    The phone region ID to filter.

Request example: Get the Germany region of the phone numbers.

https://api.voximplant.com/platform_api/GetActualPhoneNumberRegion/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&phone_category_name=GEOGRAPHIC&phone_region_id=1
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : {
    "phone_region_id" : 1,
    "phone_count" : 95,
    "phone_installation_price" : 2,
    "phone_region_name" : "AACHEN",
    "phone_period" : "0-1-0 0:0:0",
    "phone_price" : 0.5,
    "phone_region_code" : "263"
  }
}

Managing Queues

/AddQueue

DESCRIPTION
Adds a new ACD queue.
URL
https://api.voximplant.com/platform_api/AddQueue
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id required
    The application ID.
  • application_name required
    The application name that can be used instead of application_id.
  • acd_queue_name required
    The queue name. The length must be less than 100.
  • acd_queue_priority
    The integer queue priority. The highest priority is 0. Defaults to 100
  • auto_binding
    Set false to disable the auto operators binding by skills comparing. Defaults to true
  • service_probability
    The value in range [0.5 ... 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue. Defaults to 1.0
  • max_queue_size
    The max queue size. Defaults to
  • max_waiting_time
    The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time. Defaults to
  • average_service_time
    The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction. Defaults to

Request example: Add a new ACD queue for the application 1.

https://api.voximplant.com/platform_api/AddQueue/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=1&acd_queue_name=myqueue
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • acd_queue_id (number)
    The ACD queue ID.
Response example: Success.
{
  "result" : 1,
  "acd_queue_id" : 1
}

/DelQueue

DESCRIPTION
Deletes the ACD queue.
URL
https://api.voximplant.com/platform_api/DelQueue
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • acd_queue_id required
    The ACD queue ID.
  • acd_queue_name required
    The ACD queue name that can be used instead of acd_queue_id. The ACD queue name list separated by the ';' symbol.

Request example: Delete the ACD queue 1.

https://api.voximplant.com/platform_api/DelQueue/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&acd_queue_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SetQueueInfo

DESCRIPTION
Edits the ACD queue.
URL
https://api.voximplant.com/platform_api/SetQueueInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • acd_queue_id required
    The ACD queue ID.
  • acd_queue_name required
    The ACD queue name that can be used instead of acd_queue_id.
  • new_acd_queue_name
    The new queue name. The length must be less than 100.
  • acd_queue_priority
    The integer queue priority. The highest priority is 0.
  • auto_binding
    Set false to disable the auto operators binding to the queue by skills comparing.
  • service_probability
    The value in range [0.5 ... 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue.
  • max_queue_size
    The max queue size.
  • max_waiting_time
    The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time.
  • average_service_time
    The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction.
  • application_id
    The new application ID.

Request example: Change the queue name.

https://api.voximplant.com/platform_api/SetQueueInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&acd_queue_id=1&new_acd_queue_name=support
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/GetQueues

DESCRIPTION
Gets the ACD queues.
URL
https://api.voximplant.com/platform_api/GetQueues
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • acd_queue_id
    The ACD queue ID to filter.
  • acd_queue_name
    The ACD queue name part to filter.
  • application_id
    The application ID to filter.
  • skill_id
    The skill ID to filter.
  • excluded_skill_id
    The excluded skill ID to filter.
  • with_skills
    Set true to get the bound skills. Defaults to false
  • showing_skill_id
    The skill to show in the 'skills' field output.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the two queues.

https://api.voximplant.com/platform_api/GetQueues/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&count=2
RESPONSE
JSON object with the following fields:
  • result ([QueueInfoType])
  • total_count (number)
    The total found queue count.
  • count (number)
    The returned queue count.
Response example:
{
  "result" : [
    {
      "auto_binding" : true,
      "service_probability" : 1,
      "acd_queue_name" : "myqueue",
      "acd_queue_priority" : 100,
      "modified" : "2014-01-19 14:12:46",
      "acd_queue_id" : 1,
      "application_id" : 1
    },
    {
      "auto_binding" : true,
      "service_probability" : 0.85,
      "max_waiting_time" : 5,
      "acd_queue_name" : "support",
      "acd_queue_priority" : 1,
      "average_service_time" : 180,
      "max_queue_size" : 100,
      "modified" : "2014-01-19 14:12:46",
      "acd_queue_id" : 3,
      "application_id" : 1
    }
  ],
  "total_count" : 17,
  "count" : 1
}

/GetACDState

DESCRIPTION
Gets the current ACD queue state.
URL
https://api.voximplant.com/platform_api/GetACDState
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • acd_queue_id
    The ACD queue ID list separated by the ';' symbol or the 'all' value. Defaults to all

Request example: Get the state of the queue 1.

https://api.voximplant.com/platform_api/GetACDState/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&acd_queue_id=1
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : {
    "acd_queues" : [
      {
        "acd_queue_name" : "myqueue",
        "ready_operators" : [
          {
            "user_id" : 661885,
            "user_name" : "op5",
            "user_display_name" : "op 5",
            "idle_duration" : 212
          }
        ],
        "locked_operators" : [
          {
            "unreached" : "2014-03-26 08:09:36",
            "user_id" : 661884,
            "user_name" : "op4",
            "user_display_name" : "op 4"
          },
          {
            "user_id" : 661863,
            "user_name" : "op3",
            "user_display_name" : "op 3",
            "locks" : [
              {
                "created" : "2014-03-26 07:59:58",
                "id" : "577b77c8565040c5bd322af65e787302"
              }
            ]
          },
          {
            "user_id" : 661866,
            "user_name" : "op6",
            "acd_calls" : [
              {
                "acd_session_history_id" : 192,
                "acd_request_id" : "95d9eddf040348f3b79454bb5379f604",
                "acd_queue_name" : "myqueue",
                "begin_time" : "2014-03-26 08:07:12",
                "acd_queue_id" : 1,
                "callerid" : "79267774411"
              }
            ],
            "user_display_name" : "op 6",
            "locks" : [
              {
                "created" : "2014-03-26 08:07:14",
                "id" : "3f2d7f188c4211e58994feff819cdc9f"
              }
            ]
          },
          {
            "user_id" : 661867,
            "user_name" : "op7",
            "acd_calls" : [
              {
                "acd_session_history_id" : 195,
                "submitted" : "2014-03-26 08:08:25",
                "acd_request_id" : "edd39d292e414ecebbfd237d8ba2d7f1",
                "acd_queue_name" : "support",
                "begin_time" : "2014-03-26 08:08:15",
                "acd_queue_id" : 3,
                "callerid" : "79297704410"
              }
            ],
            "user_display_name" : "op 7",
            "locks" : [
              {
                "created" : "2014-03-26 08:08:17",
                "id" : "b1f1809996974a0ba2cb660c730ae5c0"
              }
            ]
          }
        ],
        "servicing_calls" : [
        ],
        "acd_queue_id" : 1,
        "waiting_calls" : [
          {
            "acd_session_history_id" : 192,
            "minutes_to_submit" : 0,
            "user_id" : 661866,
            "waiting_time" : 146,
            "user_name" : "op6",
            "begin_time" : "2014-03-26 08:07:12",
            "callerid" : "79267774411",
            "priority" : 100,
            "user_display_name" : "op 6"
          }
        ]
      }
    ]
  }
}
Response example:
{
  "result" : {
    "acd_queues" : [
      {
        "ready_operators" : [
        ],
        "servicing_calls" : [
          {
            "acd_session_history_id" : 192,
            "user_id" : 661866,
            "waiting_time" : 45,
            "user_name" : "op6",
            "begin_time" : "2014-03-26 08:07:12",
            "callerid" : "79267774411",
            "priority" : 100,
            "user_display_name" : "op 6"
          }
        ],
        "acd_queue_id" : 1,
        "waiting_calls" : [
          {
            "acd_session_history_id" : 193,
            "minutes_to_submit" : 5,
            "waiting_time" : 78,
            "begin_time" : "2014-03-26 08:14:14",
            "callerid" : "79851113322",
            "priority" : 100
          }
        ]
      }
    ]
  }
}

Managing Rules

/AddRule

DESCRIPTION
Adds a new rule for the application.
URL
https://api.voximplant.com/platform_api/AddRule
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id required
    The application ID.
  • application_name required
    The application name, can be used instead of application_id.
  • rule_name required
    The rule name. The length must be less than 512
  • rule_pattern required
    The rule pattern regex. The length must be less than 64 KB.
  • rule_pattern_exclude
    The exclude pattern regex. The length must be less than 64 KB.
  • scenario_id required
    The scenario ID list separated by the ';' symbol.
  • scenario_name required
    Can be used instead of scenario_id. The scenario name list separated by the ';' symbol.

Request example: Add a new rule.

https://api.voximplant.com/platform_api/AddRule/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application_id=1&rule_name=allowall&rule_pattern=.*
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • rule_id (number)
    The new rule ID.
Response example:
{
  "result" : 1,
  "rule_id" : 1
}

/DelRule

DESCRIPTION
Deletes the rule.
URL
https://api.voximplant.com/platform_api/DelRule
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID list separated by the ';' symbol or the 'all' value.
  • rule_name required
    Can be used instead of rule_id. The rule name list separated by the ';' symbol.
  • application_id required
    The application ID list separated by the ';' symbol or the 'all' value.
  • application_name required
    Can be used instead of application_id. The application name list separated by the ';' symbol.

Request example: Delete the rule 1 and 3.

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

Request example: Delete the all rules from the application 1.

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

Request example: Delete the all rules from the all applications.

https://api.voximplant.com/platform_api/DelRule/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=all&application_id=all
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/SetRuleInfo

DESCRIPTION
Edits the rule.
URL
https://api.voximplant.com/platform_api/SetRuleInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID.
  • rule_name
    The new rule name. The length must be less than 512
  • rule_pattern
    The new rule pattern regex. The length must be less than 64 KB.
  • rule_pattern_exclude
    The new exclude pattern regex. The length must be less than 64 KB.

Request example: Deny all.

https://api.voximplant.com/platform_api/SetRuleInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=1&rule_name=denyall&rule_pattern_exclude=.*
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetRules

DESCRIPTION
Gets the rules.
URL
https://api.voximplant.com/platform_api/GetRules
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id required
    The application ID.
  • application_name required
    The application name that can be used instead of application_id.
  • rule_id
    The rule ID to filter
  • rule_name
    The rule name part to filter.
  • template
    Search for template matching
  • with_scenarios
    Set true to get binding scenarios info.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the first rule for the template 74951234567

https://api.voximplant.com/platform_api/GetRules/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&application=1&template=74951234567&with_scenarios=true&count=1
RESPONSE
JSON object with the following fields:
  • result ([RuleInfoType])
  • total_count (number)
    The total found rule count.
  • count (number)
    The returned rule count.
Response example:
{
  "result" : [
    {
      "rule_id" : 10,
      "rule_name" : "Moscow",
      "rule_pattern" : "749[59].+",
      "modified" : "2013-09-09 17:07:29",
      "scenarios" : [
        {
          "scenario_name" : "scen3",
          "modified" : "2013-09-09 16:36:50",
          "scenario_id" : 3
        },
        {
          "scenario_name" : "scen2",
          "modified" : "2013-09-09 16:35:55",
          "scenario_id" : 2
        }
      ],
      "application_id" : 1
    }
  ],
  "total_count" : 1,
  "count" : 1
}

/ReorderRules

DESCRIPTION
Sets the rule selection order. Note: the rules must belong to the same application!
URL
https://api.voximplant.com/platform_api/ReorderRules
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID list separated by the ';' symbol.

Request example: Set the rule selection order: 1, 7, 3

https://api.voximplant.com/platform_api/ReorderRules/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=1;7;3
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

Managing SIP Registration

/CreateSipRegistration

DESCRIPTION
Create a new SIP registration.
URL
https://api.voximplant.com/platform_api/CreateSipRegistration
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • username required
    The user name.
  • proxy required
    The SIP proxy
  • auth_user
    The SIP authentications user
  • outbound_proxy
    The outbound SIP proxy
  • password
    The SIP password

Request example: Create SIP registration.

https://api.voximplant.com/platform_api?cmd=CreateSipRegistration&account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&username=test&proxy=localhost
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • sip_registration_id (number)
    The sip registration id.
  • account_info (ShortAccountInfoType)
    The current account state.
Response example: Success
{
  "result" : 1,
  "sip_registration_id" : 1
}
Response example: Insufficient money to add a new SIP registration.
{
  "error" : {
    "msg" : "Insufficient money.",
    "code" : 127,
    "details" : {
      "required_money" : 0.5
    }
  }
}

/UpdateSipRegistration

DESCRIPTION
Update SIP registration.
URL
https://api.voximplant.com/platform_api/UpdateSipRegistration
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_registration_id required
    The registration ID
  • username required
    The user name.
  • proxy required
    The SIP proxy
  • auth_user
    The SIP authentications user
  • outbound_proxy
    The outbound SIP proxy
  • password
    The SIP password

Request example: Update SIP registration with id 1.

https://api.voximplant.com/platform_api?cmd=UpdateSipRegistration&account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&registration_id=1&username=test&outbound_proxy=12&password=123456
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/BindSipRegistration

DESCRIPTION
Bind the SIP registration to the application or unbind the SIP registration from the application. You should specify the application_id or application_name if you specify the rule_name.
URL
https://api.voximplant.com/platform_api/BindSipRegistration
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_registration_id required
    The registration ID
  • application_id required
    The application ID.
  • application_name required
    The application name that can be used instead of application_id.
  • rule_id
    The rule ID.
  • rule_name
    The rule name that can be used instead of rule_id.
  • bind
    Bind or unbind? Defaults to true

Request example: Bind SIP registration with id 1 to dimaon with id 123.

https://api.voximplant.com/platform_api?cmd=BindSipRegistration&account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&domain_id=123&registration_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/DeleteSipRegistration

DESCRIPTION
Delete SIP registration.
URL
https://api.voximplant.com/platform_api/DeleteSipRegistration
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_registration_id required
    The registration ID

Request example: Delete SIP registration with id 1.

https://api.voximplant.com/platform_api?cmd=DeleteSipRegistration&account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&registration_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetSipRegistrations

DESCRIPTION
Get active SIP registrations.
URL
https://api.voximplant.com/platform_api/GetSipRegistrations
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_registration_id
    The SIP registration ID.
  • username
    The SIP user name to filter.
  • deactivated
    Set true to show the frozen SIP registrations only.

Request example: Get all active sip registrations

https://api.voximplant.com/platform_api?cmd=GetSipRegistrations&account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac
RESPONSE
JSON object with the following fields:
Response example: Success
{
  "result" : [
    {
      "last_updated" : "2014-09-01 12:00:00",
      "status_code" : 200,
      "sip_registration_id" : 1,
      "subscription_price" : 0.5,
      "application_id" : 123,
      "deactivated" : false,
      "proxy" : "localhost",
      "user_id" : 2,
      "next_subscription_renewal" : "2014-10-01",
      "outbound_proxy" : "127.0.0.1",
      "purchase_date" : "2014-09-01 11:00:01",
      "username" : "test",
      "successful" : true
    }
  ],
  "count" : 1
}

Managing SIP white list

/AddSipWhiteListItem

DESCRIPTION
Adds a new network address to the SIP white list.
URL
https://api.voximplant.com/platform_api/AddSipWhiteListItem
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_whitelist_network required
    The network address in format A.B.C.D/L or A.B.C.D/a.b.c.d (example 192.168.1.5/16).

Request example:

https://api.voximplant.com/platform_api/AddSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_network=192.168.1.5%2F16
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • sip_whitelist_id (number)
    The SIP white list item ID.
Response example:
{
  "result" : 1,
  "sip_whitelist_id" : 1
}

/DelSipWhiteListItem

DESCRIPTION
Deletes the network address from the SIP white list.
URL
https://api.voximplant.com/platform_api/DelSipWhiteListItem
METHOD
GET
PARAMETERS
  • account_id required
    The account's ID.
  • api_key required
  • sip_whitelist_id required
    The SIP white list item ID to delete.

Request example:

https://api.voximplant.com/platform_api/DelSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SetSipWhiteListItem

DESCRIPTION
Edits the SIP white list.
URL
https://api.voximplant.com/platform_api/SetSipWhiteListItem
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_whitelist_id required
    The SIP white list item ID
  • sip_whitelist_network required
    The new network address in format A.B.C.D/L or A.B.C.D/a.b.c.d (example 192.168.1.5/16)

Request example:

https://api.voximplant.com/platform_api/SetSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_id=1&sip_whitelist_network=192.168.1.5%2F16
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/GetSipWhiteList

DESCRIPTION
Gets the SIP white list.
URL
https://api.voximplant.com/platform_api/GetSipWhiteList
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • sip_whitelist_id
    The SIP white list item ID to filter
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two networks, but skip the first one.

https://api.voximplant.com/platform_api/GetSipWhiteList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2
RESPONSE
JSON object with the following fields:
  • total_count (number)
    The total found networks count.
  • count (number)
    The returned networks count.
Response example:
{
  "result" : [
    {
      "sip_whitelist_id" : 12,
      "sip_whitelist_network" : "192.168.15.1\/24"
    },
    {
      "sip_whitelist_id" : 33,
      "sip_whitelist_network" : "192.168.16.1\/24"
    }
  ],
  "total_count" : 7,
  "count" : 2
}

Managing Scenarios

/AddScenario

DESCRIPTION
Adds a new scenario. Please use the POST method.
URL
https://api.voximplant.com/platform_api/AddScenario
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • scenario_name required
    The scenario name. The length must be less than 30
  • scenario_script required
    The scenario text. The length must be less than 128 KB.

Request example: Add a new scenario: var s='hello';

https://api.voximplant.com/platform_api/AddScenario/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&scenario_name=scen1&scenario_script=var%20s%3D%22hello%22%3B
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • scenario_id (number)
    The new scenario ID.
Response example:
{
  "result" : 1,
  "scenario_id" : 1
}

/DelScenario

DESCRIPTION
Deletes the scenario.
URL
https://api.voximplant.com/platform_api/DelScenario
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • scenario_id required
    The scenario ID list separated by the ';' symbol or the 'all' value.

Request example: Delete the scenario 1 and 3.

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

Request example: Delete the all scenarios.

https://api.voximplant.com/platform_api/DelScenario/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&scenario_id=all
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/BindScenario

DESCRIPTION
Bind the scenario list with the rule. You should specify the application_id or application_name if you specify the rule_name.
URL
https://api.voximplant.com/platform_api/BindScenario
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • scenario_id required
    The scenario ID list separated by the ';' symbol.
  • scenario_name required
    Can be used instead of scenario_id. The scenario name list separated by the ';' symbol.
  • rule_id required
    The rule ID.
  • rule_name required
    The rule name that can be used instead of rule_id.
  • application_id required
    The application ID.
  • application_name required
    The application name that can be used instead of application_id.
  • bind
    Bind or unbind? Defaults to true

Request example: Bind the scenarios 1, 2 and 3 with the rule 1.

https://api.voximplant.com/platform_api/BindScenario/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&scenario_id=1;2;3&rule_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetScenarios

DESCRIPTION
Gets the account's scenarios.
URL
https://api.voximplant.com/platform_api/GetScenarios
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • scenario_id
    The scenario ID to filter
  • with_script
    Set true to get the scenario text. You must specify the 'scenario_id' too! Defaults to false
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two scenarios, but skip the first one.

https://api.voximplant.com/platform_api/GetScenarios/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2
RESPONSE
JSON object with the following fields:
  • result ([ScenarioInfoType])
  • total_count (number)
    The total found scenario count.
  • count (number)
    The returned scenario count.
Response example:
{
  "result" : [
    {
      "scenario_name" : "scen2",
      "modified" : "2013-09-09 16:35:55",
      "scenario_id" : 2
    },
    {
      "scenario_name" : "scen3",
      "modified" : "2013-09-09 16:36:50",
      "scenario_id" : 3
    }
  ],
  "total_count" : 4,
  "count" : 2
}

/SetScenarioInfo

DESCRIPTION
Edits the scenario. Please use the POST method.
URL
https://api.voximplant.com/platform_api/SetScenarioInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • scenario_id required
    The scenario ID.
  • required_scenario_name required
    The name of the scenario to edit, can be used instead of scenario_id.
  • scenario_name
    The new scenario name. The length must be less than 30
  • scenario_script
    The new scenario text. The length must be less than 128 KB.

Request example: Add a new scenario: var s='hello';

https://api.voximplant.com/platform_api/SetScenarioInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&scenario_id=1&scenario_name=scen11&scenario_script=var%20s%3D%22hello%20world%22%3B
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/ReorderScenarios

DESCRIPTION
Sets the scenario loading order.
URL
https://api.voximplant.com/platform_api/ReorderScenarios
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • rule_id required
    The rule ID.
  • rule_name required
    The rule name that can be used instead of rule_id.
  • scenario_id
    The scenario ID list separated by the ';' symbol.

Request example: Set the scenario loading order: 17, 15, 20.

https://api.voximplant.com/platform_api/ReorderScenarios/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=2&scenario_id=17;15;20
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example:
{
  "result" : 1
}

/StartScenarios

DESCRIPTION
Run the JavaScript scenarios on a VoxImplant server. The scenarios run in a new media session.
URL
https://api.voximplant.com/platform_api/StartScenarios
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_id
    The user ID. Run the scripts from the user if set.
  • user_name
    The user name that can be used instead of user_id. Run the scripts from the user if set.
  • rule_id required
    The rule ID.
  • script_custom_data
    The script custom data (like a script argument).
  • reference_ip
    IPv4 that will be used to find nearest media server.

Request example: Start the scripts from the account.

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

Request example: Start the scripts from the user 1.

https://api.voximplant.com/platform_api/StartScenarios/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&rule_id=1&script_custom_data=mystr&user_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • media_session_access_url (string)
    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL will result in AppEvents.HttpRequest VoxEngine event being emitted for scenario, with HTTP request data passed to it.
  • media_session_check_url (string)
    The URL to check media session
Response example: Success
{
  "result" : 1,
  "media_session_access_url" : "http:\/\/1.2.3.4:12092\/request?id=93e41c6e20811b9b.1380201554.0@1.2.3.4&token=36bc7ce95edc679e32d83bb6f3ad985f"
}

/StartConference

DESCRIPTION
Start a new conference or join the conference.
URL
https://api.voximplant.com/platform_api/StartConference
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • conference_name required
    The conference name. The name length must be less than 50 symbols.
  • rule_id required
    The rule ID.
  • user_id
    The user ID. Run the scripts from the user if set.
  • user_name
    The user name that can be used instead of user_id. Run the scripts from the user if set.
  • script_custom_data
    The script custom data (like a script argument).
  • reference_ip
    IPv4 that will be used to find nearest media server.

Request example: Start the conference from the account.

https://api.voximplant.com/platform_api/StartConference/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&conference_name=boss&rule_id=1&script_custom_data=mystr

Request example: Start the conference from the user 1.

https://api.voximplant.com/platform_api/StartConference/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&conference_name=boss&rule_id=1&script_custom_data=mystr&user_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • media_session_access_url (string)
    The URL to control a created media session. It can be used for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL will result in AppEvents.HttpRequest VoxEngine event being emitted for scenario, with HTTP request data passed to it.
Response example: Success
{
  "result" : 1,
  "media_session_access_url" : "http:\/\/1.2.3.4:12092\/request?id=93e41c6e20811b9b.1380201554.0@1.2.3.4&token=36bc7ce95edc679e32d83bb6f3ad985f"
}

Managing Skills

/AddSkill

DESCRIPTION
Adds a new ACD operator skill.
URL
https://api.voximplant.com/platform_api/AddSkill
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • skill_name required
    The ACD operator skill name. The length must be less than 512.

Request example: Add a new skill.

https://api.voximplant.com/platform_api/AddSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_name=English
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • skill_id (number)
    The skill ID
Response example: Success.
{
  "result" : 1,
  "skill_id" : 1
}

/DelSkill

DESCRIPTION
Deletes the skill.
URL
https://api.voximplant.com/platform_api/DelSkill
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • skill_id required
    The skill ID.
  • skill_name required
    The skill name that can be used instead of skill_id.

Request example: Delete the skill 1.

https://api.voximplant.com/platform_api/DelSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/SetSkillInfo

DESCRIPTION
Edits the skill.
URL
https://api.voximplant.com/platform_api/SetSkillInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • skill_id required
    The skill ID.
  • skill_name required
    The skill name that can be used instead of skill_id.
  • new_skill_name required
    The new skill name. The length must be less than 512.

Request example: Change the skill name.

https://api.voximplant.com/platform_api/SetSkillInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1&new_skill_name=Support
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

/GetSkills

DESCRIPTION
Gets the skills.
URL
https://api.voximplant.com/platform_api/GetSkills
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • skill_id
    The skill ID to filter.
  • skill_name
    The skill name part to filter.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get two skills, but skip the first one.

https://api.voximplant.com/platform_api/GetApplications/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2
RESPONSE
JSON object with the following fields:
  • result ([SkillInfoType])
  • total_count (number)
    The total found skill count.
  • count (number)
    The returned skill count.
Response example:
{
  "result" : [
    {
      "skill_name" : "English",
      "skill_id" : 3
    },
    {
      "skill_name" : "Support",
      "skill_id" : 5
    }
  ],
  "total_count" : 17,
  "count" : 2
}

/BindSkill

DESCRIPTION
Binds the skills with the users (ACD operators) and/or the ACD queues.
URL
https://api.voximplant.com/platform_api/BindSkill
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • skill_id required
    The skill ID list separated by the ';' symbol or the 'all' value.
  • skill_name required
    Can be used instead of skill_id. The skill name list separated by the ';' symbol.
  • user_id required
    The user ID list separated by the ';' symbol or the 'all' value.
  • user_name required
    The user name that can be used instead of user_id. The user name list separated by the ';' symbol.
  • acd_queue_id required
    The ACD queue ID list separated by the ';' symbol or the 'all' value.
  • acd_queue_name required
    The ACD queue name that can be used instead of acd_queue_id. The ACD queue name list separated by the ';' symbol.
  • bind
    Bind or unbind? Defaults to true

Request example: Bind the skills 1, 5 to the users 5, 6, 10.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1;3&user_id=5;6;10

Request example: Bind the all skill to the queues 11, 12.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=all&acd_queue_id=11;12&bind=true

Request example: Unbind the skills 1, 6 from the all users and the queues 11, 12.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1;6&acd_queue_id=11;12&user_id=all
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success.
{
  "result" : 1
}

Managing Users

/AddUser

DESCRIPTION
Adds a new user.
URL
https://api.voximplant.com/platform_api/AddUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_name required
    The user name in format [a-z0-9][a-z0-9_-]{2,49}
  • user_display_name required
    The user display name. The length must be less than 256.
  • user_password required
    The user password. The length must be at least 6 symbols.
  • parent_accounting
    Is account money use?
  • two_factor_auth_required
    Is two factor authorization required?
  • mobile_phone
    The user mobile phone. The length must be less than 50.
  • user_active
    The user enable flag Defaults to true
  • user_custom_data
    Any string

Request example: Add a new user.

https://api.voximplant.com/platform_api/AddUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_name=iden1&user_display_name=iden1&user_password=1234567
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • user_id (number)
    The new user ID.
Response example:
{
  "result" : 1,
  "user_id" : 1
}

/DelUser

DESCRIPTION
Deletes the user.
URL
https://api.voximplant.com/platform_api/DelUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_id required
    The user ID list separated by the ';' symbol or the 'all' value.
  • user_name required
    The user name list separated by the ';' symbol that can be used instead of user_id.

Request example: Delete the two user.

https://api.voximplant.com/platform_api/DelUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=3;55
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/SetUserInfo

DESCRIPTION
Edits the user.
URL
https://api.voximplant.com/platform_api/SetUserInfo
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_id required
    The user to edit.
  • user_name required
    Can be used instead of user_id.
  • new_user_name
    The new user name in format [a-z0-9][a-z0-9_-]{2,49}
  • user_display_name
    The new user display name. The length must be less than 256.
  • user_password
    The new user password. The length must be at least 6 symbols.
  • parent_accounting
    Is account money use?
  • user_active
    The user enable flag Defaults to true
  • user_custom_data
    Any string
  • two_factor_auth_required
    Is two factor authorization required?
  • mobile_phone
    The new user mobile phone. The length must be less than 50.

Request example: Edit the user password.

https://api.voximplant.com/platform_api/SetUserInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&user_password=7654321
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/BindUser

DESCRIPTION
Bind the user list with the application list.
URL
https://api.voximplant.com/platform_api/BindUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_id required
    The user ID list separated by the ';' symbol or the 'all' value.
  • user_name required
    Can be used instead of user_id. The user name list separated by the ';' symbol.
  • application_id required
    The application ID list separated by the ';' symbol or the 'all' value.
  • application_name required
    Can be used instead of application_id. The application name list separated by the ';' symbol.
  • bind
    Bind or unbind? Defaults to true

Request example: Bind the user 1 with the applications 1, 2 and 3.

https://api.voximplant.com/platform_api/BindUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&application_id=1;2;3
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetUsers

DESCRIPTION
Gets the users.
URL
https://api.voximplant.com/platform_api/GetUsers
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • application_id
    The application ID to filter.
  • excluded_application_id
    The excluded application ID to filter.
  • excluded_application_name
    The excluded application name to filter.
  • skill_id
    The skill ID to filter.
  • excluded_skill_id
    The excluded skill ID to filter.
  • acd_queue_id
    The ACD queue ID to filter.
  • user_id
    The user ID to filter.
  • user_name
    The user name part to filter.
  • user_active
    The user active flag to filter.
  • user_display_name
    The user display name part to filter.
  • application_name
    The application name part to filter.
  • with_applications
    Set true to get the bound applications. Defaults to false
  • with_skills
    Set true to get the bound skills. Defaults to false
  • with_queues
    Set true to get the bound queues. Defaults to false
  • acd_status
    The ACD status list separated by the ';' symbol.
  • showing_application_id
    The application to show in the 'applications' field output.
  • showing_skill_id
    The skill to show in the 'skills' field output.
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0
  • order_by
    The following values are available: 'user_id', 'user_name' and 'user_display_name'. Defaults to user_name
  • return_live_balance
    Set true to get the user live balance. Defaults to true

Request example: Get two first identities.

https://api.voximplant.com/platform_api/GetUsers/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&with_applications=true&count=2
RESPONSE
JSON object with the following fields:
  • result ([UserInfoType])
  • total_count (number)
    The total found user count.
  • count (number)
    The returned user count.
Response example:
{
  "result" : [
    {
      "user_active" : true,
      "balance" : 1,
      "user_id" : 1,
      "user_name" : "iden-1",
      "frozen" : false,
      "modified" : "2013-09-09 11:26:31",
      "user_display_name" : "iden-1",
      "parent_accounting" : true,
      "applications" : [
        {
          "application_name" : "myapp3.test.voximplant.com",
          "modified" : "2013-09-09 14:12:46",
          "application_id" : 3
        },
        {
          "application_name" : "myapp4.test.voximplant.com",
          "modified" : "2013-09-09 14:13:14",
          "application_id" : 4
        }
      ]
    },
    {
      "user_active" : true,
      "balance" : 0,
      "user_id" : 2,
      "user_name" : "iden-2",
      "frozen" : false,
      "modified" : "2013-09-09 15:22:13",
      "user_display_name" : "iden-2",
      "parent_accounting" : true,
      "applications" : [
        {
          "application_name" : "myapp4.test.voximplant.com",
          "modified" : "2013-09-09 14:13:14",
          "application_id" : 4
        }
      ]
    }
  ],
  "total_count" : 2,
  "count" : 2
}

/TransferMoneyToUser

DESCRIPTION
Transfer the account's money to the user or transfer the user's money to the account if the money amount is negative.
URL
https://api.voximplant.com/platform_api/TransferMoneyToUser
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • user_id required
    The user ID list separated by the ';' symbol.
  • amount required
    The money amount, $. The absolute amount value must be equal or greater than 0.01
  • currency required
    The amount currency. Examples: RUR, EUR, USD.
  • strict_mode
    Returns error if strict_mode is true and an user or the account hasn't enough money. Defaults to true
  • user_transaction_description
    The user transaction description. Defaults to From account/To account
  • account_transaction_description
    The account transaction description. The following macro available: ${user_id}, ${user_name} Defaults to From user: ${user_name}/To user: ${user_name}

Request example: Transfer 5.67 $ to the user 1 and transfer 5.67 $ to the user 2 too. The account spends 2*5.67= 11.34 $ in total.

https://api.voximplant.com/platform_api/TransferMoneyToUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1;2&amount=5.67¤cy=USD

Request example: Transfer 5.67 $ from the user 1 to the account.

https://api.voximplant.com/platform_api/TransferMoneyToUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&amount=-5.67¤cy=USD

Request example: Transfer the all money from the user 1 to the parent account.

https://api.voximplant.com/platform_api/TransferMoneyToUser/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&user_id=1&amount=-10000000&strict_mode=false
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • balance (number)
    The new account balance.
Response example: Success
{
  "result" : 1,
  "balance" : 105.8977
}

Managing callerIDs

/AddCallerID

DESCRIPTION
Adds a new caller ID.
URL
https://api.voximplant.com/platform_api/AddCallerID
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • callerid_number required
    The callerID number.

Request example:

https://api.voximplant.com/platform_api/AddCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_number=74953331122
RESPONSE
JSON object with the following fields:
  • result (number)
    1
  • callerid_id (number)
    The id of the callerID object.
  • verification_code_callin (string)
    Code that can be endered to verify after dialing one of our call in numbers
Response example:
{
  "result" : 1,
  "callerid_id" : 10
}

/ActivateCallerID

DESCRIPTION
Activates the CallerID by the verification code.
URL
https://api.voximplant.com/platform_api/ActivateCallerID
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • callerid_id required
    The id of the callerID object.
  • callerid_number required
    The callerID number that can be used instead of callerid_id.
  • verification_code required
    The verification code, see the VerifyCallerID function.

Request example: Activate the callerID by the verification code.

https://api.voximplant.com/platform_api/ActivateCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1&verification_code=12345
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/DelCallerID

DESCRIPTION
Deletes the CallerID. Note: you can't delete a CID permanently (the antispam defence).
URL
https://api.voximplant.com/platform_api/DelCallerID
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • callerid_id required
    The id of the callerID object.
  • callerid_number required
    The callerID number that can be used instead of callerid_id.

Request example: Delete the callerID 1.

https://api.voximplant.com/platform_api/DelCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

/GetCallerIDs

DESCRIPTION
Gets the account callerIDs.
URL
https://api.voximplant.com/platform_api/GetCallerIDs
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • callerid_id required
    The id of the callerID object to filter.
  • callerid_number required
    The phone number to filter.
  • active
    The active flag to filter.
  • order_by
    The following values are available: 'caller_number' (ascent order), 'verified_until' (ascent order).
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Get the two callerIDs.

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

Request example: Try to find the 79997770044 CID.

https://api.voximplant.com/platform_api/GetCallerIDs/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_number=79997770044
RESPONSE
JSON object with the following fields:
  • result ([CallerIDInfoType])
  • total_count (number)
    The total found record count.
  • count (number)
    The returned record count.
Response example:
{
  "result" : [
    {
      "callerid_id" : 9,
      "code_entering_attempts_left" : 10,
      "callerid_number" : "74959998877",
      "active" : false,
      "verification_call_attempts_left" : 5
    },
    {
      "callerid_id" : 11,
      "verified_until" : "2014-01-14",
      "callerid_number" : "74951112233",
      "active" : true
    }
  ],
  "total_count" : 4,
  "count" : 2
}

/VerifyCallerID

DESCRIPTION
Gets a verification code by make call to the callerID number.
URL
https://api.voximplant.com/platform_api/VerifyCallerID
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • callerid_id required
    The id of the callerID object.
  • callerid_number required
    The callerID number that can be used instead of callerid_id.

Request example: Verify the callerID 1.

https://api.voximplant.com/platform_api/VerifyCallerID/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&callerid_id=1
RESPONSE
JSON object with the following fields:
  • result (number)
    1
Response example: Success
{
  "result" : 1
}

Managing push credentials

/AddPushCredential

DESCRIPTION
Add push credentials
URL
https://api.voximplant.com/platform_api/AddPushCredential
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • push_provider_name required
    The push provider name. Available values: APPLE, APPLE_VOIP, GOOGLE.
  • push_provider_id required
    The push provider id.
  • external_app_name required
    The application name.
  • cert_content required
    Public and private keys in PKCS12 format.
  • cert_file_name
    The parameter is required, when set 'cert_content' as POST body.
  • cert_password required
    The secret password for private key.
  • is_dev_mode required
    Set true for use this certificate in apple's sandbox environment

Request example: Add new Apple credentials.

https://api.voximplant.com/platform_api/AddPushCredential/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&push_provider_name=APPLE&external_app_name=testapp&cert_password=1234567
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : 1,
  "push_credential_id" : 1
}

/SetPushCredential

DESCRIPTION
Modify push credentials
URL
https://api.voximplant.com/platform_api/SetPushCredential
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • push_credential_id required
    The push credentials id.
  • external_app_name required
    The application name.
  • cert_content required
    Public and private keys in PKCS12 format.
  • cert_password required
    The secret password for private key.
  • is_dev_mode required
    Set true for use this certificate in apple's sandbox environment

Request example: Modify credentials.

https://api.voximplant.com/platform_api/SetPushCredential/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&push_credential_id=1&external_app_name=testapp&cert_password=1234567
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : 1
}

/DelPushCredential

DESCRIPTION
Remove push credentials
URL
https://api.voximplant.com/platform_api/DelPushCredential
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • push_credential_id required
    The push credentials id.

Request example: Remove credentials.

https://api.voximplant.com/platform_api/DelPushCredential/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&push_credential_id=1
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : 1
}

/GetPushCredential

DESCRIPTION
Get push credentials
URL
https://api.voximplant.com/platform_api/GetPushCredential
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • push_credential_id
    The push credentials id.
  • push_provider_name
    The push provider name. Availible values: APPLE, APPLE_VOIP, GOOGLE.
  • push_provider_id
    The push provider id.
  • application_name
    The name of bound application.
  • application_id
    The id of bound application.
  • external_app
    The push provider's application name.
  • with_cert
    Set true to get the user's certificate.

Request example: Get push credentials.

https://api.voximplant.com/platform_api/GetPushCredential/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&push_credential_id=1
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "push_provider_id" : 1,
      "push_provider_name" : "APPLE",
      "cert_credential" : {
        "file_name" : "apns.pkcs12"
      },
      "push_credential_id" : 1,
      "external_app_name" : "testapp",
      "applications" : [
        {
          "application_name" : "test.test.voximplant.com",
          "application_id" : 1
        }
      ]
    }
  ]
}

/BindPushCredential

DESCRIPTION
Bind push credentials to applications
URL
https://api.voximplant.com/platform_api/BindPushCredential
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • push_credential_id required
    The push credentials id.
  • application_id required
    The application id.
  • bind
    Set to false for unbind. Default value is true.

Request example: Bind push credential to application.

https://api.voximplant.com/platform_api/BindPushCredential/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&push_credential_id=1&application_id=1
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : 1
}

Managing regulation address

/CreateRegulationAddress

DESCRIPTION
Add regulation address
URL
https://api.voximplant.com/platform_api/CreateRegulationAddress
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • phone_category_name required
    The phone category name.
  • destination_country_code required
    The destination country code
  • phone_owner_country_code
    The owner's country code. Default uses destination_country_code
  • proof required
    Send as Body Request or multiform.
  • phone_region_code
    The phone region code
  • phone_owner_salutation required
    This is the salutation of the end user for the created address: MR or MS if firstName and lastName are used or COMPANY if companyName is used
  • phone_owner_first_name
    This is the first name for the end user of the created address. It is a mandatory field if the salutation is MR or MS.
  • phone_owner_last_name
    This is the last name for the end user of the created address. It is a mandatory field if the salutation is MR or MS.
  • phone_owner_company
    This is the company name for the end user of the created address. It is a mandatory field if the salutation is COMPANY.
  • phone_owner_zip_code required
    This is the zip code of the end user’s address.
  • phone_owner_city required
    This is the city of the end user’s address.
  • phone_owner_street required
    This is the name of the end user’s street.
  • phone_owner_building_number required
    This is the number of the building or the street number of the address.
  • phone_owner_building_letter
    This is the building letter which can also be used for additional information on the street number.

Request example: Add new regulation address

https://api.voximplant.com/platform_api/CreateRegulationAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&phone_category_name=GEOGRAPHIC&destination_country_code=DE&phone_owner_country_code=DE&phone_region_code=243&phone_owner_salutation=COMPANY&phone_owner_company=ABC&phone_owner_zip_code=5000012&phone_owner_city=AAHEN&phone_owner_street=street&phone_owner_building_number=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
  • regulation_address_id (number)
    ID of regulatio address
Response example:
{
  "result" : true,
  "regulation_address_id" : 2
}

/LinkregulationAddress

DESCRIPTION
Link regulation address to phone
URL
https://api.voximplant.com/platform_api/LinkregulationAddress
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • regulation_address_id required
    The regulation address ID
  • phone_id required
    The phone ID for link
  • phone_number required
    The phone number for link

Request example: Link regulation address to phone number

https://api.voximplant.com/platform_api/LinkregulationAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1&phone_id=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
Response example:
{
  "result" : 1
}

/GetZIPCodes

DESCRIPTION
Search availible zip codes
URL
https://api.voximplant.com/platform_api/GetZIPCodes
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code
  • phone_region_code
    The phone region code
  • count
    The max returning record count. Defaults to 20
  • offset
    The record count to omit. Defaults to 0

Request example: Search zip codes in Germany

https://api.voximplant.com/platform_api/GetZIPCodes/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&count=1
RESPONSE
JSON object with the following fields:
  • result ([ZipCode])
    The ZipCode records.
  • count (number)
    The returned zip codes count.
Response example:
{
  "result" : [
    {
      "city" : "AACHEN",
      "zip_code" : "52062"
    }
  ],
  "count" : 1
}

/UploadProofOfAddress

DESCRIPTION
Upload proof of address
URL
https://api.voximplant.com/platform_api/UploadProofOfAddress
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • regulation_address_id required
    The regulation address id
  • proof required
    Send as Body Request or multiform.

Request example: Upload proof of address.

https://api.voximplant.com/platform_api/UploadProofOfAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1
RESPONSE
JSON object with the following fields:
  • result (boolean)
Response example:
{
  "result" : 1
}

/GetRegulationsAddress

DESCRIPTION
Search user's regulation address
URL
https://api.voximplant.com/platform_api/GetRegulationsAddress
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code
    The country code
  • phone_category_name
    The phone category name.
  • phone_region_code
    The phone region code.
  • regulation_address_id
    The regulation address ID.
  • verified
    Show only verified regulation address.
  • in_progress
    Show only in progress regulation address.

Request example: Search regulation address with ID = 1

https://api.voximplant.com/platform_api/GetRegulationsAddress/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac®ulation_address_id=1
RESPONSE
JSON object with the following fields:
  • result ([RegulationAddress])
    The RegulationAddress records.
  • count (number)
    The returned regulation address count.
Response example:
{
  "result" : [
    {
      "country_code" : "DE",
      "city" : "City",
      "street" : "street",
      "last_name" : "last",
      "external_id" : "12345",
      "phone_category_name" : "GEOGRAPHIC",
      "id" : 1,
      "salutation" : "MR",
      "first_name" : "First",
      "builder_number" : "10",
      "zip_code" : "140000",
      "status" : "IN_PROGRESS"
    }
  ],
  "count" : 1
}

/GetAvailibleRegulations

DESCRIPTION
Search availible regulation for link
URL
https://api.voximplant.com/platform_api/GetAvailibleRegulations
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code
  • phone_category_name required
    The phone category name.
  • phone_region_code
    The phone region code. Mandatory for regulation type LOCAL

Request example: Search availible regulation address

https://api.voximplant.com/platform_api/GetAvailibleRegulations/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&phone_category_name=GEOGRAPHIC&phone_region_code=643
RESPONSE
JSON object with the following fields:
  • result (boolean)
    If result equal 1 then user has more regulation address or they did not wanted. Otherwise, you need to create regulations address.
  • availible_address ([RegulationAddress])
    The availible RegulationAddress records.
  • count_in_progress (integer)
    The count of RegulationAddress in progress status.
Response example:
{
  "result" : 1,
  "availible_address" : [
    {
      "country_code" : "DE",
      "city" : "City",
      "street" : "street",
      "last_name" : "last",
      "external_id" : "12345",
      "phone_category_name" : "GEOGRAPHIC",
      "id" : 1,
      "salutation" : "MR",
      "first_name" : "First",
      "builder_number" : "10",
      "zip_code" : "140000",
      "status" : "VERIFIED"
    }
  ],
  "count_in_progress" : 0
}

/GetCountries

DESCRIPTION
Get all countries
URL
https://api.voximplant.com/platform_api/GetCountries
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code
    The country code A2

Request example: Get Germany

https://api.voximplant.com/platform_api/GetCountries/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "country_code" : "DE",
      "country_name" : "Germany"
    }
  ],
  "count" : 1
}

/GetRegions

DESCRIPTION
Get availible regions in country
URL
https://api.voximplant.com/platform_api/GetRegions
METHOD
GET
PARAMETERS
  • auth parameters required
    Follow link for authentication parameter names and details.
  • country_code required
    The country code A2
  • phone_category_name required
    The phone category name. Availible: GEOGRAPHIC, TOLL_FREE, NATIONAL, MOBILE
  • city_name
    The pattern of city's name
  • count
    The returned regions count.
  • offset
    The record count to omit.

Request example: Get regions with city AACHEN.

https://api.voximplant.com/platform_api/GetRegions/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&country_code=DE&phone_category_name=GEOGRAPHIC&city_name=AACHEN
RESPONSE
JSON object with the following fields:
Response example:
{
  "result" : [
    {
      "is_need_regulation_address" : true,
      "phone_region_id" : 1,
      "regulation_address_type" : "LOCAL",
      "phone_region_name" : "AACHEN",
      "phone_region_code" : "241"
    }
  ],
  "count" : 1
}

Structures

AccountCallback

The account callback. See the 'AccountCallbacks' type.
  • callback_id (number)
    The callback ID (sequence).
  • type (string)
    The callback type. The following values are possible: account_document_verified, account_is_frozen, activate_successful, call_history_report, card_expired, card_expires_in_month, card_payment, card_payment_failed, js_fail, min_balance, regulation_address_verified, renewed_subscriptions, reset_account_password_request, sip_registration_fail, stagnant_account, subscription_is_detached, subscription_is_frozen, transaction_history_report, uncharged_tariff, unverified_subscription_detached.
  • account_id (number)
    The account ID.
  • hash (string)
    The security hash: hash = md5(account_salt + account_id + api_key + callback_id). Example: 50c5fe2290cd7409b37e673b8b05e495
  • account_name (string)
    The account name.
  • account_email (string)
    The account email.
  • language_code (string)
    The notification language code (2 symbols, ISO639-1). Examples: en, ru
  • account_first_name (string)
    The first name.
  • account_last_name (string)
    The last name.
  • balance (number)
    The account's money.
  • currency (string)
    The currency code (USD, RUR, EUR, ...).
  • account_document_verified (AccountDocumentVerifiedCallback) optional
    The specific account callback details.
  • account_is_frozen (AccountIsFrozenCallback) optional
    The specific account callback details.
  • activate_successful (ActivateSuccessfulCallback) optional
    The specific account callback details.
  • call_history_report (CallHistoryReportCallback) optional
    The specific account callback details.
  • card_expired (CardExpiredCallback) optional
    The specific account callback details.
  • card_expires_in_month (CardExpiresInMonthCallback) optional
    The specific account callback details.
  • card_payment (CardPaymentCallback) optional
    The specific account callback details.
  • card_payment_failed (CardPaymentFailedCallback) optional
    The specific account callback details.
  • js_fail (JSFailCallback) optional
    The specific account callback details. See the send_js_error parameter of the SetAccountInfo function.
  • min_balance (MinBalanceCallback) optional
    The specific account callback details.
  • regulation_address_verified (RegulationAddressVerifiedCallback) optional
    The specific account callback details.
  • renewed_subscriptions (RenewedSubscriptionsCallback) optional
    The specific account callback details.
  • reset_account_password_request (ResetAccountPasswordRequestCallback) optional
    The specific account callback details.
  • sip_registration_fail (SIPRegistrationFailCallback) optional
    The specific account callback details.
  • stagnant_account (StagnantAccountCallback) optional
    The specific account callback details.
  • subscription_is_frozen (SubscriptionIsFrozenCallback) optional
    The specific account callback details.
  • subscription_is_detached (SubscriptionIsDetachedCallback) optional
    The specific account callback details.
  • transaction_history_report (TransactionHistoryReportCallback) optional
    The specific account callback details.
  • uncharged_tariff (UnchargedTariffCallback) optional
    The specific account callback details.
  • unverified_subscription_detached (UnverifiedSubscriptionDetachedCallback) optional
    The specific account callback details.

AccountCallbacks

The HTTP account callbacks body.

AccountDocumentVerifiedCallback

The specific account callback details.
  • account_document_id (number)
    The uploaded document ID.
  • account_document_status (string)
    The document verification status. The following values are possible: ACCEPTED, REJECTED
  • uploaded (string)
    The UTC date of the document upload in format: YYYY-MM-DD hh::mm:ss
  • is_individual (boolean)
    Is individual, isn't legal entity?
  • comment (string) optional
    The reviewer's comment.
  • verification_name (string)
    The verification name (type).

AccountInfoType

The GetAccountInfo function result.
  • account_id (number)
    The account's ID.
  • account_name (string)
    The account's name.
  • account_email (string)
    The account's email.
  • account_first_name (string) optional
    The first name.
  • account_last_name (string) optional
    The last name.
  • created (string)
    The UTC account created time in format: YYYY-MM-DD HH:mm:SS
  • language_code (string) optional
    The notification language code (2 symbols, ISO639-1). Examples: en, ru
  • location (string) optional
    The account location (timezone). Examples: America/Los_Angeles, GMT-08:00
  • 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
    Are the VoxImplant tariff changing notifications required?
  • news_notifications (boolean) optional
    Are the VoxImplant news notifications required?
  • 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). Examples: US, RU, GB
  • 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.
  • active (boolean)
    The account activation flag.
  • frozen (boolean) optional
    The no money flag.
  • balance (number) optional
    The account's money.
  • credit_limit (number) optional
    The account's credit limit.
  • tariff_id (number) optional
    The account's tariff ID.
  • tariff_name (string) optional
    The account's tariff name.
  • periodic_charge (string) optional
    The tariff interval, format: YYYY-MM-DD 00:00:00
  • next_charge (string) optional
    The next charge date, format: YYYY-MM-DD
  • currency (string) optional
    The currency code (USD, RUR, EUR, ...).
  • support_robokassa (boolean) optional
    Is the robokassa payment system allowed?
  • support_bank_card (boolean) optional
    Is the bank card payments allowed?
  • support_invoice (boolean) optional
    Is the bank invoice allowed?
  • account_custom_data (string) optional
    The custom data.
  • access_entries ([String]) optional
    The allowed access entries (the API function names).
  • with_access_entries (boolean) optional
    Set true to get the admin user permissions.
  • send_js_error (boolean) optional
    Is email sending on a JS error?

AccountIsFrozenCallback

The specific account callback details.

AccountVerificationDocument

The account verification document info. The AccountVerificationType field.
  • account_document_id (number)
    The account verification document ID.
  • is_individual (boolean)
    Is individual, isn't legal entity?
  • comment (string) optional
    The reviewer's comment.
  • uploaded (string)
    The UTC date of the document upload in format: YYYY-MM-DD hh::mm:ss
  • account_document_status (string)
    The account document status. The following values are possible: ACCEPTED, REJECTED, IN_PROGRESS, INCOMPLETE_SET.

AccountVerifications

The account verifications.

AccountVerificationType

The account verification info. The AccountVerificationsType field.
  • verification_name (string)
    The verification name.
  • verification_status (string)
    The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED, NOT_REQUIRED
  • unverified_hold_until (string) optional
    Unverified subscriptions hold until the date in format: YYYY-MM-DD (if the account verification is required). Some subscriptions will be detached on that day automatically!
  • documents ([AccountVerificationDocument]) optional
    The uploaded documents.

ACDLock

The ACD lock type.
  • id (string)
    The ACD lock ID.
  • created (string)
    The UTC lock created time in format: YYYY-MM-DD HH:mm:SS

ACDLockedOperatorStateType

The locked operator state.
  • user_id (number)
    The user ID of the operator.
  • user_name (string)
    The user name of the operator.
  • user_display_name (string)
    The display user name of the operator.
  • unreached (string) optional
    The UTC time when the operator becomes unavailable in format: YYYY-MM-DD HH:mm:SS
  • locks ([ACDLock]) optional
    The operator locks.
  • acd_calls ([ACDOperatorCall]) optional
    The ACD operator calls.

ACDOperatorCall

The ACD operator call type.
  • acd_session_history_id (number)
    The ACD session history ID of the request.
  • acd_request_id (string)
    The internal ACD session history ID.
  • acd_queue_id (number)
    The ACD queue ID.
  • acd_queue_name (string)
    The ACD queue name.
  • callerid (string) optional
    The client callerid.
  • begin_time (string)
    The begin time of the request in format: YYYY-MM-DD HH:mm:SS
  • submitted (string) optional
    The submission time of the request in format: YYYY-MM-DD HH:mm:SS

ACDQueueOperatorInfoType

The 'acd_queues' element of the GetUsers function result.
  • acd_queue_id (number)
    The ACD queue ID.
  • acd_queue_name (string)
    The ACD queue name.
  • auto_link (boolean)
    The user bound with the ACD queue in the manual mode if false.

ACDQueueStateType

The ACD queue state.

ACDReadyOperatorStateType

The ready operator state.
  • user_id (number)
    The user ID of the operator.
  • user_name (string)
    The user name of the operator.
  • user_display_name (string)
    The display user name of the operator.
  • idle_duration (number)
    The idle duration in seconds. The minimum of the duration after the last hangup and the duration after the operator status changing to READY.

ACDServicingCallStateType

The servicing call state.
  • user_id (number)
    The user ID of the operator.
  • user_name (string)
    The user name of the operator.
  • user_display_name (string)
    The display user name of the operator.
  • priority (number)
    The request priority.
  • callerid (string) optional
    The client callerid.
  • begin_time (string)
    The begin time of the request in format: YYYY-MM-DD HH:mm:SS
  • waiting_time (number)
    The waiting time before servicing in seconds.
  • acd_session_history_id (number)
    The ACD session history ID of the request.

ACDSessionEventInfoType

The ACD session event info.
  • acd_session_event_id (number)
    The ACD session event ID.
  • time (string)
    The UTC start date in format YYYY-MM-DD HH:mm:SS
  • type (string)
    The event type name.
  • user_id (number) optional
    The user ID.
  • custom_data (string) optional
    The custom data.

ACDSessionInfoType

The GetACDHistory function result item.
  • acd_session_history_id (number)
    The ACD session history ID.
  • account_id (number)
    The account ID.
  • begin_time (string)
    The UTC start date in format YYYY-MM-DD HH:mm:SS
  • priority (number)
    The request priority.
  • acd_queue_id (number) optional
    The ACD queue ID.
  • user_id (number) optional
    The user ID.
  • waiting_duration (number) optional
    The waiting duration in seconds.
  • in_service_duration (number) optional
    The conversation duration in seconds.
  • after_service_duration (number) optional
    The after service duration in seconds.
  • events ([ACDSessionEventInfoType]) optional
    The binding events.

ACDStateType

The GetACDState function result item.

ACDWaitingCallStateType

The waiting call state.
  • user_id (number) optional
    The user ID of the operator to try to service the request.
  • user_name (string)
    The user name of the operator.
  • user_display_name (string)
    The display user name of the operator.
  • priority (number)
    The request priority.
  • callerid (string) optional
    The client callerid.
  • begin_time (string)
    The begin time of the request in format: YYYY-MM-DD HH:mm:SS
  • waiting_time (number)
    The waiting time in seconds.
  • minutes_to_submit (number)
    The predicted minutes left to start servicing.
  • acd_session_history_id (number)
    The ACD session history ID of the request.

ActivateSuccessfulCallback

The specific account callback details.

AdminRoleType

The GetAdminRoles function result.
  • admin_role_id (number)
    The admin role ID.
  • admin_role_name (string)
    The admin role name.
  • admin_role_active (boolean)
    If false the allowed and denied entries have no affect.
  • system_role (boolean)
    Is system role?
  • modified (string)
    The admin role editing UTC date in format: YYYY-MM-DD HH:mm:SS
  • allowed_entries ([String]) optional
    The allowed access entries (the API function names).
  • denied_entries ([String]) optional
    The denied access entries (the API function names).

AdminUserType

The GetAdminUsers function result.
  • admin_user_id (number)
    The admin user ID.
  • admin_user_name (string)
    The admin user name.
  • admin_user_display_name (string)
    The admin user display name.
  • admin_user_active (boolean)
    Is allowed to logon?
  • modified (string)
    The admin user editing UTC date in format: YYYY-MM-DD HH:mm:SS
  • access_entries ([String]) optional
    The allowed access entries (the API function names).
  • admin_roles ([AdminRoleType]) optional
    The attached admin roles.

API_Error

The API error.
  • code (number)
    The error code.
  • msg (string)
    The error description.

ApplicationInfoType

The GetApplications function result.
  • application_id (number)
    The application ID.
  • application_name (string)
    The full application name.
  • im_enabled (boolean)
    Is the instant messaging (IM) enabled?
  • im_roster_type (string)
    The roster type (IM users list type). The following values are possible: personal, group.
  • busy_on_call (boolean)
    The busy_on_call flag.
  • modified (string)
    The application editing UTC date in format: YYYY-MM-DD HH:mm:SS
  • users ([UserInfoType]) optional
    The binding filtered users. (Note: an user object contains the 'user_id' field only)

AttachedPhoneInfoType

The GetPhoneNumbers function result item.
  • phone_id (number)
    The phone ID.
  • phone_number (string)
    The phone number.
  • phone_price (number)
    The periodic phone price.
  • phone_country_code (string)
    The phone country code (2 symbols).
  • phone_next_renewal (string)
    The next renewal date in format: YYYY-MM-DD
  • phone_purchase_date (string)
    The purchase date in format: YYYY-MM-DD hh:mm:ss
  • deactivated (boolean)
    The flag of the frozen subscription.
  • canceled (boolean)
    The flag of the deleted subscription.
  • auto_charge (boolean)
    The auto_charge flag.
  • application_id (number) optional
    The bound application ID.
  • application_name (string) optional
    The bound application name.
  • rule_id (number) optional
    The bound rule ID.
  • rule_name (string) optional
    The bound rule name.
  • category_name (string)
    The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)
  • required_verification (string) optional
    The required account verification name.
  • verification_status (string) optional
    The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  • unverified_hold_until (string) optional
    Unverified phone hold until the date in format: YYYY-MM-DD (if the account verification is required). The number will be detached on that day automatically!
  • can_be_used (boolean)
    Can the unverified account use the phone?

AuthorizedAccountIPType

The GetAuthorizedAccountIPs function result.
  • authorized_ip (string)
    The authorized IP4 or network.
  • allowed (boolean)
    The allowed flag (true - whitelist, false - blacklist).
  • created (string)
    The item creating UTC date in format: YYYY-MM-DD HH:mm:SS

BankCardType

The bank card info.
  • auto_charge (boolean)
    The auto charging flag.
  • min_balance (number)
    The min account balance to trigger the auto charging.
  • card_overrun_value (number)
    The card overrun value in the account currency.
  • expiration_year (number)
    The card expiration year.
  • expiration_month (number)
    The card expiration month.
  • acct (number)
    The last card number digits.

CalculatedCallHistoryDataType

The HistoryReportType.calculated_data object on HistoryReportType.history_type=='calls'
  • session_count (number)
    The session count in the report.
  • total_session_count (number)
    The total found filtered session count.
  • timezone (string)
    The selected timezone.

CalculatedTransactionHistoryDataType

The HistoryReportType.calculated_data object on HistoryReportType.history_type=='transactions'
  • transaction_count (number)
    The transaction count in the report.
  • total_transaction_count (number)
    The total found filtered transaction count.
  • start_balance (string) optional
    The start account/user balance with currency. Example: 2.3 USD
  • end_balance (string) optional
    The end account/user balance with currency. Example: 12.5 RUR
  • account_id (number) optional
    The account ID.
  • user_id (number) optional
    The user ID.
  • user_name (number) optional
    The user name.
  • is_checked (boolean) optional
    true if balance&transactions are valid.
  • timezone (string)
    The selected timezone.

CallerIDInfoType

The GetCallerIDs function result.
  • callerid_id (number)
    The callerID id.
  • callerid_number (string)
    The callerID number.
  • active (boolean)
    The active flag.
  • code_entering_attempts_left (number) optional
    The code entering attempts left for the unverified callerID.
  • verification_call_attempts_left (number) optional
    The verification call attempts left for the unverified callerID.
  • verified_until (string) optional
    The verification ending date in format: YYYY-MM-DD (for the verified callerID).
  • verification_code_callin (string)
    Code that can be endered to verify after dialing one of our call in numbers

CallHistoryReportCallback

The specific account callback details.
  • history_report_id (number)
    The history report ID.
  • success (boolean)
    Is success?
  • order_date (string)
    The UTC order date in format: YYYY-MM-DD hh::mm:ss

CallInfoType

The call info.
  • call_id (number)
    The call history ID.
  • start_time (string)
    The start time in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • duration (number) optional
    The call duration in seconds.
  • local_number (string)
    The local number.
  • remote_number (string)
    The remote number.
  • remote_number_type (string)
    The remote number type.
  • incoming (boolean)
    The incoming flag.
  • successful (boolean)
    The success flag.
  • transaction_id (number)
    The transaction ID.
  • record_url (string) optional
    The record URL.
  • media_server_address (string)
    The media server IP address.
  • cost (number) optional
    The call cost.
  • custom_data (string) optional
    The custom data.

CallListDetailType

Detailing job telephone calls
  • list_id (number)
    The list ID.
  • custom_data (string)
    Data for transmission to the script
  • start_execution_time (string)
    Time with which to start the job. Format HH:mm:ss
  • finish_execution_time (string)
    Time after which the task can not be performed. Format HH:mm:ss
  • result_data (string)
    Results of the task, if it was granted, or information about the runtime error.
  • last_attempt (string)
    Date and time of the last attempt to perform a task.
  • attmepts_left (number)
    Number of remaining attempts.
  • status_id (number)
    The status ID.
  • status (string)
    The status name.

CallSessionInfoType

The GetCallHistory function result item.
  • call_session_history_id (number)
    The call session history ID.
  • account_id (number)
    The account ID.
  • application_id (number)
    The application ID.
  • user_id (number)
    The user ID.
  • start_date (string)
    The start date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • duration (number) optional
    The session duration in seconds.
  • initiator_address (string)
    The initiator IP address.
  • media_server_address (string)
    The media server IP address.
  • log_file_url (string)
    The session log URL.
  • finish_reason (string) optional
    The finish reason
  • calls ([CallInfoType]) optional
    The binding calls.
  • other_resource_usage ([ResourceUsageType]) optional
    The used resorces.
  • records ([RecordType]) optional
    The binding records.

CardExpiredCallback

The specific account callback details.

CardExpiresInMonthCallback

The specific account callback details.

CardPaymentCallback

The specific account callback details.

CardPaymentFailedCallback

The specific account callback details.

CertCredentialType

The push credentials list item info.
  • cert_file_name (string)
    The file name
  • cert_password (string) optional
    The password for private key.
  • cert_content (string) optional
    The certificate content in BASE64.
  • is_dev_mode (boolean)
    The use in a Apple sandbox environment.

ChargeAccountResult

The ChargeAccount function result.
  • charged_amount (number)
    The charged money amount.
  • phones ([ChargedPhoneType]) optional
    The charged phone list.

ChargedPhoneType

The charged phone info.
  • phone_id (number)
    The phone ID.
  • phone_number (string)
    The phone number.
  • deactivated (boolean)
    Is subscription frozen?
  • is_charged (boolean)
    Has phone been charged?

ClonedAccountType

The cloned account info.

ClonedACDQueueType

The cloned ACD queue info.
  • acd_queue_id (number)
    The ACD queue ID.
  • acd_queue_name (string)
    The ACD queue name.

ClonedACDSkillType

The cloned ACD skill info.
  • skill_id (number)
    The ACD skill ID.
  • skill_name (string)
    The ACD skill name.

ClonedAdminRoleType

The cloned admin role info.
  • admin_role_id (number)
    The admin role ID.
  • admin_role_name (string)
    The admin role name.

ClonedAdminUserType

The cloned admin user info.
  • admin_user_id (number)
    The admin user ID.
  • admin_user_name (string)
    The admin user name.
  • admin_user_api_key (string)
    The API key of the admin user.

ClonedApplicationType

The cloned application info.
  • application_id (number)
    The application ID.
  • application_name (string)
    The full application name.
  • users ([ClonedRuleType])
    The cloned rules.

ClonedRuleType

The cloned rule info.
  • rule_id (number)
    The rule ID.
  • rule_name (string)
    The rule name.

ClonedScenarioType

The cloned scenario info.
  • scenario_id (number)
    The scenario ID.
  • scenario_name (string)
    The scenario name.

ClonedUserType

The cloned user info.
  • user_id (number)
    The user ID.
  • user_name (string)
    The user name.

ContractInfoType

The contract info (the ContractorInfoType field).
  • agreement_number (string) optional
    The agreement number.
  • agreement_date (string) optional
    The agreement date in format: YYYY-MM-DD

ContractorInfoType

The GetContractorInfo function result.
  • inn (string)
    ИНН
  • kpp (string) optional
    КПП (отсутствует для ИП).
  • company_name (string)
    The full company name.
  • company_address (string)
    The full company address with a postcode.
  • company_phone (string) optional
    The company phone.
  • correspondence_address (string) optional
    The correspondence address.
  • correspondence_email (string) optional
    The correspondence email.
  • correspondence_to (string) optional
    The correspondence to.
  • contract (ContractInfoType) optional
    The contract info.

ContractorInvoiceServiceType

The invoice service info. The ContractorInvoiceType field.
  • service_name (string)
    The service name.
  • service_cost (number)
    The service cost (RUR).

ContractorInvoiceType

The GetContractorInvoices result.
  • invoice_number (string)
    The invoice number.
  • invoice_date (string)
    The invoice date in format: YYYY-MM-DD
  • is_post_payment (boolean)
    The post payment flag
  • from_date (string) optional
    The from date in format: YYYY-MM-DD
  • to_date (string) optional
    The to date in format: YYYY-MM-DD
  • total_amount (number)
    The total invoice amount (RUR).
  • paid_amount (number) optional
    The paid amount (RUR).
  • The service list.

ExchangeRates

The GetCurrencyRate function result.
  • RUR (number) optional
    The RUR exchange rate.
  • EUR (number) optional
    The EUR exchange rate.
  • (number) optional

GetMoneyAmountToChargeResult

The GetMoneyAmountToCharge function result.
  • amount (number)
    The money amount of the subscriptions + tariff + negative_balance in the specified currency.
  • min_amount (number)
    The 'amount' value minus the positive account balance in the specified currency.
  • bank_card_amount_usd (number) optional
    Exists if bank card payments are allowed. It's the maximum of the 'amount' in USD and the min_card_payment (10$).
  • min_bank_card_amount_usd (number) optional
    Exists if bank card payments are allowed. It's the maximum of the 'min_amount' in USD and the min_card_payment (10$).
  • robokassa_amount_rub (number) optional
    Exists if robokassa payments are allowed. It's the maximum of the 'min_amount' in RUR and the min_robokassa_payment (500 RUR).
  • min_robokassa_amount_rub (number) optional
    Exists if robokassa payments are allowed. It's the maximum of the 'min_amount' in RUR and the min_robokassa_payment (500 RUR).
  • subscriptions ([SubscriptionsToChargeType])
    The subscriptions to charge.

HistoryReportType

The history report info.
  • history_report_id (number)
    The call history report ID.
  • history_type (string)
    The history report type. The following values are possible: calls, transactions
  • created (string)
    The creation time in the UTC timezone in format: YYYY-MM-DD HH:mm:SS
  • format (string) optional
    The report format type. The following values are possible: csv
  • completed (string) optional
    The UTC completion time in format: YYYY-MM-DD HH:mm:SS. The report is completed if the field exists.
  • file_name (string) optional
    The report file name.
  • file_size (number) optional
    The report file size.
  • download_size (number) optional
    The gzipped report size to download.
  • download_count (number) optional
    The download attempt count.
  • last_downloaded (string) optional
    The last download UTC time in format: YYYY-MM-DD HH:mm:SS. The report is completed if the field exists.
  • store_until (string) optional
    Store the report until the UTC time in format: YYYY-MM-DD HH:mm:SS. The report is completed if the field exists.
  • session_count (number) optional
    The session count in the report.
  • total_session_count (number) optional
    The total found filtered session count.
  • error (API_Error) optional
    The report error.
  • filters (Object) optional
    The report order filters (the saved GetCallHistory, GetTransactionHistory parameters).
  • calculated_data (Object) optional
    The calculated report data (the specific report data, see CalculatedCallHistoryDataType, CalculatedTransactionHistoryDataType).

JSFailCallback

The specific account callback details.

MinBalanceCallback

The specific account callback details.
  • is_min_credit (boolean)
    True if the credit threshold exceeded. The credit threshold = credit_limit - min_balance_to_notify, wherein min_balance_to_notify > 0.

NewAttachedPhoneInfoType

The AttachPhoneNumber function result.
  • phone_id (number)
    The phone ID.
  • phone_number (string)
    The phone number.
  • required_verification (string) optional
    The required account verification name.
  • verification_status (string) optional
    The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  • unverified_hold_until (string) optional
    Unverified phone hold until the date in format: YYYY-MM-DD (if the account verification is required). The number will be detached on that day automatically!

NewPhoneInfoType

The GetNewPhoneNumbers function result item.
  • phone_id (number)
    The phone ID.
  • phone_number (string)
    The phone number.
  • phone_price (number)
    The phone periodic price.
  • phone_installation_price (number)
    The phone installation price (without the first periodic price).
  • phone_country_code (string)
    The phone country code (2 symbols).
  • phone_period (string)
    The charge period in format: YYYY-MM-DD HH:mm:SS

PhoneNumberCountryCategoryInfoType

The 'phone_categories' element of the GetPhoneNumberCategories function result.
  • phone_category_name (string)
    The phone category name.
  • country_has_states (boolean)
    True if a country state is used to choose the phone with the category.

PhoneNumberCountryInfoType

The GetPhoneNumberCategories function result.
  • country_code (string)
    The country code.
  • phone_prefix (string)
    The country phone prefix.
  • can_list_phone_numbers (boolean)
    True if can list phone numbers.
  • phone_categories ([PhoneNumberCountryCategoryInfoType])
    The phone categories.

PhoneNumberCountryRegionInfoType

The GetPhoneNumberRegions function result.
  • phone_region_id (number)
    The region ID.
  • phone_region_name (string)
    The full region name.
  • phone_region_code (string)
    The region phone prefix.
  • phone_count (number)
    The phone number count in stock for the region.
  • verification_status (string) optional
    The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED
  • required_verification (string) optional
    The required account verification name.
  • phone_price (number)
    The phone periodic price.
  • phone_installation_price (number)
    The phone installation price (without the first periodic price).
  • phone_period (string)
    The charge period in format: YYYY-MM-DD HH:mm:SS
  • is_need_regulation_address (boolean) optional
    The flag of the need proof of address.
  • regulation_address_type (string) optional
    The type of regulation address. Available values: LOCAL, NATIONAL, WORLDWIDE.

PhoneNumberCountryStateInfoType

The GetPhoneNumberCountryStates function result.
  • country_state (string)
    The country state code.
  • country_state_name (string)
    The full country state name.

PriceGroup

The resource price group.
  • price_group_name (string)
    The price group name. Example: Russia Mobile
  • price_group_id (number)
    The price group ID.
  • price (number)
    The price for the 'num_resources_per_price' resource count.
  • num_resources_per_price (number)
    The resource count per price.
  • quantum (number)
    The resource rounding quantum.
  • params (ResourceParams)
    The available resource parameters.

PstnBlackListInfoType

The PSTN black list item info.
  • pstn_blacklist_id (number)
    The black list item ID.
  • pstn_blacklist_phone (string)
    The phone number.

PushCredentialInfo

The push credentials list item info.
  • push_credential_id (number)
    The push credential id
  • push_provider_id (number)
    The push provider id
  • push_provider_name (string)
    The push provider name. Available values: APPLE, APPLE_VOIP, GOOGLE
  • external_app_name (string)
    The push provider's application name.
  • cert_credential (CertCredentialType) optional
    Credentials for APPLE.
  • applications ([ApplicationInfoType]) optional
    Bound applications.

QueueInfoType

The GetQueues function result.
  • acd_queue_id (number)
    The ACD queue ID.
  • acd_queue_name (string)
    The ACD queue name.
  • application_id (number)
    The application ID.
  • acd_queue_priority (number)
    The ACD queue priority. The highest priority is 0.
  • service_probability (number)
    The service probability. The value in range [0.5 ... 1]. The value 1.0 means the service probability 100% in challenge with a lower priority queue.
  • auto_binding (boolean)
    Is auto operators binding enable to the queue?
  • max_queue_size (number) optional
    The max queue size.
  • max_waiting_time (number) optional
    The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time.
  • average_service_time (number) optional
    The average service time in seconds. The parameter corrects the waiting time prediction.
  • skills ([SkillInfoType]) optional
    The bound skills.
  • modified (string)
    The queue editing UTC date in format: YYYY-MM-DD HH:mm:SS

RecordType

The record info.
  • record_id (number)
    The record ID.
  • record_name (string) optional
    The record name.
  • cost (number) optional
    The record cost.
  • start_time (string)
    The start recording time in the selected timezone in format: YYYY-MM-DD HH:mm:SS
  • duration (number) optional
    The call duration in seconds.
  • record_url (string) optional
    The record URL.
  • transaction_id (number)
    The transaction ID.
  • file_size (number) optional
    The file size.
  • transcription_url (string) optional
    The url of transcription.
  • transcription_status (string) optional
    The status of transcription. Availible values: Not required, In progress, Complete

RegulationAddress

The RegulationAddress record
  • regulation_address_id (number)
    The regulation address ID.
  • external_id (string)
    The external ID.
  • country_code (string)
    The country code.
  • phone_category_name (string)
    The phone category name.
  • salutation (string)
    The salutation. Possible values: MR, MS, COMPANY.
  • company (string) optional
    The company name.
  • first_name (string) optional
    The first name.
  • last_name (string) optional
    The last name.
  • owner_country_code (string) optional
    The owner country code.
  • city (string)
    The city name.
  • zip_code (string)
    The zip code.
  • street (string)
    The zip code.
  • builder_number (string)
    The builder number.
  • builder_latter (string) optional
    The builder latter.
  • status (string) optional
    The status verification. Possible values: IN_PROGRESS, VERIFIED, DECLINED
  • reject_message (string) optional
    The reject message
  • phone_region_code (string) optional
    The phone region code.

RegulationAddressVerifiedCallback

The specific account callback details.
  • regulation_address_id (number)
    The uploaded document ID.
  • regulation_address_status (string)
    The document verification status. The following values are possible: ACCEPTED, REJECTED
  • uploaded (string)
    The UTC date of the document upload in format: YYYY-MM-DD hh::mm:ss
  • is_individual (boolean)
    Is individual, isn't legal entity?
  • comment (string) optional
    The reviewer's comment.
  • verification_name (string)
    The verification name (type).

RegulationCountry

The coutry record.
  • country_code (string)
    The country code A2
  • country_name (string)
    The country name

RegulationRegionRecord

The RegulationRegionRecord record
  • phone_region_id (integer)
    The regulation address ID.
  • phone_region_name (string)
    The region name
  • phone_region_code (string)
    The phone region code
  • is_need_regulation_address (boolean)
    The need to confirm the address
  • regulation_address_type (string)
    The regulation address type. Availible: LOCAL, NATIONAL, WORLDWIDE

RenewedSubscriptionsCallback

The specific account callback details.

RenewedSubscriptionsCallbackItem

The specific account callback details.
  • type (string)
    The subscription type, example: PHONE_NUM, SIP_REGISTRATION, TARIFF
  • name (string)
    The subscription description (details). Example: the subscribed phone number.
  • cost (number)
    The subscription cost.

ResetAccountPasswordRequestCallback

The specific account callback details.

ResourceParams

The available resource parameters.
  • allowed ([String])
    The allowed parameter prefixes. Example: 7495
  • forbidden ([String]) optional
    The forbidden parameter prefixes. Example: 7800
  • requested ([String]) optional
    The requested parameters. Example: 79263331122

ResourcePrice

The GetResourcePrice function result.
  • resource_type (string)
    The resource type name. Example: 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_groups ([PriceGroup])
    The price group array.

ResourceUsageType

The resource usage info.
  • resource_usage_id (number)
    The resource usage ID.
  • resource_type (string)
    The resource type.
  • cost (number) optional
    The call cost.
  • description (string) optional
    The description.
  • used_at (string)
    The start resource using time in the selected timezone in format: YYYY-MM-DD HH:mm:SS
  • transaction_id (number)
    The transaction ID.
  • resource_quantity (number) optional
    The resource quantity.
  • unit (string) optional
    The resource unit.
  • ref_call_id (number) optional
    The reference to call.

RuleInfoType

The GetRules function result item.
  • rule_id (number)
    The rule ID.
  • application_id (number)
    The application ID.
  • rule_name (string)
    The rule name.
  • rule_pattern (string)
    The rule pattern regex.
  • rule_pattern_exclude (string) optional
    The rule pattern exlude regex.
  • scenarios ([ScenarioInfoType])
    The binding scenarios.
  • modified (string)
    The rule editing UTC date in format: YYYY-MM-DD HH:mm:SS

ScenarioInfoType

The GetScenarios function result.
  • scenario_id (number)
    The scenario ID.
  • scenario_name (string)
    The scenario name.
  • scenario_script (string) optional
    The scenario text.
  • modified (string)
    The scenario editing UTC date in format: YYYY-MM-DD HH:mm:SS

ShortAccountInfoType

The short account info.
  • account_id (number)
    The account's ID.
  • frozen (boolean) optional
    The no money flag.
  • balance (number) optional
    The account's money.
  • tariff_id (number) optional
    The account's tariff ID.
  • tariff_name (string) optional
    The account's tariff name.
  • periodic_charge (string) optional
    The tariff interval, format: YYYY-MM-DD 00:00:00
  • next_charge (string) optional
    The next charge date, format: YYYY-MM-DD
  • currency (string) optional
    The currency code (USD, RUR, EUR, ...).

SIPRegistrationFailCallback

The specific account callback details.
  • sip_registration_id (number)
    The SIP registration ID.

SIPRegistrationType

Detailing SIP registration
  • sip_registration_id (number)
    The SIP registration ID.
  • user_id (number)
    The user ID.
  • application_id (number) optional
    The bound domain ID.
  • application_name (string) optional
    The bound application name.
  • rule_id (number) optional
    The bound rule ID.
  • rule_name (string) optional
    The bound rule name.
  • username (number)
    The user name from sip proxy.
  • proxy (number)
    The sip proxy.
  • last_updated (number)
    The last time updated.
  • auth_user (string) optional
    The SIP authentications user
  • outbound_proxy (number) optional
    The outbound proxy.
  • successful (number) optional
    The successful SIP registration.
  • status_code (number) optional
    The status code from SIP registration.
  • error_message (number) optional
    The error message from SIP registration.
  • deactivated (boolean)
    The subscription deactivation flag. The SIP registration is frozen if true.
  • next_subscription_renewal (string)
    The next subscription renewal date in format: YYYY-MM-DD
  • purchase_date (string)
    The purchase date in format: YYYY-MM-DD hh:mm:ss
  • subscription_price (string)
    The periodic subscription price.

SipWhiteListInfoType

The GetSipWhiteList function result item.
  • sip_whitelist_id (number)
    The SIP white list item ID.
  • sip_whitelist_network (string)
    The network address in format A.B.C.D/L

SkillInfoType

The GetSkills function result.
  • skill_id (number)
    The skill ID.
  • skill_name (string)
    The skill name.

StagnantAccountCallback

The specific account callback details.

SubscriptionIsDetachedCallback

The specific account callback details.

SubscriptionIsDetachedCallbackItem

The specific account callback details.
  • type (string)
    The subscription type, example: PHONE_NUM, SIP_REGISTRATION
  • name (string)
    The subscription description (details). Example: the subscribed phone number.

SubscriptionIsFrozenCallback

The specific account callback details.

SubscriptionIsFrozenCallbackItem

The specific account callback details.
  • type (string)
    The subscription type, example: PHONE_NUM, SIP_REGISTRATION
  • name (string)
    The subscription description (details). Example: the subscribed phone number.
  • cost (number)
    The subscription cost.

SubscriptionsToChargeType

The GetMoneyAmountToCharge function result field.
  • subscription_amount (number)
    The money amount to charge in the specified currency.
  • subscription_type (string)
    The subscription type, example: PHONE_NUM, SIP_REGISTRATION
  • subscription_description (string)
    The subscription description (details). Example: the subscribed phone number.
  • subscription_auto_charge (boolean)
    The auto charge flag.
  • subscription_next_renewal (string)
    The next renewal date, format: YYYY-MM-DD

SubscriptionTemplateType

The subscription template info.
  • subscription_template_id (number)
    The subscription template ID.
  • installation_price (number)
    The subscription installation price (without the first periodic price).
  • period (string)
    The charge period in format: YYYY-MM-DD HH:mm:SS. Example: 0-1-0 0:0:0 is 1 month.
  • subscription_template_type (string)
    The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION.
  • subscription_template_name (string)
    The subscription template name (example: SIP registration, Phone GB, Phone RU 495, ...).

TransactionHistoryReportCallback

The specific account callback details.
  • history_report_id (number)
    The history report ID.
  • success (boolean)
    Is success?
  • order_date (string)
    The UTC order date in format: YYYY-MM-DD hh::mm:ss

TransactionInfoType

The GetTransactionHistory function result item.
  • transaction_id (number)
    The transaction ID.
  • account_id (string)
    The account ID.
  • performed_at (string)
    The transaction date in the selected timezone in format YYYY-MM-DD HH:mm:SS
  • amount (number)
    The transaction amount, $.
  • currency (string)
    The amount currency (USD, RUR, EUR, ...).
  • transaction_type (string)
    The transaction type. The following values are possible: periodic_charge, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, robokassa_payment, gift, add_money, subscription_cancel, adjustment, wire_transfer, refund.
  • transaction_description (string) optional
    The transaction description.
  • payment_reference (string) optional
    The external payment reference. See TransferMoneyToChildAccount

UnchargedTariffCallback

The specific account callback details.

UnverifiedSubscriptionDetachedCallback

The specific account callback details.

UnverifiedSubscriptionDetachedCallbackItem

The specific account callback details.
  • type (string)
    The subscription type, example: PHONE_NUM, SIP_REGISTRATION
  • name (string)
    The subscription description (details). Example: the subscribed phone number.

UserInfoType

The GetUsers function result.
  • user_id (number)
    The user ID.
  • user_name (string)
    The user name.
  • user_display_name (string)
    The display user name.
  • user_active (boolean)
    The user active flag.
  • parent_accounting (boolean)
    Is the user use account money?
  • two_factor_auth_required (boolean)
    Is two factor authorization required?
  • mobile_phone (string) optional
    The user mobile phone.
  • balance (number)
    The user money.
  • user_custom_data (string) optional
    The custom data.
  • applications ([ApplicationInfoType]) optional
    The bound applications.
  • skills ([SkillInfoType]) optional
    The bound skills.
  • acd_queues ([ACDQueueOperatorInfoType]) optional
    The bound ACD queues.
  • modified (string)
    The user editing UTC date in format: YYYY-MM-DD HH:mm:SS

ZipCode

The ZipCode record.
  • city (string)
    The city name
  • zip_code (string)
    The zip code

Errors

  • 1
    Fatal error.
  • 2
    Internal error.
  • 4
    DB error.
  • 5
    Billing failed.
  • 6
    Can not generate the unique 'api_key'.
  • 9
    Activation mail error.
  • 10
    Can not generate the unique 'session_id'.
  • 12
    Invalid 'func_name' parameter.
  • 13
    The 'config' table error.
  • 14
    SMS gateway error.
  • 15
    Media server error.
  • 16
    Media balancer error.
  • 17
    Paypoint failed.
  • 18
    CallerID verification server error.
  • 19
    ACD failed.
  • 20
    Phone provider failed.
  • 21
    Call service failed.
  • 22
    Conference balancer error.
  • 23
    Conference server error.
  • 100
    Authorization failed.
  • 101
    Invalid arguments.
  • 102
    Missing 'cmd' parameter.
  • 103
    Unknown command.
  • 104
    Forbidden command.
  • 105
    The required output format type is not supported.
  • 106
    Account's name isn't unique.
  • 107
    Invalid application name.
  • 108
    Exceeded the application count limit per the account.
  • 109
    Exceeded the user count limit per the account.
  • 110
    Invalid tariff.
  • 111
    Invalid date format.
  • 112
    The password must be at least 6 characters long.
  • 113
    Account's name must be at least 5 and up to 20 characters long
  • 114
    Account's name should start with a letter and can contain latin characters, digits, hyphen
  • 115
    The 'account_id' parameter is invalid.
  • 116
    The 'application_id' parameter is invalid.
  • 117
    The 'user_id' parameter is invalid.
  • 118
    The user name isn't unique.
  • 121
    Invalid phone number.
  • 122
    The user name should start with a letter or digit and can contain latin characters, digits, hyphen and must be at least 5 characters long
  • 123
    Invalid date range.
  • 125
    Invalid money amount.
  • 127
    Insufficient money.
  • 128
    Account's e-mail isn't unique.
  • 129
    Application name isn't unique.
  • 130
    The script text is too long.
  • 131
    The account isn't activated.
  • 132
    The 'scenario_id' parameter is invalid.
  • 133
    The scenario name isn't unique.
  • 134
    Required parameter is empty.
  • 135
    Session timeout.
  • 136
    Invalid e-mail.
  • 137
    The account isn't logged.
  • 139
    Activation is over for the phone number.
  • 140
    Exceed the max SMS code entering attempts.
  • 141
    The 'sms_code' parameter is invalid.
  • 142
    Activation is not required.
  • 147
    The 'rule_id' parameter is invalid.
  • 148
    The 'rule_pattern' parameter is invalid.
  • 149
    The 'rule_pattern_exclude' parameter is invalid.
  • 150
    The 'call_session_history_id' parameter is invalid.
  • 151
    Rejected payment request.
  • 152
    No bank card.
  • 153
    The card payment amount must be greater than 10$
  • 154
    The 'min_balance' must be greater than 1 $
  • 155
    The 'card_overrun_value' must be greater than 10$
  • 156
    The 'rule_name' parameter is invalid.
  • 157
    The 'user_display_name' parameter is invalid.
  • 158
    The 'card_holder' parameter is invalid.
  • 159
    The 'acct' parameter is invalid.
  • 160
    The 'cvv' parameter is invalid.
  • 161
    The 'session_id' parameter is invalid.
  • 162
    try later...
  • 163
    The 'account_first_name' parameter length must be less than 50
  • 164
    The 'account_last_name' parameter length must be less than 50
  • 165
    Exceed the max SMS sending attempts.
  • 166
    Repeat SMS sending after 3 minutes
  • 167
    The 'activation_method' parameter is invalid.
  • 168
    The 'scenario_name' parameter is invalid.
  • 169
    The 'sip_whitelist_id' parameter is invalid.
  • 170
    The 'sip_whitelist_network' parameter is invalid.
  • 171
    The 'min_balance' must be less than 50 $
  • 172
    Exceeded the SIP white list network count limit per the account.
  • 173
    The account name is forbidden by the black list. Try another name.
  • 174
    The 'sms_message' parameter is invalid.
  • 175
    The 'rule_name' isn't unique.
  • 176
    pending...
  • 177
    The 'parent_account_id' parameter is invalid.
  • 178
    Invalid excluded application name.
  • 179
    The 'excluded_application_id' parameter is invalid.
  • 180
    The 'excluded_user_id' parameter is invalid.
  • 181
    The 'phone_id' parameter is invalid.
  • 182
    Occupied phone number.
  • 183
    The 'callerid_id' parameter is invalid.
  • 184
    The 'callerid_number' parameter is invalid.
  • 185
    Forbidden CallerID.
  • 186
    The 'verification_code' parameter is invalid.
  • 187
    Exceeded the unverified CallerID count limit per the account. Try to verify or delete some unverified CallerID.
  • 188
    The 'callerid_number' isn't unique.
  • 189
    The 'mobile_phone' parameter is invalid.
  • 190
    The 'to_number' parameter is invalid.
  • 191
    The 'from_number' parameter is invalid.
  • 192
    The 'sms_id' parameter is invalid.
  • 193
    The callerid number is forbidden.
  • 194
    The 'child_account_id' parameter is invalid.
  • 195
    Unsupported batch command.
  • 196
    Too many batch commands. The max command count is 100 per batch.
  • 197
    The 'transaction_id' parameter is invalid.
  • 198
    The 'child_account_name' parameter is invalid.
  • 199
    The 'child_account_email' parameter is invalid.
  • 200
    The 'new_child_account_name' parameter is invalid.
  • 201
    The 'new_child_account_email' parameter is invalid.
  • 202
    The 'language_code' parameter is invalid.
  • 203
    The 'mobile_phone' parameter is invalid.
  • 204
    The 'billing_address_country_code' parameter is invalid.
  • 205
    The 'billing_address_name' parameter length must be less than 200.
  • 206
    The 'billing_address_address' parameter length must be less than 512.
  • 207
    The 'billing_address_zip' parameter length must be less than 30.
  • 208
    The 'billing_address_phone' parameter length must be less than 30.
  • 209
    The 'transaction_type' parameter is invalid.
  • 210
    The 'currency' parameter is invalid.
  • 211
    The 'account_custom_data' parameter length must be less than 8192.
  • 212
    The 'user_custom_data' parameter length must be less than 8192.
  • 213
    The 'acd_queue_name' parameter length must be less than 100.
  • 214
    The 'service_probability' parameter value must be in range [0.5 ... 1].
  • 215
    The 'max_queue_size' parameter is invalid.
  • 216
    The 'max_waiting_time' parameter is invalid.
  • 217
    The 'average_service_time' parameter is invalid.
  • 218
    The 'acd_queue_id' parameter is invalid.
  • 219
    Queue's name isn't unique.
  • 220
    The 'skill_name' parameter length must be less than 512.
  • 221
    Skill's name isn't unique.
  • 222
    The 'skill_id' parameter is invalid.
  • 223
    The 'acd_queue_priority' parameter should be positive.
  • 224
    The 'excluded_skill_id' parameter is invalid.
  • 225
    The 'amount' parameter is invalid.
  • 226
    The payment amount is very low. The amount must be greater than 500 RUR.
  • 227
    The 'acd_status' parameter is invalid.
  • 228
    The 'aggregation' parameter is invalid.
  • 229
    The 'report' parameter is invalid.
  • 230
    Account password change is over. Try later.
  • 231
    No more attempts to enter code.
  • 232
    The 'code' parameter is invalid.
  • 233
    The 'date' parameter is invalid.
  • 234
    The 'account_transaction_description' parameter length must be less than 120.
  • 235
    The 'user_transaction_description' parameter length must be less than 120.
  • 236
    The 'parent_transaction_description' parameter length must be less than 120.
  • 237
    The 'child_transaction_description' parameter length must be less than 120.
  • 238
    The 'acceptable_waiting_time' list size must be less than 30.
  • 239
    The 'country_code' parameter is invalid.
  • 240
    The 'phone_category_name' parameter is invalid.
  • 241
    The 'phone_region_id' parameter is invalid.
  • 242
    The 'country_state' parameter is invalid.
  • 243
    The 'phone_count' parameter is invalid.
  • 244
    The 'subscription_template_id' parameter is invalid.
  • 245
    The 'subscription_template_name' parameter is invalid.
  • 246
    The 'subscription_template_type' parameter is invalid.
  • 247
    The 'prioriity' parameter is invaid.
  • 248
    The 'max_simultaneous' parameter is invalid.
  • 249
    The 'num_attempts' parameter is invalid.
  • 250
    Invalid CSV file.
  • 251
    Call service error
  • 252
    Error response from call service.
  • 253
    The 'name' parameter is invalid.
  • 254
    The 'group' parameter is invalid.
  • 255
    The 'list_id' parameter is invalid.
  • 256
    Not found parent account.
  • 257
    The 'reference_ip' parameter is invalid.
  • 258
    The 'to_phone_next_renewal' parameter is invalid.
  • 259
    The 'media_url' parameter is invalid.
  • 260
    Denied access to the media link.
  • 261
    The 'record_id' parameter is invalid.
  • 262
    The 'PaRes' parameter is invalid.
  • 263
    The 'MD' parameter is invalid.
  • 264
    The 'private' parameter is invalid.
  • 265
    The 'promo_code' parameter is invalid.
  • 266
    The promo code is expired.
  • 267
    The promo code has been already redeemed.
  • 268
    The second promo code activation is forbidden.
  • 269
    The 'conference_name' parameter is invalid.
  • 270
    The 'conference_name' parameter length must be less than 50.
  • 271
    The service level threshold count must be less than 5.
  • 272
    Exceeded the maximum possible number of sip registrations.
  • 273
    The 'username' parameter is invalid.
  • 274
    The 'proxy' parameter is invalid.
  • 275
    The 'registration_id' parameter is invalid.
  • 276
    Not found sip registration by id.
  • 277
    Sip registration already deleted.
  • 278
    The 'account_document' parameter is invalid.
  • 279
    Not found active sip registration by user.
  • 280
    Repeat an account document sending after 2 minutes.
  • 281
    Account verification required.
  • 282
    Account verification in progress.
  • 283
    The 'to_purchase_date' parameter is invalid.
  • 284
    The 'admin_user_id' parameter is invalid.
  • 285
    The 'required_admin_user_id' parameter is invalid.
  • 286
    The 'required_admin_user_name' parameter is invalid.
  • 287
    The admin user name length must be less than 50.
  • 288
    The 'admin_user_display_name' parameter length must be less than 255.
  • 289
    Exceeded the admin user count limit per the account.
  • 290
    The admin_user_name isn't unique.
  • 291
    The 'admin_role_id' parameter is invalid.
  • 292
    The 'admin_role_name' parameter is invalid.
  • 293
    The admin role name length must be less than 160.
  • 294
    The admin_role_name isn't unique.
  • 295
    Exceeded the admin role count limit per the account.
  • 296
    The 'allowed_entries' parameter is invalid.
  • 297
    The 'denied_entries' parameter is invalid.
  • 298
    The 'included_admin_user_id' parameter is invalid.
  • 299
    The 'excluded_admin_user_id' parameter is invalid.
  • 300
    The 'like_admin_role_id' parameter is invalid.
  • 301
    The 'included_admin_role_id' parameter is invalid.
  • 302
    The 'excluded_admin_role_id' parameter is invalid.
  • 303
    The 'payment_reference' parameter is ambiguous.
  • 304
    The 'payment_reference' parameter length must be less than 127.
  • 305
    The 'inn' parameter is invalid.
  • 306
    The 'kpp' parameter is invalid.
  • 307
    The 'company_name' parameter length must be less than 512.
  • 308
    The 'company_address' parameter length must be less than 512.
  • 309
    The 'company_phone' parameter length must be less than 20.
  • 310
    Forbidden to edit the contractor. Please send an email to the VoxImplant team instead.
  • 311
    Please set the contractor info first.
  • 312
    The 'old_invoice_number' parameter is invalid.
  • 313
    The 'amount' parameter is invalid.
  • 314
    Concurrent resource limit exceeded.
  • 315
    The requested resource parameter is invalid.
  • 316
    The requested resource parameter is forbidden.
  • 317
    Upgrade to a paid account to use the requested resource parameter.
  • 318
    The money amount must be greater than N RUR.
  • 319
    The 'old_invoice_number' parameter is invalid.
  • 320
    The 'authorized_ip' parameter is invalid.
  • 321
    The authorized IP not found.
  • 322
    The 'contains_ip' parameter is invalid.
  • 323
    Exceeded the authorized IP count limit per the account.
  • 324
    The 'verification_name' parameter is invalid.
  • 325
    The 'to_unverified_hold_until' parameter is invalid.
  • 326
    The 'verification_status' parameter is invalid.
  • 327
    Error parsing XLS file.
  • 329
    The 'im_roster_type' parameter is invalid.
  • 330
    Occupied subscription.
  • 331
    No phones in the stock.
  • 332
    Insufficient phones in the stock, available %1$s
  • 333
    Not found country by code 'UA'
  • 334
    Not found country's region by code
  • 335
    Phone number already exists
  • 336
    Ambiguous region
  • 337
    Not found user documents
  • 338
    Verification user's document already complete
  • 339
    User documents not exists
  • 340
    Rate limit exceed.
  • 341
    Not found record by id
  • 342
    The 'queue_id' parameter is invalid.
  • 343
    The 'individual_full_name' parameter is invalid.
  • 344
    The 'individual_birth_date' parameter is invalid.
  • 345
    The 'individual_passport_series' parameter is invalid.
  • 346
    The 'individual_passport_number' parameter is invalid.
  • 347
    The 'individual_passport_issue_date' parameter is invalid.
  • 348
    The 'individual_passport_issued_by' parameter is invalid.
  • 349
    The 'individual_registration_address' parameter is invalid.
  • 350
    The 'legal_entry_full_name' parameter is invalid.
  • 351
    The 'legal_entry_phone' parameter is invalid.
  • 352
    The 'legal_entry_address' parameter is invalid.
  • 353
    The 'legal_entry_actual_address' parameter is invalid.
  • 354
    The 'ogrn' parameter is invalid.
  • 355
    The 'call_history_report_id' parameter is invalid.
  • 356
    The call history report isn't ready.
  • 357
    The call history report generating failed.
  • 358
    Invalid verification type
  • 359
    Invalid salutation
  • 360
    Not found voxbone verification type
  • 361
    Not found proof of address
  • 362
    The 'new_admin_user_name' parameter is invalid.
  • 363
    The 'code' parameter (access token) is invalid.
  • 364
    The current account password is missing.
  • 365
    Not found purchase info.
  • 366
    Pending address validation.
  • 367
    The 'callback_type' parameter is invalid.
  • 368
    Phone provider error: %1$s
  • 369
    Incorrect parameter 'phone_owner_region_code'
  • 370
    Incorrect parameter 'phone_owner_region_code' or 'phone_owner_zip_code'
  • 371
    The 'history_type' parameter is invalid.
  • 372
    The 'pstn_blacklist_phone' parameter is invalid
  • 373
    Exceeded the PSTN blacklist phones count limit per the account.
  • 374
    The 'carrier_id' parameter is invalid.
  • 378
    The 'push_id' parameter is invalid.
  • 380
    The push provider is invalid.