{"openapi":"3.1.0","info":{"title":"Reference","version":"1.0.0"},"paths":{"/GetAccountInfo":{"post":{"operationId":"accounts_GetAccountInfo","summary":"GetAccountInfo","description":"Gets the account's info such as account_id, account_name, account_email etc.\n\n**Example request:** Get the account's info.","tags":["Accounts"],"parameters":[{"name":"return_live_balance","in":"query","description":"Whether to get the account's live balance","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetAccountInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetAccountInfo":{"post":{"operationId":"accounts_SetAccountInfo","summary":"SetAccountInfo","description":"Edits the account's profile.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Accountant`, `Payer`.\n\n**Example request:** Change the account's password.","tags":["Accounts"],"parameters":[{"name":"new_account_email","in":"query","description":"The new account email","required":false,"schema":{"type":"string"}},{"name":"new_account_password","in":"query","description":"The new account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":false,"schema":{"type":"string"}},{"name":"language_code","in":"query","description":"The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)","required":false,"schema":{"type":"string"}},{"name":"location","in":"query","description":"The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10","required":false,"schema":{"type":"string"}},{"name":"account_first_name","in":"query","description":"The first name","required":false,"schema":{"type":"string"}},{"name":"account_last_name","in":"query","description":"The last name","required":false,"schema":{"type":"string"}},{"name":"min_balance_to_notify","in":"query","description":"The min balance value to notify by email or SMS","required":false,"schema":{"type":"number","format":"double"}},{"name":"account_notifications","in":"query","description":"Whether Voximplant notifications are required","required":false,"schema":{"type":"boolean"}},{"name":"tariff_changing_notifications","in":"query","description":"Whether to receive the emails about the Voximplant plan changing","required":false,"schema":{"type":"boolean"}},{"name":"news_notifications","in":"query","description":"Whether to receive the emails about the Voximplant news","required":false,"schema":{"type":"boolean"}},{"name":"send_js_error","in":"query","description":"Whether to receive the emails about a JS scenario error","required":false,"schema":{"type":"boolean"}},{"name":"billing_address_name","in":"query","description":"The company or businessman name","required":false,"schema":{"type":"string"}},{"name":"billing_address_country_code","in":"query","description":"The billing address country code (2 symbols, ISO 3166-1 alpha-2). The following values are available: AF (Afghanistan), AL (Albania), DZ (Algeria), AS (American Samoa), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua and Barbuda), AR (Argentina), AM (Armenia), AW (Aruba), AU (Australia), AT (Austria), AZ (Azerbaijan), BH (Bahrain), BD (Bangladesh), BB (Barbados), BY (Belarus), BE (Belgium), BZ (Belize), BJ (Benin), BM (Bermuda), BT (Bhutan), BO (Bolivia), BA (Bosnia and Herzegovina), BW (Botswana), BV (Bouvet Island), BR (Brazil), IO (British Indian Ocean Territory), BN (Brunei), BG (Bulgaria), BF (Burkina Faso), BI (Burundi), KH (Cambodia), CM (Cameroon), CA (Canada), CV (Cape Verde), KY (Cayman Islands), CF (Central African Republic), TD (Chad), CL (Chile), CN (China), CX (Christmas Island), CO (Colombia), KM (Comoros), CG (Congo), CK (Cook Islands), CR (Costa Rica), HR (Croatia), CU (Cuba), CY (Cyprus), CZ (Czech Republic), DK (Denmark), DJ (Djibouti), DM (Dominica), DO (Dominican Republic), EC (Ecuador), EG (Egypt), SV (El Salvador), GQ (Equatorial Guinea), ER (Eritrea), EE (Estonia), ET (Ethiopia), FO (Faroe Islands), FJ (Fiji Islands), FI (Finland), FR (France), GF (French Guiana), PF (French Polynesia), TF (French Southern and Antarctic Lands), GA (Gabon), GE (Georgia), DE (Germany), GH (Ghana), GI (Gibraltar), GR (Greece), GL (Greenland), GD (Grenada), GP (Guadeloupe), GU (Guam), GT (Guatemala), GG (Guernsey), GN (Guinea), GY (Guyana), HT (Haiti), HM (Heard Island and McDonald Islands), HN (Honduras), HU (Hungary), IS (Iceland), IN (India), ID (Indonesia), IR (Iran), IQ (Iraq), IE (Ireland), IL (Israel), IT (Italy), JM (Jamaica), JP (Japan), JE (Jersey), JO (Jordan), KZ (Kazakhstan), KE (Kenya), KI (Kiribati), KR (Korea), KW (Kuwait), KG (Kyrgyzstan), LA (Laos), LV (Latvia), LB (Lebanon), LS (Lesotho), LR (Liberia), LY (Libya), LI (Liechtenstein), LT (Lithuania), LU (Luxembourg), MG (Madagascar), MW (Malawi), MY (Malaysia), MV (Maldives), ML (Mali), MT (Malta), MH (Marshall Islands), MQ (Martinique), MR (Mauritania), MU (Mauritius), YT (Mayotte), MX (Mexico), FM (Micronesia), MD (Moldova), MC (Monaco), MN (Mongolia), ME (Montenegro), MS (Montserrat), MA (Morocco), MZ (Mozambique), MM (Myanmar), NA (Namibia), NR (Nauru), NP (Nepal), NL (Netherlands), AN (Netherlands Antilles), NC (New Caledonia), NZ (New Zealand), NI (Nicaragua), NE (Niger), NG (Nigeria), NU (Niue), NF (Norfolk Island), KP (North Korea), MP (Northern Mariana Islands), NO (Norway), OM (Oman), PK (Pakistan), PW (Palau), PS (Palestinian Authority), PA (Panama), PG (Papua New Guinea), PY (Paraguay), PE (Peru), PH (Philippines), PN (Pitcairn Islands), PL (Poland), PT (Portugal), PR (Puerto Rico), QA (Qatar), RE (Reunion), RO (Romania), RU (Russia), RW (Rwanda), WS (Samoa), SM (San Marino), SA (Saudi Arabia), SN (Senegal), RS (Serbia), SC (Seychelles), SL (Sierra Leone), SG (Singapore), SK (Slovakia), SI (Slovenia), SB (Solomon Islands), SO (Somalia), ZA (South Africa), GS (South Georgia and the South Sandwich Islands), ES (Spain), LK (Sri Lanka), SD (Sudan), SR (Suriname), SZ (Swaziland), SE (Sweden), CH (Switzerland), SY (Syria), ST (Sao Tome and Principe), TW (Taiwan), TJ (Tajikistan), TZ (Tanzania), TH (Thailand), TG (Togo), TK (Tokelau), TO (Tonga), TT (Trinidad and Tobago), TN (Tunisia), TR (Turkey), TM (Turkmenistan), TC (Turks and Caicos Islands), TV (Tuvalu), UG (Uganda), UA (Ukraine), AE (United Arab Emirates), GB (United Kingdom), US (United States), UY (Uruguay), UZ (Uzbekistan), VU (Vanuatu), VA (Vatican City), VE (Venezuela), VN (Vietnam), VI (Virgin Islands), WF (Wallis and Futuna), EH (Western Sahara), YE (Yemen), ZM (Zambia), ZW (Zimbabwe), AX (Aland Islands)","required":false,"schema":{"type":"string"}},{"name":"billing_address_address","in":"query","description":"The valid address that needs to be specified to pay for any services. You cannot delete it later, only change","required":false,"schema":{"type":"string"}},{"name":"billing_address_zip","in":"query","description":"The office ZIP","required":false,"schema":{"type":"string"}},{"name":"billing_address_phone","in":"query","description":"The office phone number","required":false,"schema":{"type":"string"}},{"name":"account_custom_data","in":"query","description":"The custom data","required":false,"schema":{"type":"string"}},{"name":"callback_url","in":"query","description":"If URL is specified, Voximplant cloud makes HTTP POST requests to it when something happens. For a full list of reasons see the **type** field of the [AccountCallback] structure. The HTTP request has a JSON-encoded body that conforms to the [AccountCallbacks] structure","required":false,"schema":{"type":"string"}},{"name":"callback_salt","in":"query","description":"If salt string is specified, each HTTP request made by the Voximplant cloud toward the **callback_url** has a **salt** field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud","required":false,"schema":{"type":"string"}},{"name":"store_outbound_sms","in":"query","description":"Whether to store outgoing message texts. Default value is false","required":false,"schema":{"type":"boolean"}},{"name":"store_inbound_sms","in":"query","description":"Whether to store incoming message texts. Default value is false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_SetAccountInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetChildAccountInfo":{"post":{"operationId":"accounts_SetChildAccountInfo","summary":"SetChildAccountInfo","description":"Edits the account's profile.\n\n**Example request:** Disable the child account.","tags":["Accounts"],"parameters":[{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts. **Required** unless **child_account_name** or **child_account_email** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"child_account_name","in":"query","description":"The child account name list separated by semicolons (;). **Required** unless **child_account_id** or **child_account_email** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"child_account_email","in":"query","description":"The child account email list separated by semicolons (;). **Required** unless **child_account_id** or **child_account_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"new_child_account_email","in":"query","description":"The new child account email","required":false,"schema":{"type":"string"}},{"name":"new_child_account_password","in":"query","description":"The new child account password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":false,"schema":{"type":"string"}},{"name":"account_notifications","in":"query","description":"Whether Voximplant notifications are required","required":false,"schema":{"type":"boolean"}},{"name":"tariff_changing_notifications","in":"query","description":"Whether to receive the emails about the Voximplant plan changing","required":false,"schema":{"type":"boolean"}},{"name":"news_notifications","in":"query","description":"Whether to receive the emails about the Voximplant news","required":false,"schema":{"type":"boolean"}},{"name":"active","in":"query","description":"Whether to enable the child account","required":false,"schema":{"type":"boolean"}},{"name":"language_code","in":"query","description":"The notification language code (2 symbols, ISO639-1). The following values are available: aa (Afar), ab (Abkhazian), af (Afrikaans), am (Amharic), ar (Arabic), as (Assamese), ay (Aymara), az (Azerbaijani), ba (Bashkir), be (Belarusian), bg (Bulgarian), bh (Bihari), bi (Bislama), bn (Bengali), bo (Tibetan), br (Breton), ca (Catalan), co (Corsican), cs (Czech), cy (Welch), da (Danish), de (German), dz (Bhutani), el (Greek), en (English), eo (Esperanto), es (Spanish), et (Estonian), eu (Basque), fa (Persian), fi (Finnish), fj (Fiji), fo (Faeroese), fr (French), fy (Frisian), ga (Irish), gd (Scots Gaelic), gl (Galician), gn (Guarani), gu (Gujarati), ha (Hausa), hi (Hindi), he (Hebrew), hr (Croatian), hu (Hungarian), hy (Armenian), ia (Interlingua), id (Indonesian), ie (Interlingue), ik (Inupiak), in (Indonesian), is (Icelandic), it (Italian), iu (Inuktitut), iw (Hebrew), ja (Japanese), ji (Yiddish), jw (Javanese), ka (Georgian), kk (Kazakh), kl (Greenlandic), km (Cambodian), kn (Kannada), ko (Korean), ks (Kashmiri), ku (Kurdish), ky (Kirghiz), la (Latin), ln (Lingala), lo (Laothian), lt (Lithuanian), lv (Latvian), mg (Malagasy), mi (Maori), mk (Macedonian), ml (Malayalam), mn (Mongolian), mo (Moldavian), mr (Marathi), ms (Malay), mt (Maltese), my (Burmese), na (Nauru), ne (Nepali), nl (Dutch), no (Norwegian), oc (Occitan), om (Oromo), or (Oriya), pa (Punjabi), pl (Polish), ps (Pashto), pt (Portuguese), qu (Quechua), rm (Rhaeto-Romance), rn (Kirundi), ro (Romanian), ru (Russian), rw (Kinyarwanda), sa (Sanskrit), sd (Sindhi), sg (Sangro), sh (Serbo-Croatian), si (Singhalese), sk (Slovak), sl (Slovenian), sm (Samoan), sn (Shona), so (Somali), sq (Albanian), sr (Serbian), ss (Siswati), st (Sesotho), su (Sudanese), sv (Swedish), sw (Swahili), ta (Tamil), te (Tegulu), tg (Tajik), th (Thai), ti (Tigrinya), tk (Turkmen), tl (Tagalog), tn (Setswana), to (Tonga), tr (Turkish), ts (Tsonga), tt (Tatar), tw (Twi), ug (Uigur), uk (Ukrainian), ur (Urdu), uz (Uzbek), vi (Vietnamese), vo (Volapuk), wo (Wolof), xh (Xhosa), yi (Yiddish), yo (Yoruba), za (Zhuang), zh (Chinese), zu (Zulu)","required":false,"schema":{"type":"string"}},{"name":"location","in":"query","description":"The child account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10","required":false,"schema":{"type":"string"}},{"name":"min_balance_to_notify","in":"query","description":"The min balance value to notify by email or SMS","required":false,"schema":{"type":"number","format":"double"}},{"name":"support_robokassa","in":"query","description":"Whether to allow the robokassa payments","required":false,"schema":{"type":"boolean"}},{"name":"support_bank_card","in":"query","description":"Whether to allow the bank card payments","required":false,"schema":{"type":"boolean"}},{"name":"support_invoice","in":"query","description":"Whether to allow the bank invoices","required":false,"schema":{"type":"boolean"}},{"name":"can_use_restricted","in":"query","description":"Whether to allow use restricted directions","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_SetChildAccountInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCurrencyRate":{"post":{"operationId":"accounts_GetCurrencyRate","summary":"GetCurrencyRate","description":"Gets the exchange rate on selected date (per USD).\n\n**Example request:** Get the current currency rate: RUR/USD.","tags":["Accounts"],"parameters":[{"name":"currency","in":"query","description":"The currency code list separated by semicolons (;). Examples: RUR, KZT, EUR, USD","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"date","in":"query","description":"The date, format: YYYY-MM-DD","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetCurrencyRate_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetResourcePrice":{"post":{"operationId":"accounts_GetResourcePrice","summary":"GetResourcePrice","description":"Gets the resource price.","tags":["Accounts"],"parameters":[{"name":"resource_type","in":"query","description":"The resource type list separated by semicolons (;). The possible values are: ","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"price_group_id","in":"query","description":"The price group ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"price_group_name","in":"query","description":"The price group name template to filter","required":false,"schema":{"type":"string","default":"all"}},{"name":"resource_param","in":"query","description":"The resource parameter list separated by semicolons (;). Example: a phone number list","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetResourcePrice_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSubscriptionPrice":{"post":{"operationId":"accounts_GetSubscriptionPrice","summary":"GetSubscriptionPrice","description":"Gets the subscription template price.\n\n**Example request:** Get the all subscription template prices.","tags":["Accounts"],"parameters":[{"name":"subscription_template_id","in":"query","description":"The subscription template ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"subscription_template_type","in":"query","description":"The subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION","required":false,"schema":{"type":"string"}},{"name":"subscription_template_name","in":"query","description":"The subscription template name (example: SIP registration, Phone GB, Phone RU 495...)","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetSubscriptionPrice_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetChildrenAccounts":{"post":{"operationId":"accounts_GetChildrenAccounts","summary":"GetChildrenAccounts","description":"Gets the info about all children accounts.\n\nAllowed roles: `Owner`.\n\n**Example request:** Get the specified children.","tags":["Accounts"],"parameters":[{"name":"child_account_id","in":"query","description":"The account ID list separated by semicolons (;). You need to specify at least one of the following parameters: `child_account_id`, `child_account_name`, `child_account_email`","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"child_account_name","in":"query","description":"The child account name to filter. You need to specify at least one of the following parameters: `child_account_id`, `child_account_name`, `child_account_email`","required":false,"schema":{"type":"string"}},{"name":"child_account_email","in":"query","description":"The child account email to filter. You need to specify at least one of the following parameters: `child_account_id`, `child_account_name`, `child_account_email`","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","description":"Whether the filter is active","required":false,"schema":{"type":"boolean"}},{"name":"frozen","in":"query","description":"Whether the filter is frozen","required":false,"schema":{"type":"boolean"}},{"name":"ignore_invalid_accounts","in":"query","description":"Whether to ignore the invalid 'child_account_id' items","required":false,"schema":{"type":"boolean","default":false}},{"name":"brief_output","in":"query","description":"Whether to output the account_id only","required":false,"schema":{"type":"boolean","default":false}},{"name":"medium_output","in":"query","description":"Whether to output the account_id, account_name, account_email only","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"order_by","in":"query","description":"The following values are available: 'child_account_id', 'child_account_name' and 'child_account_email'","required":false,"schema":{"type":"string","default":"child_account_name"}},{"name":"return_live_balance","in":"query","description":"Whether to get the user live balance","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetChildrenAccounts_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetMoneyAmountToCharge":{"post":{"operationId":"accounts_GetMoneyAmountToCharge","summary":"GetMoneyAmountToCharge","description":"Get the recommended money amount to charge.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Get the recommended money amount to charge in USD.","tags":["Accounts"],"parameters":[{"name":"currency","in":"query","description":"The currency name. Examples: USD, RUR, EUR","required":false,"schema":{"type":"string","default":"The account currency"}},{"name":"charge_date","in":"query","description":"The next charge date, format: YYYY-MM-DD","required":false,"schema":{"type":"string","default":"The current date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetMoneyAmountToCharge_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/ChangeAccountPlan":{"post":{"operationId":"accounts_ChangeAccountPlan","summary":"ChangeAccountPlan","description":"Configures the account's plan.\n\nPlease note that when you change the billing plan, we reserve the subscription fee and taxes for the upcoming month. Read more in the Billing page.\n\n**Example request:** Change the IM plan.","tags":["Accounts"],"parameters":[{"name":"plan_type","in":"query","description":"The plan type to config. The possible values are IM, MAU","required":true,"schema":{"type":"string"}},{"name":"plan_subscription_template_id","in":"query","description":"The new plan ID with a price larger than the current plan's (see [GetAvailablePlans])","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_ChangeAccountPlan_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAccountPlans":{"post":{"operationId":"accounts_GetAccountPlans","summary":"GetAccountPlans","description":"Gets the account plans with packages.\n\n**Example request:** Get all account plans with packages.","tags":["Accounts"],"parameters":[{"name":"plan_type","in":"query","description":"The plan type list separated by semicolons (;). The possible values are IM, MAU","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"plan_subscription_template_id","in":"query","description":"The plan ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetAccountPlans_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAvailablePlans":{"post":{"operationId":"accounts_GetAvailablePlans","summary":"GetAvailablePlans","description":"Gets the allowed plans to change.\n\n**Example request:** Get allowed IM plans to change.","tags":["Accounts"],"parameters":[{"name":"plan_type","in":"query","description":"The plan type list separated by semicolons (;). The possible values are IM, MAU","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"plan_subscription_template_id","in":"query","description":"The plan ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetAvailablePlans_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAccountDocuments":{"post":{"operationId":"accounts_GetAccountDocuments","summary":"GetAccountDocuments","description":"Gets the account documents and the verification states.\n\nThis method will be deprecated in the next versions. We recommend to use the [GetAccountVerifications](/api-reference/management-api/reference/accounts/get-account-verifications) method to get all the verifications and statuses for the account.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.","tags":["Accounts"],"parameters":[{"name":"with_details","in":"query","description":"Whether to view the uploaded document statuses. (The flag is ignored with the child_account_id=all)","required":false,"schema":{"type":"boolean","default":false}},{"name":"verification_name","in":"query","description":"The required account verification name to filter","required":false,"schema":{"type":"string"}},{"name":"verification_status","in":"query","description":"The account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_unverified_hold_until","in":"query","description":"Unverified subscriptions hold until the date (from ...) in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"to_unverified_hold_until","in":"query","description":"Unverified subscriptions hold until the date (... to) in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_verifications_only","in":"query","description":"Whether to get the children account verifications only","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetAccountDocuments_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAccountVerifications":{"post":{"operationId":"accounts_GetAccountVerifications","summary":"GetAccountVerifications","description":"Gets all RU verifications for the specified account.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.","tags":["Accounts"],"parameters":[{"name":"account_id","in":"query","description":"Account ID to check verifications for","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accounts_GetAccountVerifications_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddApplication":{"post":{"operationId":"applications_AddApplication","summary":"AddApplication","description":"Adds a new account's application.\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Add a new application.","tags":["Applications"],"parameters":[{"name":"application_name","in":"query","description":"Short application name in the \\[a-z\\]\\[a-z0-9-\\]{1,64} format","required":true,"schema":{"type":"string"}},{"name":"secure_record_storage","in":"query","description":"Whether to enable secure storage for all logs and records of the application","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/applications_AddApplication_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelApplication":{"post":{"operationId":"applications_DelApplication","summary":"DelApplication","description":"Deletes the account's application.\n\nAllowed roles: `Owner`.\n\n**Example request:** Delete the application 1 and 3.","tags":["Applications"],"parameters":[{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;). Use the 'all' value to select all applications. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_name","in":"query","description":"The application name list separated by semicolons (;). **Required** unless **application_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/applications_DelApplication_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetApplicationInfo":{"post":{"operationId":"applications_SetApplicationInfo","summary":"SetApplicationInfo","description":"Edits the account's application.\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Change the application name.","tags":["Applications"],"parameters":[{"name":"application_id","in":"query","description":"The application ID. **Required** unless **required_application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"required_application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"application_name","in":"query","description":"The new short application name in format [a-z][a-z0-9-]{1,79}","required":false,"schema":{"type":"string"}},{"name":"secure_record_storage","in":"query","description":"Whether to enable secure storage for all logs and records of the application","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/applications_SetApplicationInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetApplications":{"post":{"operationId":"applications_GetApplications","summary":"GetApplications","description":"Gets the account's applications.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Call list manager`, `User manager`, `Accountant`, `Support`.\n\n**Example request:** Get two applications, but skip the first one.","tags":["Applications"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to filter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name part to filter","required":false,"schema":{"type":"string"}},{"name":"with_rules","in":"query","description":"Whether to get bound rules info","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_scenarios","in":"query","description":"Whether to get bound rules and scenarios info","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/applications_GetApplications_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddUser":{"post":{"operationId":"users_AddUser","summary":"AddUser","description":"Adds a new user.\n\nAllowed roles: `Owner`, `Admin`, `User manager`.\n\n**Example request:** Add a new user.","tags":["Users"],"parameters":[{"name":"user_name","in":"query","description":"The user name in format [a-z0-9][a-z0-9_-]{2,49}","required":true,"schema":{"type":"string"}},{"name":"user_display_name","in":"query","description":"The user display name. The length must be less than 256","required":true,"schema":{"type":"string"}},{"name":"user_password","in":"query","description":"The user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID which a new user is to be bound to. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name which a new user is to be bound to. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"parent_accounting","in":"query","description":"Whether the user uses the parent account's money, 'false' if the user has a separate balance","required":false,"schema":{"type":"boolean"}},{"name":"user_active","in":"query","description":"Whether the user is active. Inactive users cannot log in to applications","required":false,"schema":{"type":"boolean","default":true}},{"name":"user_custom_data","in":"query","description":"Any string","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_AddUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelUser":{"post":{"operationId":"users_DelUser","summary":"DelUser","description":"Deletes the specified user(s).\n\nAllowed roles: `Owner`, `Admin`, `User manager`.\n\n**Example request:** Delete two users with ID 3 and 55.","tags":["Users"],"parameters":[{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;). Use the 'all' value to select all users. **Required** unless **user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). **Required** unless **user_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application_id","in":"query","description":"Delete the specified users bound to the application ID. It is required if the **user_name** is specified","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Delete the specified users bound to the application name. Can be used instead of the **application_id** parameter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_DelUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetUserInfo":{"post":{"operationId":"users_SetUserInfo","summary":"SetUserInfo","description":"Edits the user.\n\nAllowed roles: `Owner`, `Admin`, `User manager`.\n\n**Example request:** Edit the user password.","tags":["Users"],"parameters":[{"name":"user_id","in":"query","description":"The user to edit. **Required** unless **user_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name. **Required** unless **user_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID. It is required if the **user_name** is specified","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"new_user_name","in":"query","description":"The new user name in format [a-z0-9][a-z0-9_-]{2,49}","required":false,"schema":{"type":"string"}},{"name":"user_display_name","in":"query","description":"The new user display name. The length must be less than 256","required":false,"schema":{"type":"string"}},{"name":"user_password","in":"query","description":"The new user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":false,"schema":{"type":"string"}},{"name":"parent_accounting","in":"query","description":"Whether to use the parent account's money, 'false' to use a separate user balance","required":false,"schema":{"type":"boolean"}},{"name":"user_active","in":"query","description":"Whether the user is active. Inactive users cannot log in to applications","required":false,"schema":{"type":"boolean","default":true}},{"name":"user_custom_data","in":"query","description":"Any string","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_SetUserInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetUsers":{"post":{"operationId":"users_GetUsers","summary":"GetUsers","description":"Shows the users of the specified account.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get two first identities.","tags":["Users"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to filter","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name part to filter","required":true,"schema":{"type":"string"}},{"name":"skill_id","in":"query","description":"The skill ID to filter","required":false,"schema":{"type":"integer"}},{"name":"excluded_skill_id","in":"query","description":"The excluded skill ID to filter","required":false,"schema":{"type":"integer"}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID to filter","required":false,"schema":{"type":"integer"}},{"name":"excluded_acd_queue_id","in":"query","description":"The excluded ACD queue ID to filter","required":false,"schema":{"type":"integer"}},{"name":"user_id","in":"query","description":"The user ID to filter","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name part to filter","required":false,"schema":{"type":"string"}},{"name":"user_active","in":"query","description":"Whether the user is active to filter. Inactive users cannot log in to applications","required":false,"schema":{"type":"boolean"}},{"name":"user_display_name","in":"query","description":"The user display name part to filter","required":false,"schema":{"type":"string"}},{"name":"with_skills","in":"query","description":"Whether to get the bound skills","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_queues","in":"query","description":"Whether to get the bound queues","required":false,"schema":{"type":"boolean","default":false}},{"name":"acd_status","in":"query","description":"The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"showing_skill_id","in":"query","description":"The skill to show in the 'skills' field output","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"order_by","in":"query","description":"The following values are available: 'user_id', 'user_name' and 'user_display_name'","required":false,"schema":{"type":"string","default":"user_name"}},{"name":"return_live_balance","in":"query","description":"Whether to get the user live balance","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_GetUsers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/CreateCallList":{"post":{"operationId":"callLists_CreateCallList","summary":"CreateCallList","description":"Adds a new CSV file for call list processing and starts the specified rule immediately. To send a file, use the request body. To set the call time constraints, use the following options in a CSV file: \n\nThis method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the **delimiter** parameter.\n\n**IMPORTANT:** the account's balance should be equal or greater than 1 USD. If the balance is lower than 1 USD, the call list processing does not start, or it stops immediately if it is active.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"rule_id","in":"query","description":"Rule ID. It is specified in the Applications section of the Control Panel","required":true,"schema":{"type":"integer"}},{"name":"priority","in":"query","description":"Call list priority. The value is in the range of [0 ... 2^31] where zero is the highest priority","required":true,"schema":{"type":"integer"}},{"name":"max_simultaneous","in":"query","description":"Number of simultaneously processed tasks","required":true,"schema":{"type":"integer"}},{"name":"num_attempts","in":"query","description":"Number of attempts. Minimum is **1**, maximum is **5**","required":true,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"File name, up to 255 characters and cannot contain the '/' and '\\' symbols","required":true,"schema":{"type":"string"}},{"name":"interval_seconds","in":"query","description":"Interval between call attempts in seconds. The default value is 0","required":false,"schema":{"type":"integer"}},{"name":"encoding","in":"query","description":"Encoding file. The default value is UTF-8","required":false,"schema":{"type":"string"}},{"name":"delimiter","in":"query","description":"Separator values. The default value is ';'","required":false,"schema":{"type":"string"}},{"name":"escape","in":"query","description":"Escape character for parsing csv","required":false,"schema":{"type":"string"}},{"name":"reference_ip","in":"query","description":"IP from the geolocation of the call list subscribers. It allows selecting the nearest server for serving subscribers","required":false,"schema":{"type":"string"}},{"name":"server_location","in":"query","description":"Location of the server where the scenario needs to be executed. Has higher priority than `reference_ip`. Request [getServerLocations](https://api.voximplant.com/getServerLocations) for possible values","required":false,"schema":{"type":"string"}},{"name":"task_priority_strategy","in":"query","description":"Optional. Whether to prioritize first calling attempts or repeated ones. The possible values are: first_attempts, repeated_attempts. The default values is first_attempts.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_CreateCallList_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file_content":{"type":"string","format":"binary","description":"Send as the \"body\" part of the HTTP request or as multiform. The sending \"file_content\" via URL is at its own risk because the network devices tend to drop HTTP requests with large headers"}},"required":["file_content"]}}}},"security":[{"JwtAuth":[]}]}},"/AppendToCallList":{"post":{"operationId":"callLists_AppendToCallList","summary":"AppendToCallList","description":"Appends a new task to the existing call list.\n\nThis method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the **delimiter** parameter.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"Call list ID. **Required** unless **list_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"encoding","in":"query","description":"Encoding file. The default value is UTF-8","required":false,"schema":{"type":"string"}},{"name":"escape","in":"query","description":"Escape character for parsing csv","required":false,"schema":{"type":"string"}},{"name":"delimiter","in":"query","description":"Separator values. The default value is ';'","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_AppendToCallList_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file_content":{"type":"string","format":"binary","description":"Send as the request body or multiform"}},"required":["file_content"]}}}},"security":[{"JwtAuth":[]}]}},"/CancelCallListBatch":{"post":{"operationId":"callLists_CancelCallListBatch","summary":"CancelCallListBatch","description":"Cancels all tasks in the call list with the specified batch UUID.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"Call list ID. **Required** unless **list_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"batch_ids","in":"query","description":"Batch UUIDs of the tasks to cancel, separated by semicolon (;)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_CancelCallListBatch_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/EditCallList":{"post":{"operationId":"callLists_EditCallList","summary":"EditCallList","description":"Edits the specified call list by its ID.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"Call list ID. If the ID is non existing, the 251 error returns","required":true,"schema":{"type":"integer"}},{"name":"interval_seconds","in":"query","description":"Minimum interval between call attempts. Cannot be a negative value","required":false,"schema":{"type":"integer"}},{"name":"num_attempts","in":"query","description":"Maximum call attempt number. Cannot be less than 1","required":false,"schema":{"type":"integer"}},{"name":"max_simultaneous","in":"query","description":"Maximum simultaneous call attempts for this call list. Cannot be less than 1","required":false,"schema":{"type":"integer"}},{"name":"ip_address","in":"query","description":"IP address in the `Inet4Address` format","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Call list name. Cannot be bigger than 255 characters, cannot contain slash symbol","required":false,"schema":{"type":"string"}},{"name":"priority","in":"query","description":"Call list's priority among other call list. The lower the value, the higher is the call list's priority","required":false,"schema":{"type":"integer"}},{"name":"start_at","in":"query","description":"Time when the call list should start in the `yyyy-MM-dd HH:mm:ss` format","required":false,"schema":{"type":"string"}},{"name":"task_priority_strategy","in":"query","description":"Optional. Whether to prioritize first calling attempts or repeated ones. The possible values are: first_attempts, repeated_attempts. The default values is first_attempts","required":false,"schema":{"type":"string"}},{"name":"server_location","in":"query","description":"Location of the server processing the call list. If the ID is non existing, the 496 error returns: The 'server_location' parameter is invalid.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_EditCallList_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/EditCallListTasksPriority":{"post":{"operationId":"callLists_EditCallListTasksPriority","summary":"EditCallListTasksPriority","description":"Edits priorities of existing tasks in the specified call list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"Call list ID. If the ID does not exist, the 251 error returns.","required":true,"schema":{"type":"integer"}},{"name":"tasks","in":"query","description":"JSON-encoded array of task objects. Each object should contain either 'task_id' (number) or 'task_uuid' (string), and 'task_priority' (number).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_EditCallListTasksPriority_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeleteCallList":{"post":{"operationId":"callLists_DeleteCallList","summary":"DeleteCallList","description":"Deletes an existing call list by its ID.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"account_id","in":"query","description":"Account's ID","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_DeleteCallList_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCallLists":{"post":{"operationId":"callLists_GetCallLists","summary":"GetCallLists","description":"Get all call lists for the specified user.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Call list manager`, `Support`.\n\n**Example request:** Get all lists registered by user.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"The list ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all lists","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"name","in":"query","description":"Find call lists by name","required":false,"schema":{"type":"string"}},{"name":"is_active","in":"query","description":"Whether to find only active call lists","required":false,"schema":{"type":"boolean"}},{"name":"from_date","in":"query","description":"The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"type_list","in":"query","description":"The type of the call list. The possible values are AUTOMATIC and MANUAL","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all applications","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_GetCallLists_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCallListDetails":{"post":{"operationId":"callLists_GetCallListDetails","summary":"GetCallListDetails","description":"Gets details of the specified call list. Returns a CSV file by default.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`, `sys.Admin read only`.\n\n**Example request:** Get all lists registered by user.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"The list ID","required":true,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"Maximum number of entries in the result","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"output","in":"query","description":"The output format. The following values available: **json**, **csv**, **xls**. The default value is **csv**","required":false,"schema":{"type":"string","default":"csv"}},{"name":"encoding","in":"query","description":"Encoding of the output file. Default UTF-8","required":false,"schema":{"type":"string"}},{"name":"delimiter","in":"query","description":"Separator values. The default value is ';'","required":false,"schema":{"type":"string"}},{"name":"batch_id","in":"query","description":"Batch UUID to filter the tasks","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_GetCallListDetails_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/EditCallListTask":{"post":{"operationId":"callLists_EditCallListTask","summary":"EditCallListTask","description":"Edits the specified call list's task.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`, `Support`.\n\n**Example request:** Set attempts_left, start_at, and custom_data the task with id=1 in the call list with id=1.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"Call list's ID","required":true,"schema":{"type":"integer"}},{"name":"task_id","in":"query","description":"Call list's task ID. Please specify either the task's ID or the task's UUID to edit the task","required":false,"schema":{"type":"integer"}},{"name":"task_uuid","in":"query","description":"Call list's task ID. Please specify either the task's ID or the task's UUID to edit the task. The UUID is unique within the call list","required":false,"schema":{"type":"string"}},{"name":"start_at","in":"query","description":"Next calling attempts timestamp in the yyyy-MM-dd HH:mm:ss format","required":false,"schema":{"type":"string"}},{"name":"attempts_left","in":"query","description":"Number of remaining calling attempts","required":false,"schema":{"type":"integer"}},{"name":"custom_data","in":"query","description":"Custom data string","required":false,"schema":{"type":"string"}},{"name":"min_execution_time","in":"query","description":"Optional. Start time for the daily calling attempts in the UTC+0 24-h format: HH:mm:ss format. If spefied, please specify `max_execution_time` as well","required":false,"schema":{"type":"string"}},{"name":"max_execution_time","in":"query","description":"Optional. End time for the daily calling attempts in the UTC+0 24-h format: HH:mm:ss format. If spefied, please specify `min_execution_time` as well","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_EditCallListTask_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/CancelCallListTask":{"post":{"operationId":"callLists_CancelCallListTask","summary":"CancelCallListTask","description":"Cancels the specified tasks in the call list by their IDs or UUIDs. The maximum number of tasks to cancel is 1000.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.","tags":["callLists"],"parameters":[{"name":"account_id","in":"query","description":"Account's ID","required":true,"schema":{"type":"string"}},{"name":"list_id","in":"query","description":"Call list's ID","required":true,"schema":{"type":"string"}},{"name":"tasks_ids","in":"query","description":"Task IDs separated by a semicolon. Specify either `tasks_ids` or `tasks_uuids`. The method returns an error if none of the parameters is specified","required":false,"schema":{"type":"string"}},{"name":"tasks_uuids","in":"query","description":"Task UUIDs separated by a semicolon. Specify either `tasks_ids` or `tasks_uuids`. The method returns an error if none of the parameters is specified","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_CancelCallListTask_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/StopCallListProcessing":{"post":{"operationId":"callLists_StopCallListProcessing","summary":"StopCallListProcessing","description":"Stops processing the specified call list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`, `Support`.\n\n**Example request:** Cancel list with id = 1.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"The list Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_StopCallListProcessing_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/RecoverCallList":{"post":{"operationId":"callLists_RecoverCallList","summary":"RecoverCallList","description":"Resume processing the specified call list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Call list manager`.\n\n**Example request:** Restore list with id = 1.","tags":["callLists"],"parameters":[{"name":"list_id","in":"query","description":"The list Id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/call-lists_RecoverCallList_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddScenario":{"post":{"operationId":"scenarios_AddScenario","summary":"AddScenario","description":"Adds a new scenario to the Shared folder, so the scenario is available in all the existing applications. Please use the POST method.\n\nWhen adding a scenario to the Shared folder, the `application_id` and `application_name` parameters should not be provided.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add a new scenario: var s='hello';","tags":["Scenarios"],"parameters":[{"name":"scenario_name","in":"query","description":"The scenario name. The length must be less than 30","required":true,"schema":{"type":"string"}},{"name":"scenario_script","in":"query","description":"The scenario text. Use the application/x-www-form-urlencoded content type with UTF-8 encoding. The length must be less than 128 KB","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID. The new scenario binds to the specified rule. Please note, if you do not bind the scenario to any rule, you cannot execute the scenario","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name that can be used instead of **rule_id**","required":false,"schema":{"type":"string"}},{"name":"rewrite","in":"query","description":"Whether to rewrite the existing scenario","required":false,"schema":{"type":"boolean","default":false}},{"name":"application_id","in":"query","description":"Application ID to bind the scenario to","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to bind the scenario to","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_AddScenario_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelScenario":{"post":{"operationId":"scenarios_DelScenario","summary":"DelScenario","description":"Deletes the scenario.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Delete the scenario 1 and 3.","tags":["Scenarios"],"parameters":[{"name":"scenario_id","in":"query","description":"The scenario ID list separated by semicolons (;). Use the 'all' value to delete all scenarios in all applications. **Required** unless **scenario_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"scenario_name","in":"query","description":"The scenario name list separated by semicolons (;). **Required** unless **scenario_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_DelScenario_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindScenario":{"post":{"operationId":"scenarios_BindScenario","summary":"BindScenario","description":"Bind the scenario list to the rule. You should specify the application_id or application_name if you specify the rule_name. Please note, the scenario and the routing rule need to be within the same application.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Bind the scenarios 1, 2 and 3 with the rule 1.","tags":["Scenarios"],"parameters":[{"name":"scenario_id","in":"query","description":"The scenario ID list separated by semicolons (;). **Required** unless **scenario_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"scenario_name","in":"query","description":"The scenario name list separated by semicolons (;). **Required** unless **scenario_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"rule_id","in":"query","description":"The rule ID to bind the scenario. The rule and the scenario need to be in the same application. **Required** unless **rule_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name. **Required** unless **rule_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_BindScenario_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetScenarios":{"post":{"operationId":"scenarios_GetScenarios","summary":"GetScenarios","description":"Gets the account's scenarios.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Get two scenarios, but skip the first one.","tags":["Scenarios"],"parameters":[{"name":"scenario_id","in":"query","description":"The scenario ID to filter","required":false,"schema":{"type":"integer"}},{"name":"scenario_name","in":"query","description":"The scenario name to filter. Can be used instead of **scenario_id**. All scenarios containing this param in their names are returned. The parameter is case insensitive","required":false,"schema":{"type":"string"}},{"name":"with_script","in":"query","description":"Whether to get the scenario text. You must specify the 'scenario_id' too!","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"application_id","in":"query","description":"ID of the scenario's application","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Name of the scenario's application","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_GetScenarios_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetScenarioInfo":{"post":{"operationId":"scenarios_SetScenarioInfo","summary":"SetScenarioInfo","description":"Edits the scenario. You can edit the scenario's name and body. Please use the POST method.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add a new scenario: var s='hello';","tags":["Scenarios"],"parameters":[{"name":"scenario_id","in":"query","description":"Scenario ID. **Required** unless **required_scenario_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"required_scenario_name","in":"query","description":"Name of the scenario to edit. **Required** unless **scenario_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"scenario_name","in":"query","description":"New scenario name. The length must be less than 30","required":false,"schema":{"type":"string"}},{"name":"scenario_script","in":"query","description":"New scenario text. Use the application/x-www-form-urlencoded content type with UTF-8 encoding. The length must be less than 128 KB","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_SetScenarioInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/ReorderScenarios":{"post":{"operationId":"scenarios_ReorderScenarios","summary":"ReorderScenarios","description":"Configures the order of scenarios that are assigned to the specified rule.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Set the scenario loading order: 17, 15, 20.","tags":["Scenarios"],"parameters":[{"name":"rule_id","in":"query","description":"The rule ID. **Required** unless **rule_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name. **Required** unless **rule_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"scenario_id","in":"query","description":"The scenario ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_ReorderScenarios_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/StartScenarios":{"post":{"operationId":"scenarios_StartScenarios","summary":"StartScenarios","description":"Runs JavaScript scenarios on a Voximplant server. The scenarios run in a new media session. To start a scenario, pass the routing rule ID associated with the necessary scenario. You can use both GET and POST requests at your choice. If you need to send custom data, we recommend to use the POST method and to include the data in the `custom_data` field of the request body. The maximum number of concurrent HTTP-requests is limited to 200. If this number is exceeded, this method returns the 429 code error (Too Many Requests) until the number of active requests is reduced. If you exceed this number, you get the 429 error code.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `CallsSMS`.\n\n**Example request:** Start the scripts from the account.","tags":["Scenarios"],"parameters":[{"name":"user_id","in":"query","description":"The user ID. Run the scripts from the user if set","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name that can be used instead of **user_id**. Run the scripts from the user if set","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule","required":true,"schema":{"type":"integer"}},{"name":"script_custom_data","in":"query","description":"The script custom data, that can be accessed in the scenario via the VoxEngine.customData() method. Use the application/x-www-form-urlencoded content type with UTF-8 encoding","required":false,"schema":{"type":"string"}},{"name":"reference_ip","in":"query","description":"Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers","required":false,"schema":{"type":"string"}},{"name":"server_location","in":"query","description":"Specifies the location of the server where the scenario needs to be executed. Has higher priority than `reference_ip`. Request [getServerLocations](https://api.voximplant.com/getServerLocations) for possible values","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_StartScenarios_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/StartConference":{"post":{"operationId":"scenarios_StartConference","summary":"StartConference","description":"Runs a session for video conferencing or joins the existing video conference session.\n\nWhen you create a session by calling this method, a scenario runs on one of the servers dedicated to video conferencing. All further method calls with the same **conference_name** do not create a new video conference session but join the existing one.\n\nUse the [StartScenarios] method for creating audio conferences.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `CallsSMS`.\n\n**Example request:** Start the conference from the account.","tags":["Scenarios"],"parameters":[{"name":"conference_name","in":"query","description":"The conference name. The name length must be less than 50 symbols","required":true,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID that needs to be launched. Please note, the necessary scenario needs to be attached to the rule","required":true,"schema":{"type":"integer"}},{"name":"user_id","in":"query","description":"The user ID. Run the scripts from the user if set","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name that can be used instead of **user_id**. Run the scripts from the user if set","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"script_custom_data","in":"query","description":"The script custom data, that can be accessed in the scenario via the VoxEngine.customData() method. Use the application/x-www-form-urlencoded content type with UTF-8 encoding.","required":false,"schema":{"type":"string"}},{"name":"reference_ip","in":"query","description":"Specifies the IP from the geolocation of predicted subscribers. It allows selecting the nearest server for serving subscribers","required":false,"schema":{"type":"string"}},{"name":"server_location","in":"query","description":"Specifies the location of the server where the scenario needs to be executed. Has higher priority than `reference_ip`. Request [getServerLocations](https://api.voximplant.com/getServerLocations) for possible values","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scenarios_StartConference_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddRule":{"post":{"operationId":"rules_AddRule","summary":"AddRule","description":"Adds a new rule for the application.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add a new rule.","tags":["Rules"],"parameters":[{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"rule_name","in":"query","description":"The rule name. The length must be less than 100","required":true,"schema":{"type":"string"}},{"name":"rule_pattern","in":"query","description":"The rule pattern regex. The length must be less than 64 KB","required":true,"schema":{"type":"string"}},{"name":"rule_pattern_exclude","in":"query","description":"The exclude pattern regex. The length must be less than 64 KB","required":false,"schema":{"type":"string"}},{"name":"video_conference","in":"query","description":"Whether video conference is required","required":false,"schema":{"type":"boolean","default":false}},{"name":"bind_key_id","in":"query","description":"The service account ID to bind to the rule. Read more in the [guide](/platform/voxengine/management-api-usage)","required":false,"schema":{"type":"string"}},{"name":"scenario_id","in":"query","description":"The scenario ID list separated by semicolons (;). **Required** unless **scenario_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"scenario_name","in":"query","description":"The scenario name list separated by semicolons (;). **Required** unless **scenario_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_AddRule_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelRule":{"post":{"operationId":"rules_DelRule","summary":"DelRule","description":"Deletes the rule.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Delete the rule 1 and 3.","tags":["Rules"],"parameters":[{"name":"rule_id","in":"query","description":"The rule ID list separated by semicolons (;). Use the 'all' value to select all rules. **Required** unless **rule_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"rule_name","in":"query","description":"The rule name list separated by semicolons (;). **Required** unless **rule_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;). Use the 'all' value to select all applications. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_name","in":"query","description":"The application name list separated by semicolons (;). **Required** unless **application_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_DelRule_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetRuleInfo":{"post":{"operationId":"rules_SetRuleInfo","summary":"SetRuleInfo","description":"Edits the rule.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Deny all.","tags":["Rules"],"parameters":[{"name":"rule_id","in":"query","description":"The rule ID","required":true,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The new rule name. The length must be less than 100","required":false,"schema":{"type":"string"}},{"name":"rule_pattern","in":"query","description":"The new rule pattern regex. The length must be less than 64 KB","required":false,"schema":{"type":"string"}},{"name":"rule_pattern_exclude","in":"query","description":"The new exclude pattern regex. The length must be less than 64 KB","required":false,"schema":{"type":"string"}},{"name":"video_conference","in":"query","description":"Whether video conference is required","required":false,"schema":{"type":"boolean"}},{"name":"bind_key_id","in":"query","description":"The service account ID to bind to the rule. Read more in the [guide](/platform/voxengine/management-api-usage)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_SetRuleInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRules":{"post":{"operationId":"rules_GetRules","summary":"GetRules","description":"Gets the rules.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Call list manager`, `Support`.\n\n**Example request:** Get the first rule for the template 74951234567.","tags":["Rules"],"parameters":[{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID to filter","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name part to filter","required":false,"schema":{"type":"string"}},{"name":"video_conference","in":"query","description":"Whether it is a video conference to filter","required":false,"schema":{"type":"boolean"}},{"name":"attached_key_id","in":"query","description":"The service account ID bound to the rule. Read more in the [guide](/platform/voxengine/management-api-usage)","required":false,"schema":{"type":"string"}},{"name":"template","in":"query","description":"Search for template matching","required":false,"schema":{"type":"string"}},{"name":"with_scenarios","in":"query","description":"Whether to get bound scenarios info","required":false,"schema":{"type":"boolean"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_GetRules_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/ReorderRules":{"post":{"operationId":"rules_ReorderRules","summary":"ReorderRules","description":"Configures the rules' order in the Applications section of Control panel. Note: the rules must belong to the same application!\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Set the rule selection order: 1, 7, 3.","tags":["Rules"],"parameters":[{"name":"rule_id","in":"query","description":"The rule ID list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_ReorderRules_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCallHistory":{"post":{"operationId":"history_GetCallHistory","summary":"GetCallHistory","description":"Gets the account's call history (including call duration, cost, logs and other call information). You can filter the call history by a certain date.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Support`.\n\n**Example request:** Get the first call session history record with calls and record URLs from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"call_session_history_id","in":"query","description":"To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). The maximum number of records is 1000. You can find the session ID in the AppEvents.Started event's **sessionID** property in a scenario, or retrieve it from the **call_session_history_id** value returned from the StartScenarios or StartConference methods","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_id","in":"query","description":"To receive the call history for a specific application, pass the application ID to this parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name, can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"To receive the call history for a specific users, pass the user ID list separated by semicolons (;). If it is specified, the output contains the calls from the listed users only","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"rule_name","in":"query","description":"To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name","required":false,"schema":{"type":"string"}},{"name":"remote_number","in":"query","description":"To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side. Ignored if the `remote_number_list` parameter is not empty","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"remote_number_list","in":"query","description":"A JS array of strings of specific remote phone numbers to sort the call history. Has higher priority than the `remote_number` parameter. If the array is empty, the `remote_number` parameter is used instead","required":false,"schema":{"type":"object","additionalProperties":{"description":"Any type"}}},{"name":"local_number","in":"query","description":"To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"call_session_history_custom_data","in":"query","description":"To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter","required":false,"schema":{"type":"string"}},{"name":"with_calls","in":"query","description":"Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_records","in":"query","description":"Whether to get the calls' records","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_other_resources","in":"query","description":"Whether to get other resources usage (see [ResourceUsageType])","required":false,"schema":{"type":"boolean","default":true}},{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_calls_only","in":"query","description":"Whether to get the children account calls only","required":false,"schema":{"type":"boolean","default":false}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_total_count","in":"query","description":"Whether to include the 'total_count' and increase performance","required":false,"schema":{"type":"boolean","default":true}},{"name":"count","in":"query","description":"The number of returning records. The maximum value is 1000","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The number of records to skip in the output. The maximum value of 10000","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetCallHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCallHistoryAsync":{"post":{"operationId":"history_GetCallHistoryAsync","summary":"GetCallHistoryAsync","description":"The [GetCallHistory] asynchronous implementation. Use this function to download a large amounts of data. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Support`.\n\n**Example request:** Get the first call session history record with calls and record URLs from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"call_session_history_id","in":"query","description":"To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's **sessionID** property in a scenario, or retrieve it from the **call_session_history_id** value returned from the StartScenarios or StartConference methods","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_id","in":"query","description":"To receive the call history for a specific application, pass the application ID to this parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name, can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"To receive the call history for a specific users, pass the user ID list separated by semicolons (;). If it is specified, the output contains the calls from the listed users only","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"rule_name","in":"query","description":"To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name","required":false,"schema":{"type":"string"}},{"name":"remote_number","in":"query","description":"To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"local_number","in":"query","description":"To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"call_session_history_custom_data","in":"query","description":"To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter","required":false,"schema":{"type":"string"}},{"name":"with_calls","in":"query","description":"Whether to receive a list of sessions with all calls within the sessions, including phone numbers, call cost and other information","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_records","in":"query","description":"Whether to get the calls' records","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_other_resources","in":"query","description":"Whether to get other resources usage (see [ResourceUsageType])","required":false,"schema":{"type":"boolean","default":true}},{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_calls_only","in":"query","description":"Whether to get the children account calls only","required":false,"schema":{"type":"boolean","default":false}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names if the output=csv","required":false,"schema":{"type":"boolean","default":true}},{"name":"output","in":"query","description":"The output format. The following values available: **csv**. The default value is **csv**","required":false,"schema":{"type":"string","default":"csv"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetCallHistoryAsync_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetBriefCallHistory":{"post":{"operationId":"history_GetBriefCallHistory","summary":"GetBriefCallHistory","description":"Gets the account's brief call history in the asynchronous mode. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Support`.\n\n**Example request:** Get the brief call session history from the 2020-02-25 00:00:00 UTC to the 2020-02-26 00:00:00 UTC.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"call_session_history_id","in":"query","description":"To get the call history for the specific sessions, pass the session IDs to this parameter separated by a semicolon (;). You can find the session ID in the AppEvents.Started event's **sessionID** property in a scenario, or retrieve it from the **call_session_history_id** value returned from the StartScenarios or StartConference methods","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_id","in":"query","description":"To receive the call history for a specific application, pass the application ID to this parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name, can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"rule_name","in":"query","description":"To receive the call history for a specific routing rule, pass the rule name to this parameter. Applies only if you set application_id or application_name","required":false,"schema":{"type":"string"}},{"name":"remote_number","in":"query","description":"To receive a call history for a specific remote numbers, pass the number list separated by semicolons (;). A remote number is a number on the client side","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"local_number","in":"query","description":"To receive a call history for a specific local numbers, pass the number list separated by semicolons (;). A local number is a number on the platform side","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"call_session_history_custom_data","in":"query","description":"To filter the call history by the custom_data passed to the call sessions, pass the custom data to this parameter","required":false,"schema":{"type":"string"}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names if the output=csv","required":false,"schema":{"type":"boolean","default":true}},{"name":"output","in":"query","description":"The output format. The following values available: **csv**.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetBriefCallHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetHistoryReports":{"post":{"operationId":"history_GetHistoryReports","summary":"GetHistoryReports","description":"Gets the list of history reports and their statuses. The method returns info about the reports made via [GetCallHistoryAsync], [GetTransactionHistoryAsync], [GetAuditLogAsync] and [GetBriefCallHistory] asynchronous methods. Note that the **file_size** field in response is valid only for the video calls.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`.\n\n**Example request:** Get all the reports.","tags":["History"],"parameters":[{"name":"history_report_id","in":"query","description":"The history report ID to filter","required":false,"schema":{"type":"integer"}},{"name":"history_type","in":"query","description":"The history report type list separated by semicolons (;). Use the 'all' value to select all history report types. The following values are possible: calls, calls_brief, transactions, audit, call_list, transactions_on_hold","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"created_from","in":"query","description":"The UTC creation from date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"created_to","in":"query","description":"The UTC creation to date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"is_completed","in":"query","description":"Whether the report is completed","required":false,"schema":{"type":"boolean"}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"application_id","in":"query","description":"The application ID to filter. Can be a list separated by semicolons (;). Use the 'all' value to select all applications","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetHistoryReports_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DownloadHistoryReport":{"post":{"operationId":"history_DownloadHistoryReport","summary":"DownloadHistoryReport","description":"Downloads the required history report.\n\nPlease note, that the history report can return in a compressed state (*.gzip). In order for CURL to process a compressed file correctly, add the **--compressed** key.\n\nAllowed roles: `Owner`, `Admin`, `Supervisor`, `Accountant`, `Payer`.\n\n**Example request:** Download the completed history report with id = 1.","tags":["History"],"parameters":[{"name":"history_report_id","in":"query","description":"The history report ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_DownloadHistoryReport_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetTransactionHistory":{"post":{"operationId":"history_GetTransactionHistory","summary":"GetTransactionHistory","description":"Gets the transaction history.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** 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.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"transaction_type","in":"query","description":"The transaction type list separated by semicolons (;). The following values are possible: gift_revoke, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, rub_card_periodic_payment, rub_card_overrun_payment, rub_card_payment, robokassa_payment, gift, promo, adjustment, wire_transfer, us_wire_transfer, refund, discount, mgp_charge, mgp_startup, mgp_business, mgp_big_business, mgp_enterprise, mgp_large_enterprise, techsupport_charge, tax_charge, monthly_fee_charge, grace_credit_payment, grace_credit_provision, mau_charge, mau_overrun, im_charge, im_overrun, fmc_charge, sip_registration_charge, development_fee, money_transfer_to_child, money_transfer_to_parent, money_acceptance_from_child, money_acceptance_from_parent, phone_number_installation, phone_number_charge, toll_free_phone_number_installation, toll_free_phone_number_charge, services, user_money_transfer, paypal_payment, paypal_overrun_payment, paypal_periodic_payment","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_transactions_only","in":"query","description":"Whether to get the children account transactions only","required":false,"schema":{"type":"boolean","default":false}},{"name":"users_transactions_only","in":"query","description":"Whether to get the users' transactions only","required":false,"schema":{"type":"boolean","default":false}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean"}},{"name":"with_total_count","in":"query","description":"Whether to include the 'total_count' and increase performance","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The number of returning records. The maximum value is 1000","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The number of records to skip in the output with a maximum value of 10000","required":false,"schema":{"type":"integer","default":0}},{"name":"is_uncommitted","in":"query","description":"Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetTransactionHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetTransactionHistoryAsync":{"post":{"operationId":"history_GetTransactionHistoryAsync","summary":"GetTransactionHistoryAsync","description":"The [GetTransactionHistory] asynchronous implementation. Use this function to download a large amounts of data. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** 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.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"transaction_id","in":"query","description":"The transaction ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"transaction_type","in":"query","description":"The transaction type list separated by semicolons (;). The following values are possible: gift_revoke, resource_charge, money_distribution, subscription_charge, subscription_installation_charge, card_periodic_payment, card_overrun_payment, card_payment, rub_card_periodic_payment, rub_card_overrun_payment, rub_card_payment, robokassa_payment, gift, promo, adjustment, wire_transfer, us_wire_transfer, refund, discount, mgp_charge, mgp_startup, mgp_business, mgp_big_business, mgp_enterprise, mgp_large_enterprise, techsupport_charge, tax_charge, monthly_fee_charge, grace_credit_payment, grace_credit_provision, mau_charge, mau_overrun, im_charge, im_overrun, fmc_charge, sip_registration_charge, development_fee, money_transfer_to_child, money_transfer_to_parent, money_acceptance_from_child, money_acceptance_from_parent, phone_number_installation, phone_number_charge, toll_free_phone_number_installation, toll_free_phone_number_charge, services, user_money_transfer, paypal_payment, paypal_overrun_payment, paypal_periodic_payment","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"child_account_id","in":"query","description":"The child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_transactions_only","in":"query","description":"Whether to get the children account transactions only","required":false,"schema":{"type":"boolean","default":false}},{"name":"users_transactions_only","in":"query","description":"Whether to get the users' transactions only","required":false,"schema":{"type":"boolean","default":false}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean"}},{"name":"is_uncommitted","in":"query","description":"Whether to get transactions on hold (transactions for which money is reserved but not yet withdrawn from the account)","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names if the output=csv","required":false,"schema":{"type":"boolean","default":true}},{"name":"output","in":"query","description":"The output format. The following values available: **csv**. The default value is **csv**","required":false,"schema":{"type":"string","default":"csv"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetTransactionHistoryAsync_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeleteRecord":{"post":{"operationId":"history_DeleteRecord","summary":"DeleteRecord","description":"Try to remove a record and transcription files.\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Try remove link with record_id is 1.","tags":["History"],"parameters":[{"name":"record_url","in":"query","description":"The record URL to remove. You can retrieve the record URL via the GetCallHistory method","required":false,"schema":{"type":"string"}},{"name":"record_id","in":"query","description":"The record ID to remove. You can retrieve the record ID via the GetCallHistory method","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_DeleteRecord_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetACDHistory":{"post":{"operationId":"history_GetACDHistory","summary":"GetACDHistory","description":"Gets the ACD history.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get the two ACD session history records from the 2012-01-01 00:00:00 to the 2014-04-01 00:00:00.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"acd_session_history_id","in":"query","description":"The ACD session history ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"acd_request_id","in":"query","description":"The ACD request ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list to filter separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_id","in":"query","description":"The user ID list to filter separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"operator_hangup","in":"query","description":"Whether to get the calls terminated by the operator","required":false,"schema":{"type":"boolean"}},{"name":"unserviced","in":"query","description":"Whether the call is unserviced by the operator","required":false,"schema":{"type":"boolean"}},{"name":"min_waiting_time","in":"query","description":"The min waiting time filter","required":false,"schema":{"type":"integer"}},{"name":"rejected","in":"query","description":"Whether the call is rejected calls by the 'max_queue_size', 'max_waiting_time' threshold","required":false,"schema":{"type":"boolean"}},{"name":"with_events","in":"query","description":"Whether to get the bound events","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names if the output=csv","required":false,"schema":{"type":"boolean","default":true}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"output","in":"query","description":"The output format. The following values available: **json**, **csv**, **xls**. The default value is **json**","required":false,"schema":{"type":"string","default":"json"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetACDHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAuditLog":{"post":{"operationId":"history_GetAuditLog","summary":"GetAuditLog","description":"Gets the history of account changes.\n\nAllowed roles: `Owner`.\n\n**Example request:** Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"audit_log_id","in":"query","description":"The audit history ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"filtered_admin_user_id","in":"query","description":"The admin user ID to filter","required":false,"schema":{"type":"string"}},{"name":"filtered_ip","in":"query","description":"The IP list separated by semicolons (;) to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filtered_cmd","in":"query","description":"The function list separated by semicolons (;) to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"advanced_filters","in":"query","description":"A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)","required":false,"schema":{"type":"string"}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_total_count","in":"query","description":"Whether to include the 'total_count' and increase performance","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":100}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetAuditLog_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAuditLogAsync":{"post":{"operationId":"history_GetAuditLogAsync","summary":"GetAuditLogAsync","description":"The [GetAuditLog] asynchronous implementation. Use this function to download a large amounts of data. Take a look at the [GetHistoryReports] and [DownloadHistoryReport] functions for downloading details.\n\nAllowed roles: `Owner`.\n\n**Example request:** Get the three log items from the 2018-02-01 00:00:00 to the 2018-03-01 00:00:00 and filter.","tags":["History"],"parameters":[{"name":"from_date","in":"query","description":"The UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":true,"schema":{"type":"string"}},{"name":"audit_log_id","in":"query","description":"The audit history ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"filtered_admin_user_id","in":"query","description":"The admin user ID to filter","required":false,"schema":{"type":"string"}},{"name":"filtered_ip","in":"query","description":"The IP list separated by semicolons (;) to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filtered_cmd","in":"query","description":"The function list separated by semicolons (;) to filter","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"advanced_filters","in":"query","description":"A relation ID to filter (for example: a phone_number value, a user_id value, an application_id value)","required":false,"schema":{"type":"string"}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names if the output=csv","required":false,"schema":{"type":"boolean","default":true}},{"name":"output","in":"query","description":"The output format. The following values available: **csv**. The default value is **csv**","required":false,"schema":{"type":"string","default":"csv"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_GetAuditLogAsync_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumberReports":{"post":{"operationId":"phoneNumbers_GetPhoneNumberReports","summary":"GetPhoneNumberReports","description":"Receives information about the created phone numbers report or list of reports.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`, `PhoneNumberManager`.\n\n**Example request:** Get all the reports.","tags":["phoneNumbers"],"parameters":[{"name":"report_id","in":"query","description":"The phone number report ID to filter","required":false,"schema":{"type":"integer"}},{"name":"report_type","in":"query","description":"The phone number report type list separated by semicolons (;). The possible values are: phone_numbers, phone_numbers_awaiting_configuration","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"created_from","in":"query","description":"The UTC creation from date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"created_to","in":"query","description":"The UTC creation to date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"is_completed","in":"query","description":"Whether the report is completed","required":false,"schema":{"type":"boolean"}},{"name":"desc_order","in":"query","description":"Whether to get records in the descent order","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumberReports_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AttachPhoneNumber":{"post":{"operationId":"phoneNumbers_AttachPhoneNumber","summary":"AttachPhoneNumber","description":"Attach the phone number to the account. Note that phone numbers of some countries may require additional verification steps.\n\nPlease note that when you purchase a phone number, we reserve the subscription fee and taxes for the upcoming month. Read more in the Billing page.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Attach a US phone number to the account 1.","tags":["phoneNumbers"],"parameters":[{"name":"phone_count","in":"query","description":"Quantity of phone numbers you want to attach. **Required** unless **phone_number** is provided.","required":false,"schema":{"type":"integer"}},{"name":"phone_number","in":"query","description":"The phone number. See the [GetNewPhoneNumbers] method. **Required** unless **phone_count** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"country_code","in":"query","description":"The country code","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":true,"schema":{"type":"string"}},{"name":"country_state","in":"query","description":"The country state. See the [GetPhoneNumberCategories] and [GetPhoneNumberCountryStates] methods","required":false,"schema":{"type":"string"}},{"name":"phone_region_id","in":"query","description":"The phone region ID. See the [GetPhoneNumberRegions] method","required":true,"schema":{"type":"integer"}},{"name":"regulation_address_id","in":"query","description":"The phone regulation address ID","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_AttachPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindPhoneNumberToApplication":{"post":{"operationId":"phoneNumbers_BindPhoneNumberToApplication","summary":"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.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Bind the phone 1 to the application 1.","tags":["phoneNumbers"],"parameters":[{"name":"phone_id","in":"query","description":"The phone ID list separated by semicolons (;). Use the 'all' value to select all phone ids. **Required** unless **phone_number** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"phone_number","in":"query","description":"The phone number list separated by semicolons (;). **Required** unless **phone_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name that can be used instead of **rule_id**","required":false,"schema":{"type":"string"}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_BindPhoneNumberToApplication_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeactivatePhoneNumber":{"post":{"operationId":"phoneNumbers_DeactivatePhoneNumber","summary":"DeactivatePhoneNumber","description":"Deactivates the phone number.\n\nAllowed roles: `Owner`.\n\n**Example request:** Deactivate the phone 1.","tags":["phoneNumbers"],"parameters":[{"name":"phone_id","in":"query","description":"The phone ID list separated by semicolons (;). Use the 'all' value to select all phone ids. **Required** unless **phone_number** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"phone_number","in":"query","description":"The phone number list separated by semicolons (;). **Required** unless **phone_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_DeactivatePhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetPhoneNumberInfo":{"post":{"operationId":"phoneNumbers_SetPhoneNumberInfo","summary":"SetPhoneNumberInfo","description":"Set the phone number information.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Enable the auto charging.","tags":["phoneNumbers"],"parameters":[{"name":"phone_id","in":"query","description":"The phone ID list separated by semicolons (;). Use the 'all' value to select all phone ids. **Required** unless **phone_number** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"phone_number","in":"query","description":"The phone number list separated by semicolons (;). **Required** unless **phone_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"incoming_sms_callback_url","in":"query","description":"If set, the callback of an incoming SMS is sent to this url, otherwise, it is sent to the general account URL","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_SetPhoneNumberInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumbers":{"post":{"operationId":"phoneNumbers_GetPhoneNumbers","summary":"GetPhoneNumbers","description":"Gets the account phone numbers.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`.\n\n**Example request:** Get two attached phone numbers.","tags":["phoneNumbers"],"parameters":[{"name":"phone_id","in":"query","description":"Particular phone ID to filter","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"phone_number","in":"query","description":"Phone number list separated by semicolons (;) that can be used instead of **phone_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"activation_status","in":"query","description":"Phone number activation statuses to filter, separated by semicolons (;).\n\nThe possible values are: ACTIVE, ACTIVATING, DEACTIVATED, PROVISIONING, AWAITING_BUSINESS_PHONE_NUMBER_CONFIGURATION, LEGAL_OWNERSHIP_LIMIT_REACHED, GOSUSLUGI_DECLINED, SELF_BAN_ENABLED","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application_id","in":"query","description":"Application ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"is_bound_to_application","in":"query","description":"Whether the phone number bound to an application","required":false,"schema":{"type":"boolean"}},{"name":"phone_template","in":"query","description":"Phone number start to filter","required":false,"schema":{"type":"string"}},{"name":"country_code","in":"query","description":"Country code list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"phone_category_name","in":"query","description":"Phone category name. See the [GetPhoneNumberCategories] method","required":false,"schema":{"type":"string"}},{"name":"canceled","in":"query","description":"Whether the subscription is cancelled to filter","required":false,"schema":{"type":"boolean"}},{"name":"deactivated","in":"query","description":"Whether the subscription is frozen to filter","required":false,"schema":{"type":"boolean"}},{"name":"auto_charge","in":"query","description":"Whether the auto_charge flag is enabled","required":false,"schema":{"type":"boolean"}},{"name":"from_phone_next_renewal","in":"query","description":"UTC 'from' date filter in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"to_phone_next_renewal","in":"query","description":"UTC 'to' date filter in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"from_phone_purchase_date","in":"query","description":"UTC 'from' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"to_phone_purchase_date","in":"query","description":"UTC 'to' date filter in 24-h format: YYYY-MM-DD HH:mm:ss","required":false,"schema":{"type":"string"}},{"name":"child_account_id","in":"query","description":"Child account ID list separated by semicolons (;). Use the 'all' value to select all child accounts","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"children_phones_only","in":"query","description":"Whether to get the children phones only","required":false,"schema":{"type":"boolean","default":false}},{"name":"verification_name","in":"query","description":"Required account verification name to filter","required":false,"schema":{"type":"string"}},{"name":"verification_status","in":"query","description":"Account verification status list separated by semicolons (;). The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_unverified_hold_until","in":"query","description":"Unverified phone hold until the date (from ...) in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"to_unverified_hold_until","in":"query","description":"Unverified phone hold until the date (... to) in the following format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"can_be_used","in":"query","description":"Whether a not verified account can use the phone","required":false,"schema":{"type":"boolean"}},{"name":"order_by","in":"query","description":"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'","required":false,"schema":{"type":"string"}},{"name":"sandbox","in":"query","description":"Flag allows you to display only the numbers of the sandbox, real numbers, or all numbers. The following values are possible: 'all', 'true', 'false'","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Maximum returning record count","required":false,"schema":{"type":"integer","default":100}},{"name":"offset","in":"query","description":"First **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"phone_region_name","in":"query","description":"Region names list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"rule_id","in":"query","description":"Rule ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"rule_name","in":"query","description":"Rule names list separated by semicolons (;). Can be used only if __application_id__ or __application_name__ is specified","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"is_bound_to_rule","in":"query","description":"Whether the phone number is bound to some rule","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumbers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/IsAccountPhoneNumber":{"post":{"operationId":"phoneNumbers_IsAccountPhoneNumber","summary":"IsAccountPhoneNumber","description":"Checks if the phone number belongs to the authorized account.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`.\n\n**Example request:** Check if the phone number belongs to the account.","tags":["phoneNumbers"],"parameters":[{"name":"phone_number","in":"query","description":"Phone number to check in the international format without `+`","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_IsAccountPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumbersAsync":{"post":{"operationId":"phoneNumbers_GetPhoneNumbersAsync","summary":"GetPhoneNumbersAsync","description":"Gets the asynchronous report regarding purchased phone numbers.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`, `PhoneNumberManager`.\n\n**Example request:** Get two attached phone numbers.","tags":["phoneNumbers"],"parameters":[{"name":"with_header","in":"query","description":"Whether to get a CSV file with the column names","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumbersAsync_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetNewPhoneNumbers":{"post":{"operationId":"phoneNumbers_GetNewPhoneNumbers","summary":"GetNewPhoneNumbers","description":"Gets the new phone numbers.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Get the two new fixed Russian phone numbers at max.","tags":["phoneNumbers"],"parameters":[{"name":"country_code","in":"query","description":"The country code","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] function","required":true,"schema":{"type":"string"}},{"name":"country_state","in":"query","description":"The country state. See the GetPhoneNumberCategories and GetPhoneNumberCountryStates functions","required":false,"schema":{"type":"string"}},{"name":"phone_region_id","in":"query","description":"The phone region ID. See the [GetPhoneNumberRegions] method","required":true,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"phone_number_mask","in":"query","description":"The phone number searching mask. Asterisk represents zero or more occurrences of any character","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetNewPhoneNumbers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumberCategories":{"post":{"operationId":"phoneNumbers_GetPhoneNumberCategories","summary":"GetPhoneNumberCategories","description":"Gets the phone number categories.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Get the all phone number categories.","tags":["phoneNumbers"],"parameters":[{"name":"country_code","in":"query","description":"Country code list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sandbox","in":"query","description":"Flag allows you to display phone number categories only of the sandbox, real or all .The following values are possible: 'all', 'true', 'false'","required":false,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"The 2-letter locale code. Supported values are EN, RU","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumberCategories_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumberCountryStates":{"post":{"operationId":"phoneNumbers_GetPhoneNumberCountryStates","summary":"GetPhoneNumberCountryStates","description":"Gets the phone number country states.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Get the USA states.","tags":["phoneNumbers"],"parameters":[{"name":"country_code","in":"query","description":"The country code","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the GetPhoneNumberCategories function","required":true,"schema":{"type":"string"}},{"name":"country_state","in":"query","description":"The country state code (example: AL, CA... )","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumberCountryStates_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPhoneNumberRegions":{"post":{"operationId":"phoneNumbers_GetPhoneNumberRegions","summary":"GetPhoneNumberRegions","description":"Get the country regions of the phone numbers. The response also contains the info about multiple numbers subscription for the child accounts.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Get the Russian regions of the phone numbers.","tags":["phoneNumbers"],"parameters":[{"name":"country_code","in":"query","description":"The country code","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":true,"schema":{"type":"string"}},{"name":"country_state","in":"query","description":"The country state code (example: AL, CA... )","required":false,"schema":{"type":"string"}},{"name":"omit_empty","in":"query","description":"Whether not to show all the regions (with and without phone numbers in stock)","required":false,"schema":{"type":"boolean","default":true}},{"name":"phone_region_id","in":"query","description":"The phone region ID to filter","required":false,"schema":{"type":"integer"}},{"name":"phone_region_name","in":"query","description":"The phone region name to filter","required":false,"schema":{"type":"string"}},{"name":"phone_region_code","in":"query","description":"The region phone prefix to filter","required":false,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"The 2-letter locale code. Supported values are EN, RU","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetPhoneNumberRegions_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetActualPhoneNumberRegion":{"post":{"operationId":"phoneNumbers_GetActualPhoneNumberRegion","summary":"GetActualPhoneNumberRegion","description":"Get actual info on the country region of the phone numbers. The response also contains the info about multiple numbers subscription for the child accounts.\n\n**Example request:** Get the Germany region of the phone numbers.","tags":["phoneNumbers"],"parameters":[{"name":"country_code","in":"query","description":"The country code","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":true,"schema":{"type":"string"}},{"name":"country_state","in":"query","description":"The country state code (example: AL, CA... )","required":false,"schema":{"type":"string"}},{"name":"phone_region_id","in":"query","description":"The phone region ID to filter","required":true,"schema":{"type":"integer"}},{"name":"locale","in":"query","description":"The 2-letter locale code. Supported values are EN, RU","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetActualPhoneNumberRegion_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAccountPhoneNumberCountries":{"post":{"operationId":"phoneNumbers_GetAccountPhoneNumberCountries","summary":"GetAccountPhoneNumberCountries","description":"Gets all countries where the specific account has phone numbers.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`, `Verification`.\n\n**Example request:** Get the countries where the account with id = 1 has phone numbers attached to the application with id = 1.","tags":["phoneNumbers"],"parameters":[{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;) to filter","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone-numbers_GetAccountPhoneNumberCountries_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddPstnBlackListItem":{"post":{"operationId":"pstnBlacklist_AddPstnBlackListItem","summary":"AddPstnBlackListItem","description":"Add a new phone number to the PSTN blacklist. Use blacklist to block incoming calls from specified phone numbers to numbers purchased from Voximplant. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.\n\nAllowed roles: `Owner`, `Admin`.","tags":["pstnBlacklist"],"parameters":[{"name":"pstn_blacklist_phone","in":"query","description":"The phone number in format e164 or regex pattern","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pstn-blacklist_AddPstnBlackListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetPstnBlackListItem":{"post":{"operationId":"pstnBlacklist_SetPstnBlackListItem","summary":"SetPstnBlackListItem","description":"Update the PSTN blacklist item. BlackList works for numbers that are purchased from Voximplant only. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.\n\nAllowed roles: `Owner`, `Admin`.","tags":["pstnBlacklist"],"parameters":[{"name":"pstn_blacklist_id","in":"query","description":"The PSTN black list item ID","required":true,"schema":{"type":"integer"}},{"name":"pstn_blacklist_phone","in":"query","description":"The new phone number in format e164","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pstn-blacklist_SetPstnBlackListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelPstnBlackListItem":{"post":{"operationId":"pstnBlacklist_DelPstnBlackListItem","summary":"DelPstnBlackListItem","description":"Remove phone number from the PSTN blacklist.\n\nAllowed roles: `Owner`, `Admin`.","tags":["pstnBlacklist"],"parameters":[{"name":"pstn_blacklist_id","in":"query","description":"The PSTN black list item ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pstn-blacklist_DelPstnBlackListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPstnBlackList":{"post":{"operationId":"pstnBlacklist_GetPstnBlackList","summary":"GetPstnBlackList","description":"Get the whole PSTN blacklist.\n\nAllowed roles: `Owner`, `Admin`.","tags":["pstnBlacklist"],"parameters":[{"name":"pstn_blacklist_id","in":"query","description":"The PSTN black list item ID for filter","required":false,"schema":{"type":"integer"}},{"name":"pstn_blacklist_phone","in":"query","description":"The phone number in format e164 for filter","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pstn-blacklist_GetPstnBlackList_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddSipWhiteListItem":{"post":{"operationId":"sipWhiteList_AddSipWhiteListItem","summary":"AddSipWhiteListItem","description":"Adds a new network address to the SIP white list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.","tags":["sipWhiteList"],"parameters":[{"name":"sip_whitelist_network","in":"query","description":"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)","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"The network address description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-white-list_AddSipWhiteListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelSipWhiteListItem":{"post":{"operationId":"sipWhiteList_DelSipWhiteListItem","summary":"DelSipWhiteListItem","description":"Deletes the network address from the SIP white list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.","tags":["sipWhiteList"],"parameters":[{"name":"sip_whitelist_id","in":"query","description":"The SIP white list item ID to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-white-list_DelSipWhiteListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetSipWhiteListItem":{"post":{"operationId":"sipWhiteList_SetSipWhiteListItem","summary":"SetSipWhiteListItem","description":"Edits the SIP white list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.","tags":["sipWhiteList"],"parameters":[{"name":"sip_whitelist_id","in":"query","description":"The SIP white list item ID","required":true,"schema":{"type":"integer"}},{"name":"sip_whitelist_network","in":"query","description":"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)","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"The network address description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-white-list_SetSipWhiteListItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSipWhiteList":{"post":{"operationId":"sipWhiteList_GetSipWhiteList","summary":"GetSipWhiteList","description":"Gets the SIP white list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Get two networks, but skip the first one.","tags":["sipWhiteList"],"parameters":[{"name":"sip_whitelist_id","in":"query","description":"The SIP white list item ID to filter","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-white-list_GetSipWhiteList_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/CreateSipRegistration":{"post":{"operationId":"sipRegistration_CreateSipRegistration","summary":"CreateSipRegistration","description":"Creates a new SIP registration (the platform registers as a user on a 3rd party SIP server).\n\nThere are two modes of SIP registration:\n\n
  1. Persistent registration, when the platform registers on a 3rd party SIP server as a user and the registration lasts until deleted (or there are network/technical issues with it — see the corresponding callback)
  2. Non-persistent registration (set `is_persistent` to false) which is initiated only when the specificed user (with `user_id` or `user_name`) logs in via one of Voximplant SDKs. As soon the user logs off, the registration goes offline. This mode helps to implement SIP softphone-like apps using Voximplant’s SDKs.
\n\nPlease note that when you create a SIP registration, we reserve the subscription fee and taxes for the upcoming month. Read more in the Billing page.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Create SIP registration.","tags":["sipRegistration"],"parameters":[{"name":"sip_username","in":"query","description":"The user name","required":true,"schema":{"type":"string"}},{"name":"proxy","in":"query","description":"The SIP proxy","required":true,"schema":{"type":"string"}},{"name":"auth_user","in":"query","description":"The SIP authentications user","required":false,"schema":{"type":"string"}},{"name":"outbound_proxy","in":"query","description":"The outgoing SIP proxy","required":false,"schema":{"type":"string"}},{"name":"password","in":"query","description":"The SIP password","required":false,"schema":{"type":"string"}},{"name":"is_persistent","in":"query","description":"Whether SIP registration is persistent. Set false to activate it only on the user login","required":false,"schema":{"type":"boolean","default":true}},{"name":"application_id","in":"query","description":"The application ID which a new SIP registration is to be bound to. Can be used instead of the **application_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name which a new SIP registration is to be bound to. Can be used instead of the **application_id** parameter","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID which a new SIP registration is to be bound to. Can be used instead of the **rule_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name which a new SIP registration is to be bound to. Can be used instead of the **rule_id** parameter","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID which a new SIP registration is to be bound to. Can be used instead of the **user_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name which a new SIP registration is to be bound to. Can be used instead of the **user_id** parameter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-registration_CreateSipRegistration_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/UpdateSipRegistration":{"post":{"operationId":"sipRegistration_UpdateSipRegistration","summary":"UpdateSipRegistration","description":"Update SIP registration. You should specify the application_id or application_name if you specify the rule_name or user_id, or user_name. You can bind only one SIP registration to the user (the previous SIP registration is automatically unbound).\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Update SIP registration with id 1.","tags":["sipRegistration"],"parameters":[{"name":"sip_registration_id","in":"query","description":"The registration ID","required":true,"schema":{"type":"integer"}},{"name":"sip_username","in":"query","description":"The user name","required":false,"schema":{"type":"string"}},{"name":"proxy","in":"query","description":"The SIP proxy","required":false,"schema":{"type":"string"}},{"name":"auth_user","in":"query","description":"The SIP authentications user","required":false,"schema":{"type":"string"}},{"name":"outbound_proxy","in":"query","description":"The outgoing SIP proxy","required":false,"schema":{"type":"string"}},{"name":"password","in":"query","description":"The SIP password","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID which the SIP registration is to be bound to. Can be used instead of the **application_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name which the SIP registration is to be bound to. Can be used instead of the **application_id** parameter","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID which the SIP registration is to be bound to. Can be used instead of the **rule_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name which the SIP registration is to be bound to. Can be used instead of the **rule_id** parameter","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID which the SIP registration is to be bound to. Can be used instead of the **user_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name which the SIP registration is to be bound to. Can be used instead of the **user_id** parameter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-registration_UpdateSipRegistration_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindSipRegistration":{"post":{"operationId":"sipRegistration_BindSipRegistration","summary":"BindSipRegistration","description":"Bind the SIP registration to the application/user or unbind the SIP registration from the application/user. You should specify the application_id or application_name if you specify the rule_name or user_id, or user_name. You should specify the sip_registration_id if you set bind=true. You can bind only one SIP registration to the user (the previous SIP registration is automatically unbound).\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Bind SIP registration with id 1 to application with id 123.","tags":["sipRegistration"],"parameters":[{"name":"sip_registration_id","in":"query","description":"The registration ID","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application ID which the SIP registration is to be bound to. Can be used instead of the **application_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name which the SIP registration is to be bound to. Can be used instead of the **application_id** parameter","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"The rule ID which the SIP registration is to be bound to. Can be used instead of the **rule_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"The rule name which the SIP registration is to be bound to. Can be used instead of the **rule_id** parameter","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID which the SIP registration is to be bound to. Can be used instead of the **user_name** parameter","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"The user name which the SIP registration is to be bound to. Can be used instead of the **user_id** parameter","required":false,"schema":{"type":"string"}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-registration_BindSipRegistration_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeleteSipRegistration":{"post":{"operationId":"sipRegistration_DeleteSipRegistration","summary":"DeleteSipRegistration","description":"Delete SIP registration.\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Delete SIP registration with id 1.","tags":["sipRegistration"],"parameters":[{"name":"sip_registration_id","in":"query","description":"The registration ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-registration_DeleteSipRegistration_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSipRegistrations":{"post":{"operationId":"sipRegistration_GetSipRegistrations","summary":"GetSipRegistrations","description":"Get active SIP registrations.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`.\n\n**Example request:** Get all active sip registrations.","tags":["sipRegistration"],"parameters":[{"name":"sip_registration_id","in":"query","description":"The SIP registration ID","required":false,"schema":{"type":"integer"}},{"name":"sip_username","in":"query","description":"The SIP user name to filter","required":false,"schema":{"type":"string"}},{"name":"deactivated","in":"query","description":"Whether to show the frozen SIP registrations only","required":false,"schema":{"type":"boolean"}},{"name":"successful","in":"query","description":"Whether to show the successful SIP registrations only","required":false,"schema":{"type":"boolean"}},{"name":"is_persistent","in":"query","description":"Whether the SIP registration is persistent to filter","required":false,"schema":{"type":"boolean"}},{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;) to filter. Can be used instead of **application_name**","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_name","in":"query","description":"The application name list separated by semicolons (;) to filter. Can be used instead of **application_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"is_bound_to_application","in":"query","description":"Whether SIP registration bound to an application","required":false,"schema":{"type":"boolean"}},{"name":"rule_id","in":"query","description":"The rule ID list separated by semicolons (;) to filter. **Required** unless **rule_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"rule_name","in":"query","description":"The rule name list separated by semicolons (;) to filter. **Required** unless **rule_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;) to filter. **Required** unless **user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"proxy","in":"query","description":"The list of proxy servers to use, divided by semicolon (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"in_progress","in":"query","description":"Whether SIP registration is still in progress","required":false,"schema":{"type":"boolean"}},{"name":"status_code","in":"query","description":"The list of SIP response codes. The __code1:code2__ means a range from __code1__ to __code2__ including; the __code1;code2__ meanse either __code1__ or __code2__. You can combine ranges, e.g., __code1;code2:code3__","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sip-registration_GetSipRegistrations_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddWABPhoneNumber":{"post":{"operationId":"wabPhoneNumbers_AddWABPhoneNumber","summary":"AddWABPhoneNumber","description":"Adds a new WhatsApp Business phone number.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Adds a new WhatsApp Business phone number.","tags":["wabPhoneNumbers"],"parameters":[{"name":"wab_phone_number","in":"query","description":"WhatsApp Business phone number","required":true,"schema":{"type":"string"}},{"name":"voice_password","in":"query","description":"WhatsApp Business SIP password","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"WhatsApp Business phone number description","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Bound application ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Bound application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"Bound rule ID","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"Bound rule name that can be used instead of **rule_id**","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/wab-phone-numbers_AddWABPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeleteWABPhoneNumber":{"post":{"operationId":"wabPhoneNumbers_DeleteWABPhoneNumber","summary":"DeleteWABPhoneNumber","description":"Deletes a WhatsApp Business phone number.\n\nAllowed roles: `Owner`.\n\n**Example request:** Deletes a WhatsApp Business phone number.","tags":["wabPhoneNumbers"],"parameters":[{"name":"wab_phone_number","in":"query","description":"WhatsApp Business phone number to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/wab-phone-numbers_DeleteWABPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetWABPhoneNumberInfo":{"post":{"operationId":"wabPhoneNumbers_SetWABPhoneNumberInfo","summary":"SetWABPhoneNumberInfo","description":"Sets details for the specified WhatsApp Business phone number.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.","tags":["wabPhoneNumbers"],"parameters":[{"name":"wab_phone_number","in":"query","description":"WhatsApp Business phone number to change details for","required":true,"schema":{"type":"string"}},{"name":"voice_password","in":"query","description":"New WhatsApp Business SIP password","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"New WhatsApp Business phone number description","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Bound application ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Bound application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"rule_id","in":"query","description":"Bound rule ID","required":false,"schema":{"type":"integer"}},{"name":"rule_name","in":"query","description":"Bound rule name that can be used instead of **rule_id**","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/wab-phone-numbers_SetWABPhoneNumberInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetWABPhoneNumbers":{"post":{"operationId":"wabPhoneNumbers_GetWABPhoneNumbers","summary":"GetWABPhoneNumbers","description":"Gets the account's WhatsApp Business phone numbers.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `Support`, `Payer`.","tags":["wabPhoneNumbers"],"parameters":[{"name":"wab_phone_number","in":"query","description":"WhatsApp Business phone number","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Application ID that is bound to the WhatsApp Business phone number","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Bound application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"country_code","in":"query","description":"Country code filter (2 symbols) for the WhatsApp Business phone number","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Maximum returning records count","required":false,"schema":{"type":"integer","default":100}},{"name":"offset","in":"query","description":"Number of records to be skipped in the result","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/wab-phone-numbers_GetWABPhoneNumbers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelCallerID":{"post":{"operationId":"callerids_DelCallerID","summary":"DelCallerID","description":"Deletes the CallerID. Note: you cannot delete a CID permanently (the antispam defence).\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Delete the callerID 1.","tags":["CallerIDs"],"parameters":[{"name":"callerid_id","in":"query","description":"ID of the callerID object. **Required** unless **callerid_number** is provided.","required":false,"schema":{"type":"integer"}},{"name":"callerid_number","in":"query","description":"The callerID number. **Required** unless **callerid_id** is provided.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/callerids_DelCallerID_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCallerIDs":{"post":{"operationId":"callerids_GetCallerIDs","summary":"GetCallerIDs","description":"Gets the account callerIDs.\n\nAllowed roles: `Owner`, `Admin`.\n\n**Example request:** Get the two callerIDs.","tags":["CallerIDs"],"parameters":[{"name":"callerid_id","in":"query","description":"ID of the callerID object to filter","required":false,"schema":{"type":"integer"}},{"name":"callerid_number","in":"query","description":"The phone number to filter","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","description":"Whether the account is active to filter","required":false,"schema":{"type":"boolean"}},{"name":"order_by","in":"query","description":"The following values are available: 'caller_number' (ascent order), 'verified_until' (ascent order)","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/callerids_GetCallerIDs_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddOutboundTestPhoneNumber":{"post":{"operationId":"outboundtestnumbers_AddOutboundTestPhoneNumber","summary":"AddOutboundTestPhoneNumber","description":"Adds a personal phone number to test outgoing calls. Only one personal phone number can be used. To replace it with another, delete the existing one first.\n\n**Example request:** Add a personal phone number.","tags":["OutboundTestNumbers"],"parameters":[{"name":"phone_number","in":"query","description":"The personal phone number in the E.164 format","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outboundtestnumbers_AddOutboundTestPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/VerifyOutboundTestPhoneNumber":{"post":{"operationId":"outboundtestnumbers_VerifyOutboundTestPhoneNumber","summary":"VerifyOutboundTestPhoneNumber","description":"Starts a call to the added phone number and pronounces a verification code. You have only 5 verification attempts per day and 100 in total. 1 minute should pass between 2 attempts.\n\n**Example request:** Get the verification code.","tags":["OutboundTestNumbers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outboundtestnumbers_VerifyOutboundTestPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/ActivateOutboundTestPhoneNumber":{"post":{"operationId":"outboundtestnumbers_ActivateOutboundTestPhoneNumber","summary":"ActivateOutboundTestPhoneNumber","description":"Activates the phone number by the verification code.\n\n**Example request:** Activate the personal phone number by the verification code.","tags":["OutboundTestNumbers"],"parameters":[{"name":"verification_code","in":"query","description":"The verification code, see the [VerifyOutboundTestPhoneNumber] function","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outboundtestnumbers_ActivateOutboundTestPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelOutboundTestPhoneNumber":{"post":{"operationId":"outboundtestnumbers_DelOutboundTestPhoneNumber","summary":"DelOutboundTestPhoneNumber","description":"Deletes the existing phone number.\n\n**Example request:** Delete the phone number.","tags":["OutboundTestNumbers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outboundtestnumbers_DelOutboundTestPhoneNumber_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetOutboundTestPhoneNumbers":{"post":{"operationId":"outboundtestnumbers_GetOutboundTestPhoneNumbers","summary":"GetOutboundTestPhoneNumbers","description":"Shows the phone number info.\n\n**Example request:** Get the phone number info.","tags":["OutboundTestNumbers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outboundtestnumbers_GetOutboundTestPhoneNumbers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddQueue":{"post":{"operationId":"queues_AddQueue","summary":"AddQueue","description":"Adds a new ACD queue.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add a new ACD queue for the application 1.","tags":["Queues"],"parameters":[{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"acd_queue_name","in":"query","description":"The queue name. The length must be less than 100","required":true,"schema":{"type":"string"}},{"name":"acd_queue_priority","in":"query","description":"The integer queue priority. The highest priority is 0","required":false,"schema":{"type":"integer","default":100}},{"name":"auto_binding","in":"query","description":"Whether to enable the auto binding of operators to a queue by skills comparing","required":false,"schema":{"type":"boolean","default":true}},{"name":"service_probability","in":"query","description":"The value in the range of [0.5 ... 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue","required":false,"schema":{"type":"number","format":"double","minimum":0.5,"maximum":1,"default":1}},{"name":"max_queue_size","in":"query","description":"The max queue size","required":false,"schema":{"type":"integer"}},{"name":"max_waiting_time","in":"query","description":"The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time","required":false,"schema":{"type":"integer"}},{"name":"average_service_time","in":"query","description":"The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_AddQueue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindUserToQueue":{"post":{"operationId":"queues_BindUserToQueue","summary":"BindUserToQueue","description":"Bind/unbind users to/from the specified ACD queues. Note that users and queues should be already bound to the same application.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `User manager`.\n\n**Example request:** Bind three users to one queue.","tags":["Queues"],"parameters":[{"name":"bind","in":"query","description":"Whether to bind or unbind users","required":false,"schema":{"type":"boolean","default":true}},{"name":"application_id","in":"query","description":"The application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;). Use the 'all' value to specify all users bound to the application. **Required** unless **user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). **Required** unless **user_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). Use the 'all' value to specify all queues bound to the application. **Required** unless **acd_queue_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"acd_queue_name","in":"query","description":"The queue name. The queue name list separated by semicolons (;). **Required** unless **acd_queue_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_BindUserToQueue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelQueue":{"post":{"operationId":"queues_DelQueue","summary":"DelQueue","description":"Deletes the ACD queue.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Delete the ACD queue 1.","tags":["Queues"],"parameters":[{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). **Required** unless **acd_queue_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"acd_queue_name","in":"query","description":"The ACD queue name. The ACD queue name list separated by semicolons (;). **Required** unless **acd_queue_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_DelQueue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetQueueInfo":{"post":{"operationId":"queues_SetQueueInfo","summary":"SetQueueInfo","description":"Edits the ACD queue.\n\n**Example request:** Change the queue name.","tags":["Queues"],"parameters":[{"name":"acd_queue_id","in":"query","description":"The ACD queue ID. **Required** unless **acd_queue_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"acd_queue_name","in":"query","description":"The ACD queue name. **Required** unless **acd_queue_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"new_acd_queue_name","in":"query","description":"The new queue name. The length must be less than 100","required":false,"schema":{"type":"string"}},{"name":"acd_queue_priority","in":"query","description":"The integer queue priority. The highest priority is 0","required":false,"schema":{"type":"integer"}},{"name":"auto_binding","in":"query","description":"Whether to enable the auto binding of operators to a queue by skills comparing","required":false,"schema":{"type":"boolean"}},{"name":"service_probability","in":"query","description":"The value in the range of [0.5 ... 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue","required":false,"schema":{"type":"number","format":"double","minimum":0.5,"maximum":1}},{"name":"max_queue_size","in":"query","description":"The max queue size","required":false,"schema":{"type":"integer"}},{"name":"max_waiting_time","in":"query","description":"The max predicted waiting time in minutes. The client is rejected if the predicted waiting time is greater than the max predicted waiting time","required":false,"schema":{"type":"integer"}},{"name":"average_service_time","in":"query","description":"The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The new application ID","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_SetQueueInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetQueues":{"post":{"operationId":"queues_GetQueues","summary":"GetQueues","description":"Gets the ACD queues.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`.\n\n**Example request:** Get the two queues.","tags":["Queues"],"parameters":[{"name":"acd_queue_id","in":"query","description":"The ACD queue ID to filter","required":false,"schema":{"type":"integer"}},{"name":"acd_queue_name","in":"query","description":"The ACD queue name part to filter","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID to filter","required":false,"schema":{"type":"integer"}},{"name":"skill_id","in":"query","description":"The skill ID to filter","required":false,"schema":{"type":"integer"}},{"name":"excluded_skill_id","in":"query","description":"The excluded skill ID to filter","required":false,"schema":{"type":"integer"}},{"name":"with_skills","in":"query","description":"Whether to get the bound skills","required":false,"schema":{"type":"boolean","default":false}},{"name":"showing_skill_id","in":"query","description":"The skill to show in the 'skills' field output","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"with_operatorcount","in":"query","description":"Whether to include the number of agents bound to the queue","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_GetQueues_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetACDState":{"post":{"operationId":"queues_GetACDState","summary":"GetACDState","description":"Gets the current ACD queue state.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Get the state of the queue 1.","tags":["Queues"],"parameters":[{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). Use the 'all' value to select all ACD queues","required":false,"schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_GetACDState_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetACDOperatorStatistics":{"post":{"operationId":"queues_GetACDOperatorStatistics","summary":"GetACDOperatorStatistics","description":"Get statistics for calls distributed to users (referred as 'operators') via the 'ACD' module. This method can filter statistic based on operator ids, queue ids and date-time interval. It can also group results by day or hour.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get AC and TT statistics for two operators and the queue from the specified date.","tags":["Queues"],"parameters":[{"name":"from_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":false,"schema":{"type":"string","default":"current date and time"}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). Use the 'all' value to select all ACD queues","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;). Use the 'all' value to select all users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"abbreviation","in":"query","description":"Whether key names in returned JSON are abbreviated to reduce response byte size. The abbreviations are: 'SA' for 'SpeedOfAnswer', 'HT' for 'HandlingTime', 'TT' for 'TalkTime', 'ACW' for 'AfterCallWork', 'TDT' for 'TotalDialingTime', 'THT' for 'TotalHandlingTime', 'TTT' for 'TotalTalkTime', 'TACW' for 'TotalAfterCallWork', 'AC' for 'AnsweredCalls', 'UAC' for 'UnansweredCalls'","required":false,"schema":{"type":"boolean","default":true}},{"name":"report","in":"query","description":"List of item names abbreviations separated by semicolons (;). Returned JSON includes keys only for the selected items. Special 'all' value defines all possible items, see [ACDOperatorStatisticsType] for a complete list. See 'abbreviation' description for complete abbreviation list","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"aggregation","in":"query","description":"Specifies how records are grouped by date and time. If set to 'day', the criteria is a day number. If set to 'hour_of_day', the criteria is a 60-minute interval within a day. If set to 'hour', the criteria is both day number and 60-minute interval within that day. If set to 'none', records are not grouped by date and time","required":false,"schema":{"type":"string","default":"none"}},{"name":"group","in":"query","description":"If set to 'user', first-level array in the resulting JSON groups records by the user ID, and second-level array groups them by date according to the 'aggregation' parameter. If set to 'aggregation', first-level array in the resulting JSON groups records according to the 'aggregation' parameter, and second-level array groups them by the user ID","required":false,"schema":{"type":"string","default":"user"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_GetACDOperatorStatistics_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetACDQueueStatistics":{"post":{"operationId":"queues_GetACDQueueStatistics","summary":"GetACDQueueStatistics","description":"Get statistics for calls distributed to users (referred as 'operators') via the 'queue' distribution system. This method can filter statistic based on operator ids, queue ids and date-time interval. It can also group results by day or hour.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get WT and TT statistics for the queue from the specified date.","tags":["Queues"],"parameters":[{"name":"from_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":false,"schema":{"type":"string","default":"current date and time"}},{"name":"abbreviation","in":"query","description":"Whether key names in returned JSON are abbreviated to reduce response byte size. The abbreviations are: 'WT' for 'WaitingTime', 'SA' for 'SpeedOfAnswer', 'AT' is for 'AbandonmentTime', 'HT' is for 'HandlingTime', 'TT' is for 'TalkTime', 'ACW' is for 'AfterCallWork', 'QL' is for 'QueueLength', 'TC' is for 'TotalCalls', 'AC' is for 'AnsweredCalls', 'UAC' is for 'UnansweredCalls', 'RC' is for 'RejectedCalls', 'SL' is for 'ServiceLevel', 'TWT' is for 'TotalWaitingTime', 'TST' is for 'TotalSubmissionTime', 'TAT' is for 'TotalAbandonmentTime', 'THT' is for 'TotalHandlingTime', 'TTT' is for 'TotalTalkTime', 'TACW' is for 'TotalAfterCallWork'","required":false,"schema":{"type":"boolean","default":true}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). Use the 'all' value to select all ACD queues","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"report","in":"query","description":"List of item names abbreviations separated by semicolons (;). Returned JSON includes keys only for the selected items. Special 'all' value defines all possible items, see [ACDQueueStatisticsType] for a complete list. See 'abbreviation' description for complete abbreviation list","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"aggregation","in":"query","description":"Specifies how records are grouped by date and time. If set to 'day', the criteria is a day number. If set to 'hour_of_day', the criteria is a 60-minute interval within a day. If set to 'hour', the criteria is both day number and 60-minute interval within that day. If set to 'none', records are not grouped by date and time","required":false,"schema":{"type":"string","default":"none"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_GetACDQueueStatistics_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetACDOperatorStatusStatistics":{"post":{"operationId":"queues_GetACDOperatorStatusStatistics","summary":"GetACDOperatorStatusStatistics","description":"Get statistics for the specified operators and ACD statuses. This method can filter statistics by operator ids and statuses. It can also group results by day/hour or users.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get statistics for the 'READY' and 'ONLINE' statuses of all operators; grouped by operators.","tags":["Queues"],"parameters":[{"name":"from_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Date and time of statistics interval begin. Time zone is UTC, format is 24-h 'YYYY-MM-DD HH:mm:ss'","required":false,"schema":{"type":"string","default":"current date and time"}},{"name":"acd_status","in":"query","description":"The ACD status list separated by semicolons (;). The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;). Use the 'all' value to select all users","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"aggregation","in":"query","description":"Specifies how records are grouped by date and time. If set to 'day', the criteria is a day number. If set to 'hour_of_day', the criteria is a 60-minute interval within a day. If set to 'hour', the criteria is both day number and 60-minute interval within that day. If set to 'none', records are not grouped by date and time","required":false,"schema":{"type":"string","default":"none"}},{"name":"group","in":"query","description":"If set to 'user', first-level array in the resulting JSON groups records by the user ID, and second-level array groups them by date according to the 'aggregation' parameter. If set to 'aggregation', first-level array in the resulting JSON groups records according to the 'aggregation' parameter, and second-level array groups them by the user ID","required":false,"schema":{"type":"string","default":"user"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queues_GetACDOperatorStatusStatistics_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSmartQueueRealtimeMetrics":{"post":{"operationId":"smartqueue_GetSmartQueueRealtimeMetrics","summary":"GetSmartQueueRealtimeMetrics","description":"Gets the metrics for the specified SmartQueue for the last 30 minutes. Refer to the SmartQueue reporting guide to learn more.\n\n**Example request:** Get the time agents spent in the DIALING status for all SmartQueues within one application.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to search by. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name to search by. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID list with a maximum of 5 values separated by semicolons (;). Use the 'all' value to select all users. Can operate as a filter for the **occupancy_rate**, **sum_agents_online_time**, **sum_agents_ready_time**, **sum_agents_dialing_time**, **sum_agents_in_service_time**, **sum_agents_afterservice_time**, **sum_agents_dnd_time**, **sum_agents_banned_time**, **min_handle_time**, **max_handle_time**, **average_handle_time**, **count_handled_calls**, **min_after_call_worktime**, **max_after_call_worktime**, **average_after_call_worktime** report types","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). **user_name** can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_queue_name","in":"query","description":"The SmartQueue name list separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 30 minutes","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time","required":false,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"The selected timezone or the 'auto' value (the account location)","required":false,"schema":{"type":"string","default":"UTC"}},{"name":"interval","in":"query","description":"Interval format: YYYY-MM-DD HH:mm:ss. Default is 30 minutes","required":false,"schema":{"type":"string","default":"0-0-0 0:30:0"}},{"name":"report_type","in":"query","description":"The report type. Possible values are: calls_blocked_percentage, count_blocked_calls, im_blocked_chats_percentage, im_count_blocked_chats, im_answered_chats_rate, average_abandonment_rate, count_abandonment_calls, service_level, im_service_level, occupancy_rate, im_agent_occupancy_rate, agent_utilization_rate, im_agent_utilization_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_in_service_incoming_time, sum_agents_in_service_outcoming_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_custom_1_time, sum_agents_custom_2_time, sum_agents_custom_3_time, sum_agents_custom_4_time, sum_agents_custom_5_time, sum_agents_custom_6_time, sum_agents_custom_7_time, sum_agents_custom_8_time, sum_agents_custom_9_time, sum_agents_custom_10_time, sum_agents_banned_time, im_sum_agents_online_time, im_sum_agents_ready_time, im_sum_agents_in_service_time, im_sum_agents_dnd_time, im_sum_agents_custom_1_time, im_sum_agents_custom_2_time, im_sum_agents_custom_3_time, im_sum_agents_custom_4_time, im_sum_agents_custom_5_time, im_sum_agents_custom_6_time, im_sum_agents_custom_7_time, im_sum_agents_custom_8_time, im_sum_agents_custom_9_time, im_sum_agents_custom_10_time, im_sum_agents_banned_time, average_agents_idle_time, max_agents_idle_time, min_agents_idle_time, percentile_0_25_agents_idle_time, percentile_0_50_agents_idle_time, percentile_0_75_agents_idle_time, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, im_min_answer_speed, im_max_answer_speed, im_average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, count_agent_unanswered_calls, im_count_agent_unanswered_chats, min_reaction_time, max_reaction_time, average_reaction_time, im_min_reaction_time, im_max_reaction_time, im_average_reaction_time, im_count_abandonment_chats, im_count_lost_chats, im_lost_chats_rate, call_count_assigned_to_queue, im_count_assigned_to_queue","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the result by **agent** or *queue*. The **agent** grouping is allowed for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The **queue** grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types","required":false,"schema":{"type":"string"}},{"name":"max_waiting_sec","in":"query","description":"Maximum waiting time. Required for the **service_level** report type","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_GetSmartQueueRealtimeMetrics_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSmartQueueDayHistory":{"post":{"operationId":"smartqueue_GetSmartQueueDayHistory","summary":"GetSmartQueueDayHistory","description":"Gets the metrics for the specified SmartQueue for the last 2 days. Refer to the SmartQueue reporting guide to learn more.\n\n**Example request:** Get the time agents spent in the ONLINE status for all SmartQueues within one application.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to search by. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name to search by. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID list with a maximum of 5 values separated by semicolons (;). Use the 'all' value to select all users. Can operate as a filter for the **occupancy_rate**, **sum_agents_online_time**, **sum_agents_ready_time**, **sum_agents_dialing_time**, **sum_agents_in_service_time**, **sum_agents_afterservice_time**, **sum_agents_dnd_time**, **sum_agents_banned_time**, **min_handle_time**, **max_handle_time**, **average_handle_time**, **count_handled_calls**, **min_after_call_worktime**, **max_after_call_worktime**, **average_after_call_worktime** report types","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). **user_name** can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_queue_id","in":"query","description":"The SmartQueue ID list with a maximum of 5 values separated by semicolons (;). Can operate as filter for the **calls_blocked_percentage**, **count_blocked_calls**, **average_abandonment_rate**, **count_abandonment_calls**, **service_level**, **occupancy_rate**, **min_time_in_queue**, **max_time_in_queue**, **average_time_in_queue**, **min_answer_speed**, **max_answer_speed**, **average_answer_speed**, **min_handle_time**, **max_handle_time**, **average_handle_time**, **count_handled_calls**, **min_after_call_worktime**, **max_after_call_worktime**, **average_after_call_worktime** report types","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"The SmartQueue name list separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 1 day","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time","required":false,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"The selected timezone or the 'auto' value (the account location)","required":false,"schema":{"type":"string","default":"UTC"}},{"name":"interval","in":"query","description":"Interval format: YYYY-MM-DD HH:mm:ss. Default is 1 day","required":false,"schema":{"type":"string","default":"0-0-1 0:0:0"}},{"name":"report_type","in":"query","description":"The report type. Possible values are: calls_blocked_percentage, count_blocked_calls, im_blocked_chats_percentage, im_count_blocked_chats, im_answered_chats_rate, average_abandonment_rate, count_abandonment_calls, service_level, im_service_level, occupancy_rate, im_agent_occupancy_rate, agent_utilization_rate, im_agent_utilization_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_in_service_incoming_time, sum_agents_in_service_outcoming_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_custom_1_time, sum_agents_custom_2_time, sum_agents_custom_3_time, sum_agents_custom_4_time, sum_agents_custom_5_time, sum_agents_custom_6_time, sum_agents_custom_7_time, sum_agents_custom_8_time, sum_agents_custom_9_time, sum_agents_custom_10_time, sum_agents_banned_time, im_sum_agents_online_time, im_sum_agents_ready_time, im_sum_agents_in_service_time, im_sum_agents_dnd_time, im_sum_agents_custom_1_time, im_sum_agents_custom_2_time, im_sum_agents_custom_3_time, im_sum_agents_custom_4_time, im_sum_agents_custom_5_time, im_sum_agents_custom_6_time, im_sum_agents_custom_7_time, im_sum_agents_custom_8_time, im_sum_agents_custom_9_time, im_sum_agents_custom_10_time, im_sum_agents_banned_time, average_agents_idle_time, max_agents_idle_time, min_agents_idle_time, percentile_0_25_agents_idle_time, percentile_0_50_agents_idle_time, percentile_0_75_agents_idle_time, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, im_min_answer_speed, im_max_answer_speed, im_average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, count_agent_unanswered_calls, im_count_agent_unanswered_chats, min_reaction_time, max_reaction_time, average_reaction_time, im_min_reaction_time, im_max_reaction_time, im_average_reaction_time, im_count_abandonment_chats, im_count_lost_chats, im_lost_chats_rate, call_count_assigned_to_queue, im_count_assigned_to_queue","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the result by **agent** or *queue*. The **agent** grouping is allowed only for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The **queue** grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types","required":false,"schema":{"type":"string"}},{"name":"max_waiting_sec","in":"query","description":"Maximum waiting time. Required for the **service_level** report type","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_GetSmartQueueDayHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/RequestSmartQueueHistory":{"post":{"operationId":"smartqueue_RequestSmartQueueHistory","summary":"RequestSmartQueueHistory","description":"Gets history for the specified SmartQueue. Refer to the SmartQueue reporting guide to learn more.\n\n**Example request:** Generate a service_level report file in csv format for the period from 2021-03-17 00:00:00 to 2021-03-17 22:00:00.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to search by. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name to search by. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"The user ID list with a maximum of 5 values separated by semicolons (;). Use the 'all' value to select all users. Can operate as a filter for the **occupancy_rate**, **sum_agents_online_time**, **sum_agents_ready_time**, **sum_agents_dialing_time**, **sum_agents_in_service_time**, **sum_agents_afterservice_time**, **sum_agents_dnd_time**, **sum_agents_banned_time**, **min_handle_time**, **max_handle_time**, **average_handle_time**, **count_handled_calls**, **min_after_call_worktime**, **max_after_call_worktime**, **average_after_call_worktime** report types","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_queue_id","in":"query","description":"The SmartQueue ID list with a maximum of 5 values separated by semicolons (;). Can operate as filter for the **calls_blocked_percentage**, **count_blocked_calls**, **average_abandonment_rate**, **count_abandonment_calls**, **service_level**, **occupancy_rate**, **min_time_in_queue**, **max_time_in_queue**, **average_time_in_queue**, **min_answer_speed**, **max_answer_speed**, **average_answer_speed**, **min_handle_time**, **max_handle_time**, **average_handle_time**, **count_handled_calls**, **min_after_call_worktime**, **max_after_call_worktime**, **average_after_call_worktime** report types","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"The SmartQueue name list separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"from_date","in":"query","description":"The from date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time minus 1 day","required":true,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"The to date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss. Default is the current time","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","description":"The selected timezone or the 'auto' value (the account location)","required":false,"schema":{"type":"string","default":"UTC"}},{"name":"interval","in":"query","description":"Interval format: YYYY-MM-DD HH:mm:ss. Default is 1 day","required":false,"schema":{"type":"string","default":"0-0-1 0:0:0"}},{"name":"report_type","in":"query","description":"The report type. Possible values are: calls_blocked_percentage, count_blocked_calls, im_blocked_chats_percentage, im_count_blocked_chats, im_answered_chats_rate, average_abandonment_rate, count_abandonment_calls, service_level, im_service_level, occupancy_rate, im_agent_occupancy_rate, agent_utilization_rate, im_agent_utilization_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_in_service_incoming_time, sum_agents_in_service_outcoming_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_custom_1_time, sum_agents_custom_2_time, sum_agents_custom_3_time, sum_agents_custom_4_time, sum_agents_custom_5_time, sum_agents_custom_6_time, sum_agents_custom_7_time, sum_agents_custom_8_time, sum_agents_custom_9_time, sum_agents_custom_10_time, sum_agents_banned_time, im_sum_agents_online_time, im_sum_agents_ready_time, im_sum_agents_in_service_time, im_sum_agents_dnd_time, im_sum_agents_custom_1_time, im_sum_agents_custom_2_time, im_sum_agents_custom_3_time, im_sum_agents_custom_4_time, im_sum_agents_custom_5_time, im_sum_agents_custom_6_time, im_sum_agents_custom_7_time, im_sum_agents_custom_8_time, im_sum_agents_custom_9_time, im_sum_agents_custom_10_time, im_sum_agents_banned_time, average_agents_idle_time, max_agents_idle_time, min_agents_idle_time, percentile_0_25_agents_idle_time, percentile_0_50_agents_idle_time, percentile_0_75_agents_idle_time, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, im_min_answer_speed, im_max_answer_speed, im_average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, count_agent_unanswered_calls, im_count_agent_unanswered_chats, min_reaction_time, max_reaction_time, average_reaction_time, im_min_reaction_time, im_max_reaction_time, im_average_reaction_time, im_count_abandonment_chats, im_count_lost_chats, im_lost_chats_rate, call_count_assigned_to_queue, im_count_assigned_to_queue","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"group_by","in":"query","description":"Group the result by **agent** or *queue*. The **agent** grouping is allowed only for 1 queue and for the occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types. The **queue** grouping allowed for the calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, min_time_in_queue, max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime report types","required":false,"schema":{"type":"string"}},{"name":"max_waiting_sec","in":"query","description":"Maximum waiting time. Required for the **service_level** report type","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_RequestSmartQueueHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSQState":{"post":{"operationId":"smartqueue_GetSQState","summary":"GetSQState","description":"Gets the current state of the specified SmartQueue.\n\n**Example request:** Get the current state of the SmartQueue with id = 1.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"The application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name to search by. Can be used instead of the **application_id** parameter","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"The SmartQueue ID list separated by semicolons (;). Use the 'all' value to select all SmartQueues","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"The SmartQueue name list separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"timezone","in":"query","description":"The selected timezone or the 'auto' value (the account location)","required":false,"schema":{"type":"string","default":"UTC"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_GetSQState_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_SetAgentCustomStatusMapping":{"post":{"operationId":"smartqueue_SQ_SetAgentCustomStatusMapping","summary":"SQ_SetAgentCustomStatusMapping","description":"Adds a status if there is no match for the given internal status and renames it if there is a match. It means that if the passed **sq_status_name** parameter is not in the mapping table, a new entry is created in there; if it is, the **name** field in its mapping is replaced with **custom_status_name**.\n\n**Example request:** Add/rename a status depending on the presence of an internal status in agent_status_mapping.","tags":["SmartQueue"],"parameters":[{"name":"sq_status_name","in":"query","description":"Status name","required":true,"schema":{"type":"string"}},{"name":"custom_status_name","in":"query","description":"Custom status name","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Application ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_SetAgentCustomStatusMapping_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_GetAgentCustomStatusMapping":{"post":{"operationId":"smartqueue_SQ_GetAgentCustomStatusMapping","summary":"SQ_GetAgentCustomStatusMapping","description":"Returns the mapping list of SQ statuses and custom statuses. SQ statuses are returned whether they have mappings to custom statuses.\n\n**Example request:** Get the status mappings.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_GetAgentCustomStatusMapping_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_DeleteAgentCustomStatusMapping":{"post":{"operationId":"smartqueue_SQ_DeleteAgentCustomStatusMapping","summary":"SQ_DeleteAgentCustomStatusMapping","description":"Removes a mapping from the mapping table. If there is no such mapping, does nothing.\n\n**Example request:** Remove a mapping for sq_status_name = READY.","tags":["SmartQueue"],"parameters":[{"name":"sq_status_name","in":"query","description":"Status name","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Application ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_DeleteAgentCustomStatusMapping_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_AddQueue":{"post":{"operationId":"smartqueue_SQ_AddQueue","summary":"SQ_AddQueue","description":"Adds a new queue.\n\n**Example request:** Add a new queue.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to bind to","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to bind to. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_name","in":"query","description":"Unique SmartQueue name within the application, up to 100 characters","required":true,"schema":{"type":"string"}},{"name":"hold_im_if_inactive_agents","in":"query","description":"Whether to add the task to the queue if there are no available agents","required":false,"schema":{"type":"boolean"}},{"name":"call_agent_selection","in":"query","description":"Agent selection strategy for calls. Accepts one of the following values: \"MOST_QUALIFIED\", \"LEAST_QUALIFIED\", \"MAX_WAITING_TIME\"","required":true,"schema":{"type":"string"}},{"name":"im_agent_selection","in":"query","description":"Agent selection strategy for messages. Accepts one of the following values: \"MOST_QUALIFIED\", \"LEAST_QUALIFIED\", \"MAX_WAITING_TIME\". The default value is **call_agent_selection**","required":false,"schema":{"type":"string"}},{"name":"call_task_selection","in":"query","description":"Call type requests prioritizing strategy. Accepts one of the [SQTaskSelectionStrategies] enum values","required":true,"schema":{"type":"string"}},{"name":"im_task_selection","in":"query","description":"IM type requests prioritizing strategy. Accepts one of the [SQTaskSelectionStrategies] enum values. The default value is **call_task_selection**","required":false,"schema":{"type":"string"}},{"name":"hold_calls_if_inactive_agents","in":"query","description":"Whether to keep the call task in the queue if all agents are in the DND/BANNED/OFFLINE statuses.","required":false,"schema":{"type":"boolean","default":false}},{"name":"description","in":"query","description":"Comment, up to 200 characters","required":false,"schema":{"type":"string"}},{"name":"call_max_waiting_time","in":"query","description":"Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent. Specify either this parameter or `call_max_waiting_time_in_seconds`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer","default":120}},{"name":"im_max_waiting_time","in":"query","description":"Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent. Specify either this parameter or `im_max_waiting_time_in_seconds`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer","default":120}},{"name":"call_max_queue_size","in":"query","description":"Maximum size of the queue with CALL-type requests","required":false,"schema":{"type":"integer","default":1000}},{"name":"im_max_queue_size","in":"query","description":"Maximum size of the queue with IM-type requests","required":false,"schema":{"type":"integer","default":1000}},{"name":"priority","in":"query","description":"The queue's priority from 1 to 100","required":false,"schema":{"type":"integer","default":10}},{"name":"call_max_waiting_time_in_seconds","in":"query","description":"Maximum call waiting time in seconds. Specify either this parameter or `call_max_waiting_time`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer"}},{"name":"im_max_waiting_time_in_seconds","in":"query","description":"Maximum chat message waiting time in seconds. Specify either this parameter or `im_max_waiting_time`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_AddQueue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_SetQueueInfo":{"post":{"operationId":"smartqueue_SQ_SetQueueInfo","summary":"SQ_SetQueueInfo","description":"Edits an existing queue.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Edit the queue with id = 1.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"hold_im_if_inactive_agents","in":"query","description":"Whether to add the task to the queue if there are no available agents","required":false,"schema":{"type":"boolean"}},{"name":"sq_queue_id","in":"query","description":"ID of the SmartQueue to search for","required":true,"schema":{"type":"integer"}},{"name":"sq_queue_name","in":"query","description":"Name of the SmartQueue to search for. Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"string"}},{"name":"hold_calls_if_inactive_agents","in":"query","description":"Whether to keep the call task in the queue if all agents are in the DND/BANNED/OFFLINE statuses.","required":false,"schema":{"type":"boolean","default":false}},{"name":"new_sq_queue_name","in":"query","description":"New SmartQueue name within the application, up to 100 characters","required":false,"schema":{"type":"string"}},{"name":"call_agent_selection","in":"query","description":"Agent selection strategy for calls. Accepts one of the following values: \"MOST_QUALIFIED\", \"LEAST_QUALIFIED\", \"MAX_WAITING_TIME\"","required":false,"schema":{"type":"string"}},{"name":"im_agent_selection","in":"query","description":"Agent selection strategy for messages. Accepts one of the following values: \"MOST_QUALIFIED\", \"LEAST_QUALIFIED\", \"MAX_WAITING_TIME\". The default value is **call_agent_selection**","required":false,"schema":{"type":"string"}},{"name":"call_task_selection","in":"query","description":"Strategy of prioritizing CALL-type requests for service. Accepts one of the following values: \"MAX_PRIORITY\", \"MAX_WAITING_TIME\"","required":false,"schema":{"type":"string"}},{"name":"im_task_selection","in":"query","description":"Strategy of prioritizing IM-type requests for service. Accepts one of the following values: \"MAX_PRIORITY\", \"MAX_WAITING_TIME\". The default value is **call_task_selection**","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Comment, up to 200 characters","required":false,"schema":{"type":"string"}},{"name":"call_max_waiting_time","in":"query","description":"Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent. Specify either this parameter or `call_max_waiting_time_in_seconds`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer","default":120}},{"name":"im_max_waiting_time","in":"query","description":"Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent. Specify either this parameter or `im_max_waiting_time_in_seconds`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer","default":120}},{"name":"call_max_queue_size","in":"query","description":"Maximum size of the queue with CALL-type requests","required":false,"schema":{"type":"integer","default":1000}},{"name":"im_max_queue_size","in":"query","description":"Maximum size of the queue with IM-type requests","required":false,"schema":{"type":"integer","default":1000}},{"name":"priority","in":"query","description":"The queue's priority from 1 to 100","required":false,"schema":{"type":"integer","default":10}},{"name":"call_max_waiting_time_in_seconds","in":"query","description":"Maximum call waiting time in seconds. Specify either this parameter or `call_max_waiting_time`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer"}},{"name":"im_max_waiting_time_in_seconds","in":"query","description":"Maximum chat message waiting time in seconds. Specify either this parameter or `im_max_waiting_time`. Specifying both parameters simultaniously leads to an error","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_SetQueueInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_DelQueue":{"post":{"operationId":"smartqueue_SQ_DelQueue","summary":"SQ_DelQueue","description":"Deletes a queue.\n\n**Example request:** Delete the queue with id = 3.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"List of SmartQueue IDs separated by semicolons (;). Use 'all' to delete all the queues","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"List of SmartQueue names separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_DelQueue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_GetQueues":{"post":{"operationId":"smartqueue_SQ_GetQueues","summary":"SQ_GetQueues","description":"Gets the queue(s).\n\n**Example request:** Get all the queues.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"List of SmartQueue IDs separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"List of SmartQueue names separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_queue_name_template","in":"query","description":"Substring of the SmartQueue name to filter","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"ID of the user that is bound to the queue","required":false,"schema":{"type":"integer"}},{"name":"user_name","in":"query","description":"Name of the user that is bound to the queue. Can be used instead of **user_id**","required":false,"schema":{"type":"string"}},{"name":"excluded_user_id","in":"query","description":"ID of the user that is not bound to the queue","required":false,"schema":{"type":"integer"}},{"name":"excluded_user_name","in":"query","description":"Name of the user that is not bound to the queue. Can be used instead of **excluded_user_id**","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of items to show in the output","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"Number of items to skip in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"with_agentcount","in":"query","description":"Whether to include the number of agents bound to the queue","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_GetQueues_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_AddSkill":{"post":{"operationId":"smartqueue_SQ_AddSkill","summary":"SQ_AddSkill","description":"Adds a new skill to the app.\n\n**Example request:** Add a new skill.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to bind to","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to bind to. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_skill_name","in":"query","description":"Unique skill name within the application","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Comment, up to 200 characters","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_AddSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_DelSkill":{"post":{"operationId":"smartqueue_SQ_DelSkill","summary":"SQ_DelSkill","description":"Deletes a skill and detaches it from agents.\n\n**Example request:** Delete the skill with id = 5.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_skill_id","in":"query","description":"List of skill IDs separated by semicolons (;). Use 'all' to delete all the skills","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_skill_name","in":"query","description":"List of skill names separated by semicolons (;). Can be used instead of **sq_skill_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_DelSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_SetSkillInfo":{"post":{"operationId":"smartqueue_SQ_SetSkillInfo","summary":"SQ_SetSkillInfo","description":"Edits an existing skill.\n\n**Example request:** Edit a skill.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_skill_id","in":"query","description":"ID of the skill","required":true,"schema":{"type":"integer"}},{"name":"sq_skill_name","in":"query","description":"Name of the skill. Can be used instead of **sq_skill_id**","required":false,"schema":{"type":"string"}},{"name":"new_sq_skill_name","in":"query","description":"New unique skill name within the application","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Comment, up to 200 characters","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_SetSkillInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_BindSkill":{"post":{"operationId":"smartqueue_SQ_BindSkill","summary":"SQ_BindSkill","description":"Binds skills to agents.\n\n**Example request:** Bind the skills with id 1 and 2 to all users.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;). Use 'all' to select all the users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_skills","in":"query","description":"Skills to be bound to agents in the json array format. The array should contain objects with the **sq_skill_id**/**sq_skill_name** and **sq_skill_level** keys where skill levels range from 1 to 5","required":true,"schema":{"type":"object","additionalProperties":{"description":"Any type"}}},{"name":"bind_mode","in":"query","description":"Binding mode. Accepts one of the [SQSkillBindingModes] enum values","required":false,"schema":{"type":"string","default":"add_queues"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_BindSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_UnbindSkill":{"post":{"operationId":"smartqueue_SQ_UnbindSkill","summary":"SQ_UnbindSkill","description":"Unbinds skills from agents.\n\n**Example request:** Unbind the skill with id = 1 from the user with id = 1.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;). Use 'all' to select all the users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_skill_id","in":"query","description":"List of skill IDs separated by semicolons (;). Use 'all' to unbind all the skills","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_skill_name","in":"query","description":"List of skill names separated by semicolons (;). Can be used instead of **sq_skill_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_UnbindSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_GetSkills":{"post":{"operationId":"smartqueue_SQ_GetSkills","summary":"SQ_GetSkills","description":"Gets the skill(s).\n\n**Example request:** Get the skills with id 2 and 4","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_skill_id","in":"query","description":"List of skill IDs separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_skill_name","in":"query","description":"List of skill names separated by semicolons (;). Can be used instead of **sq_skill_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"sq_skill_name_template","in":"query","description":"Substring of the skill name to filter, case-insensitive","required":false,"schema":{"type":"string"}},{"name":"excluded_user_id","in":"query","description":"ID of the user that is not bound to the skill","required":false,"schema":{"type":"integer"}},{"name":"excluded_user_name","in":"query","description":"Name of the user that is not bound to the skill. Can be used instead of **excluded_user_id**","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of items to show in the output","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"Number of items to skip in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_GetSkills_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_BindAgent":{"post":{"operationId":"smartqueue_SQ_BindAgent","summary":"SQ_BindAgent","description":"Binds agents to a queue.\n\n**Example request:** Bind the agent with id 1 and 2 to the queue with id = 1.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"ID of the SmartQueue. Pass a list of values divided by ; or the \"all\" keyword","required":true,"schema":{"type":"string"}},{"name":"sq_queue_name","in":"query","description":"Name of the SmartQueue. Pass a list of names divided by ; or the \"all\" keyword","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;). Use 'all' to select all the users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"bind_mode","in":"query","description":"Binding mode. Accepts one of the [SQAgentBindingModes] enum values","required":false,"schema":{"type":"string","default":"add_queues"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_BindAgent_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_UnbindAgent":{"post":{"operationId":"smartqueue_SQ_UnbindAgent","summary":"SQ_UnbindAgent","description":"Unbinds agents from queues.\n\n**Example request:** Unbind the agent with id 1 from all queues.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"List of SmartQueue IDs separated by semicolons (;). Use 'all' to select all the queues","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"List of SmartQueue names separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;). Use 'all' to select all the users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_UnbindAgent_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_GetAgents":{"post":{"operationId":"smartqueue_SQ_GetAgents","summary":"SQ_GetAgents","description":"Gets agents.\n\n**Example request:** Get all agents with their current statuses.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"sq_queue_id","in":"query","description":"List of SmartQueue IDs separated by semicolons (;). Use 'all' to select all the queues","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sq_queue_name","in":"query","description":"List of SmartQueue names separated by semicolons (;). Can be used instead of **sq_queue_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"excluded_sq_queue_id","in":"query","description":"ID of the SmartQueue to exclude","required":false,"schema":{"type":"integer"}},{"name":"excluded_sq_queue_name","in":"query","description":"Name of the SmartQueue to exclude. Can be used instead of **excluded_sq_queue_id**","required":false,"schema":{"type":"string"}},{"name":"sq_skills","in":"query","description":"Skills to filter in the json array format. The array should contain objects with the **sq_skill_id**/**sq_skill_name**, **min_sq_skill_level**, and **max_sq_skill_level** keys where skill levels range from 1 to 5","required":false,"schema":{"type":"object","additionalProperties":{"description":"Any type"}}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_name_template","in":"query","description":"Substring of the user name to filter","required":false,"schema":{"type":"string"}},{"name":"sq_statuses","in":"query","description":"Filter statuses in the json array format. The array should contain objects with the **sq_status_type** and **sq_status_name** keys. Possible values for **sq_status_type** are 'CALL' and 'IM'. Possible values for **sq_status_name** are 'OFFLINE', 'ONLINE', 'READY', 'IN_SERVICE', 'AFTER_SERVICE', 'DND'","required":false,"schema":{"type":"object","additionalProperties":{"description":"Any type"}}},{"name":"with_sq_skills","in":"query","description":"Whether to display agent skills","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_sq_queues","in":"query","description":"Whether to display agent queues","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_sq_statuses","in":"query","description":"Whether to display agent current statuses","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"Number of items to show in the output","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"Number of items to skip in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"handle_calls","in":"query","description":"Whether the agent can handle calls. When set to false, the agent is excluded from the CALL-request distribution","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_GetAgents_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SQ_SetAgentInfo":{"post":{"operationId":"smartqueue_SQ_SetAgentInfo","summary":"SQ_SetAgentInfo","description":"Edits the agent settings.\n\n**Example request:** Edit settings of the agent with id = 2.","tags":["SmartQueue"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to search by","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name to search by. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"List of user IDs separated by semicolons (;). Use 'all' to select all the users","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"List of user names separated by semicolons (;). Can be used instead of **user_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"max_simultaneous_conversations","in":"query","description":"Maximum number of chats that the user processes simultaneously","required":false,"schema":{"type":"integer","default":5}},{"name":"handle_calls","in":"query","description":"Whether the agent can handle calls. When set to false, the agent is excluded from the CALL-request distribution","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartqueue_SQ_SetAgentInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddSkill":{"post":{"operationId":"skills_AddSkill","summary":"AddSkill","description":"Adds a new operator's skill. Works only for ACDv1. For SmartQueue/ACDv2, use this reference.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `User manager`.\n\n**Example request:** Add a new skill.","tags":["Skills"],"parameters":[{"name":"skill_name","in":"query","description":"The ACD operator skill name. The length must be less than 512","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/skills_AddSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelSkill":{"post":{"operationId":"skills_DelSkill","summary":"DelSkill","description":"Deletes an operator's skill. Works only for ACDv1. For SmartQueue/ACDv2, use this reference.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `User manager`.\n\n**Example request:** Delete the skill 1.","tags":["Skills"],"parameters":[{"name":"skill_id","in":"query","description":"The skill ID. **Required** unless **skill_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"skill_name","in":"query","description":"The skill name. **Required** unless **skill_id** is provided.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/skills_DelSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetSkillInfo":{"post":{"operationId":"skills_SetSkillInfo","summary":"SetSkillInfo","description":"Edits an operator's skill. Works only for ACDv1. For SmartQueue/ACDv2, use this reference.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `User manager`.\n\n**Example request:** Change the skill name.","tags":["Skills"],"parameters":[{"name":"skill_id","in":"query","description":"The skill ID. **Required** unless **skill_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"skill_name","in":"query","description":"The skill name. **Required** unless **skill_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"new_skill_name","in":"query","description":"The new skill name. The length must be less than 512","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/skills_SetSkillInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSkills":{"post":{"operationId":"skills_GetSkills","summary":"GetSkills","description":"Gets the skills of an operator. Works only for ACDv1. For SmartQueue/ACDv2, use this reference.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `User manager`.\n\n**Example request:** Get two skills, but skip the first one.","tags":["Skills"],"parameters":[{"name":"skill_id","in":"query","description":"The skill ID to filter","required":false,"schema":{"type":"integer"}},{"name":"skill_name","in":"query","description":"The skill name part to filter","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/skills_GetSkills_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindSkill":{"post":{"operationId":"skills_BindSkill","summary":"BindSkill","description":"Binds the specified skills to the users (ACD operators) and/or the ACD queues. Works only for ACDv1. For SmartQueue/ACDv2, use this reference.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `User manager`.\n\n**Example request:** Bind the skills 1, 5 to the users 5, 6, 10.","tags":["Skills"],"parameters":[{"name":"skill_id","in":"query","description":"The skill ID list separated by semicolons (;). Use the 'all' value to select all skills. **Required** unless **skill_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"skill_name","in":"query","description":"The skill name list separated by semicolons (;). **Required** unless **skill_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_id","in":"query","description":"The user ID list separated by semicolons (;). Use the 'all' value to select all users. **Required** unless **user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"user_name","in":"query","description":"The user name list separated by semicolons (;). **Required** unless **user_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"acd_queue_id","in":"query","description":"The ACD queue ID list separated by semicolons (;). Use the 'all' value to select all ACD queues. **Required** unless **acd_queue_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"acd_queue_name","in":"query","description":"The ACD queue name. The ACD queue name list separated by semicolons (;). **Required** unless **acd_queue_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"application_id","in":"query","description":"The application ID. It is required if the **user_name** is specified","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/skills_BindSkill_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddAdminUser":{"post":{"operationId":"adminUsers_AddAdminUser","summary":"AddAdminUser","description":"Adds a new admin user into the specified parent or child account.\n\n**Example request:** Add a new admin user.","tags":["adminUsers"],"parameters":[{"name":"new_admin_user_name","in":"query","description":"The admin user name. The length must be less than 50","required":true,"schema":{"type":"string"}},{"name":"admin_user_display_name","in":"query","description":"The admin user display name. The length must be less than 256","required":true,"schema":{"type":"string"}},{"name":"new_admin_user_password","in":"query","description":"The admin user password. The length must be at least 6 symbols","required":true,"schema":{"type":"string"}},{"name":"admin_user_active","in":"query","description":"Whether the admin user is active","required":false,"schema":{"type":"boolean","default":true}},{"name":"admin_role_id","in":"query","description":"The role(s) ID created via Managing Admin Roles methods. The attaching admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles","required":false,"schema":{"type":"string"}},{"name":"admin_role_name","in":"query","description":"The role(s) name(s) created via Managing Admin Roles methods. The attaching admin role name that can be used instead of **admin_role_id**","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-users_AddAdminUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelAdminUser":{"post":{"operationId":"adminUsers_DelAdminUser","summary":"DelAdminUser","description":"Deletes the specified admin user.\n\n**Example request:** Delete the admin user.","tags":["adminUsers"],"parameters":[{"name":"required_admin_user_id","in":"query","description":"The admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users. **Required** unless **required_admin_user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"required_admin_user_name","in":"query","description":"The admin user name to delete. **Required** unless **required_admin_user_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-users_DelAdminUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetAdminUserInfo":{"post":{"operationId":"adminUsers_SetAdminUserInfo","summary":"SetAdminUserInfo","description":"Edits the specified admin user.\n\n**Example request:** Edit the admin user password.","tags":["adminUsers"],"parameters":[{"name":"required_admin_user_id","in":"query","description":"The admin user to edit. **Required** unless **required_admin_user_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"required_admin_user_name","in":"query","description":"The admin user to edit. **Required** unless **required_admin_user_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"new_admin_user_name","in":"query","description":"The new admin user name. The length must be less than 50","required":false,"schema":{"type":"string"}},{"name":"admin_user_display_name","in":"query","description":"The new admin user display name. The length must be less than 256","required":false,"schema":{"type":"string"}},{"name":"new_admin_user_password","in":"query","description":"The new admin user password. The length must be at least 6 symbols","required":false,"schema":{"type":"string"}},{"name":"admin_user_active","in":"query","description":"Whether the admin user is active","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-users_SetAdminUserInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAdminUsers":{"post":{"operationId":"adminUsers_GetAdminUsers","summary":"GetAdminUsers","description":"Gets the admin users of the specified account. Note that both account types - parent and child - can have its own admins.\n\n**Example request:** Get two first admin users.","tags":["adminUsers"],"parameters":[{"name":"required_admin_user_id","in":"query","description":"The admin user ID to filter","required":false,"schema":{"type":"integer"}},{"name":"required_admin_user_name","in":"query","description":"The admin user name part to filter","required":false,"schema":{"type":"string"}},{"name":"admin_user_display_name","in":"query","description":"The admin user display name part to filter","required":false,"schema":{"type":"string"}},{"name":"admin_user_active","in":"query","description":"Whether the admin user is active to filter","required":false,"schema":{"type":"boolean"}},{"name":"with_roles","in":"query","description":"Whether to get the attached admin roles","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_access_entries","in":"query","description":"Whether to get the admin user permissions","required":false,"schema":{"type":"boolean","default":false}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-users_GetAdminUsers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AttachAdminRole":{"post":{"operationId":"adminUsers_AttachAdminRole","summary":"AttachAdminRole","description":"Attaches the admin role(s) to the already existing admin(s).\n\n**Example request:** Bind the all admin users with the admin roles 1, 2 and 3.","tags":["adminUsers"],"parameters":[{"name":"required_admin_user_id","in":"query","description":"The admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users. **Required** unless **required_admin_user_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"required_admin_user_name","in":"query","description":"The admin user name to bind. **Required** unless **required_admin_user_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"admin_role_id","in":"query","description":"The role(s) ID created via Managing Admin Roles methods. The attached admin role ID list separated by semicolons (;). Use the 'all' value to select alladmin roles. **Required** unless **admin_role_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"admin_role_name","in":"query","description":"The role(s) name(s) created via Managing Admin Roles methods. The admin role name to attach. **Required** unless **admin_role_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"mode","in":"query","description":"The merge mode. The following values are possible: add, del, set","required":false,"schema":{"type":"string","default":"set"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-users_AttachAdminRole_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddAdminRole":{"post":{"operationId":"adminRoles_AddAdminRole","summary":"AddAdminRole","description":"Adds a new admin role.\n\n**Example request:** Add a new admin role with the GetAccountInfo and GetCallHistory permissions.","tags":["adminRoles"],"parameters":[{"name":"admin_role_name","in":"query","description":"The admin role name. The length must be less than 50","required":true,"schema":{"type":"string"}},{"name":"admin_role_active","in":"query","description":"Whether the admin role is enabled. If false the allowed and denied entries have no affect","required":false,"schema":{"type":"boolean","default":true}},{"name":"like_admin_role_id","in":"query","description":"The admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles. The list specifies the roles from which the new role automatically copies all permissions (allowed_entries and denied_entries)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"like_admin_role_name","in":"query","description":"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)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"allowed_entries","in":"query","description":"The list of allowed access entries separated by semicolons (;) (the API function names)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"denied_entries","in":"query","description":"The list of denied access entries separated by semicolons (;) (the API function names)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-roles_AddAdminRole_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelAdminRole":{"post":{"operationId":"adminRoles_DelAdminRole","summary":"DelAdminRole","description":"Deletes the specified admin role.\n\n**Example request:** Delete the admin role.","tags":["adminRoles"],"parameters":[{"name":"admin_role_id","in":"query","description":"The admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles. **Required** unless **admin_role_name** is provided.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"admin_role_name","in":"query","description":"The admin role name to delete. **Required** unless **admin_role_id** is provided.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-roles_DelAdminRole_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetAdminRoleInfo":{"post":{"operationId":"adminRoles_SetAdminRoleInfo","summary":"SetAdminRoleInfo","description":"Edits the specified admin role.\n\n**Example request:** Allow the all permissions except the DelUser and DelApplication.","tags":["adminRoles"],"parameters":[{"name":"admin_role_id","in":"query","description":"The admin role to edit. **Required** unless **admin_role_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"admin_role_name","in":"query","description":"The admin role to edit. **Required** unless **admin_role_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"new_admin_role_name","in":"query","description":"The new admin role name. The length must be less than 50","required":false,"schema":{"type":"string"}},{"name":"admin_role_active","in":"query","description":"Whether the admin role is enabled. If false the allowed and denied entries have no affect","required":false,"schema":{"type":"boolean"}},{"name":"entry_modification_mode","in":"query","description":"The modification mode of the permission lists (allowed_entries and denied_entries). The following values are possible: add, del, set","required":false,"schema":{"type":"string","default":"set"}},{"name":"allowed_entries","in":"query","description":"The list of allowed access entry changes separated by semicolons (;) (the API function names)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"denied_entries","in":"query","description":"The list of denied access entry changes separated by semicolons (;) (the API function names)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"like_admin_role_id","in":"query","description":"The admin role ID list separated by semicolons (;). Use the 'all' value to select all admin roles. The list specifies the roles from which the allowed_entries and denied_entries are merged","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"like_admin_role_name","in":"query","description":"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 are merged","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-roles_SetAdminRoleInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAdminRoles":{"post":{"operationId":"adminRoles_GetAdminRoles","summary":"GetAdminRoles","description":"Gets the admin roles.\n\n**Example request:** Get two admin roles attached to the admin_user_id=22.","tags":["adminRoles"],"parameters":[{"name":"admin_role_id","in":"query","description":"The admin role ID to filter","required":false,"schema":{"type":"integer"}},{"name":"admin_role_name","in":"query","description":"The admin role name part to filter","required":false,"schema":{"type":"string"}},{"name":"admin_role_active","in":"query","description":"Whether the admin role is enabled to filter","required":false,"schema":{"type":"boolean"}},{"name":"with_entries","in":"query","description":"Whether to get the permissions","required":false,"schema":{"type":"boolean","default":false}},{"name":"with_account_roles","in":"query","description":"Whether to include the account roles","required":false,"schema":{"type":"boolean","default":true}},{"name":"with_parent_roles","in":"query","description":"Whether to include the parent roles","required":false,"schema":{"type":"boolean","default":true}},{"name":"included_admin_user_id","in":"query","description":"The attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"excluded_admin_user_id","in":"query","description":"Not attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"full_admin_users_matching","in":"query","description":"Set false to get roles with partial admin user list matching","required":false,"schema":{"type":"string","default":"false"}},{"name":"showing_admin_user_id","in":"query","description":"The admin user to show in the 'admin_users' field output","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-roles_GetAdminRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAvailableAdminRoleEntries":{"post":{"operationId":"adminRoles_GetAvailableAdminRoleEntries","summary":"GetAvailableAdminRoleEntries","description":"Gets the all available admin role entries.\n\n**Example request:** Get the all available admin role entries.","tags":["adminRoles"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/admin-roles_GetAvailableAdminRoleEntries_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddAuthorizedAccountIP":{"post":{"operationId":"authorizedIps_AddAuthorizedAccountIP","summary":"AddAuthorizedAccountIP","description":"Adds a new authorized IP4 or network to the white/black list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add the 92.255.220.0/24 network to the white list.","tags":["authorizedIps"],"parameters":[{"name":"authorized_ip","in":"query","description":"The authorized IP4 or network","required":true,"schema":{"type":"string"}},{"name":"allowed","in":"query","description":"Whether to remove the IP from the blacklist","required":false,"schema":{"type":"boolean","default":true}},{"name":"description","in":"query","description":"The IP address description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-ips_AddAuthorizedAccountIP_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelAuthorizedAccountIP":{"post":{"operationId":"authorizedIps_DelAuthorizedAccountIP","summary":"DelAuthorizedAccountIP","description":"Removes the authorized IP4 or network from the white/black list.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Delete the 92.255.220.0/24 network from all the lists.","tags":["authorizedIps"],"parameters":[{"name":"authorized_ip","in":"query","description":"The authorized IP4 or network to remove. Set to 'all' to remove all items. **Required** unless **contains_ip** is provided.","required":false,"schema":{"type":"string"}},{"name":"contains_ip","in":"query","description":"Specify the parameter to remove the networks that contains the particular IP4. **Required** unless **authorized_ip** is provided.","required":false,"schema":{"type":"string"}},{"name":"allowed","in":"query","description":"Whether 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 all lists","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-ips_DelAuthorizedAccountIP_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAuthorizedAccountIPs":{"post":{"operationId":"authorizedIps_GetAuthorizedAccountIPs","summary":"GetAuthorizedAccountIPs","description":"Gets the authorized IP4 or network.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Show the all items.","tags":["authorizedIps"],"parameters":[{"name":"authorized_ip","in":"query","description":"The authorized IP4 or network to filter","required":false,"schema":{"type":"string"}},{"name":"allowed","in":"query","description":"Whether the IP is allowed","required":false,"schema":{"type":"boolean"}},{"name":"contains_ip","in":"query","description":"Specify the parameter to filter the networks that contains the particular IP4","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":50}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}},{"name":"description","in":"query","description":"The IP address description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-ips_GetAuthorizedAccountIPs_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/CheckAuthorizedAccountIP":{"post":{"operationId":"authorizedIps_CheckAuthorizedAccountIP","summary":"CheckAuthorizedAccountIP","description":"Tests whether the IP4 is banned or allowed.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.","tags":["authorizedIps"],"parameters":[{"name":"authorized_ip","in":"query","description":"The IP4 to test","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-ips_CheckAuthorizedAccountIP_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/LinkRegulationAddress":{"post":{"operationId":"regulationAddress_LinkRegulationAddress","summary":"LinkRegulationAddress","description":"Links the regulation address to a phone.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Link the regulation address to a phone number.","tags":["regulationAddress"],"parameters":[{"name":"regulation_address_id","in":"query","description":"The regulation address ID","required":true,"schema":{"type":"integer"}},{"name":"phone_id","in":"query","description":"The phone ID for link","required":true,"schema":{"type":"integer"}},{"name":"phone_number","in":"query","description":"The phone number for link","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_LinkRegulationAddress_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetZIPCodes":{"post":{"operationId":"regulationAddress_GetZIPCodes","summary":"GetZIPCodes","description":"Searches for available zip codes.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Search for zip codes in Germany.","tags":["regulationAddress"],"parameters":[{"name":"country_code","in":"query","description":"The country code according to the **ISO 3166-1 alpha-2**","required":true,"schema":{"type":"string"}},{"name":"phone_region_code","in":"query","description":"The phone region code","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_GetZIPCodes_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRegulationsAddress":{"post":{"operationId":"regulationAddress_GetRegulationsAddress","summary":"GetRegulationsAddress","description":"Searches for the user's regulation address.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`, `PayerNoVerify`.\n\n**Example request:** Search regulation address with ID = 1.","tags":["regulationAddress"],"parameters":[{"name":"country_code","in":"query","description":"The country code according to the **ISO 3166-1 alpha-2**","required":false,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":false,"schema":{"type":"string"}},{"name":"phone_region_code","in":"query","description":"The phone region code. See the [GetRegions] method","required":false,"schema":{"type":"string"}},{"name":"regulation_address_id","in":"query","description":"The regulation address ID","required":false,"schema":{"type":"integer"}},{"name":"verified","in":"query","description":"Whether to show only verified regulation address","required":false,"schema":{"type":"boolean"}},{"name":"in_progress","in":"query","description":"Whether to show only in progress regulation address","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_GetRegulationsAddress_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAvailableRegulations":{"post":{"operationId":"regulationAddress_GetAvailableRegulations","summary":"GetAvailableRegulations","description":"Searches for the available regulation for a link.\n\nAllowed roles: `Owner`, `Accountant`.\n\n**Example request:** Search available regulation address.","tags":["regulationAddress"],"parameters":[{"name":"country_code","in":"query","description":"The country code according to the **ISO 3166-1 alpha-2**","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":true,"schema":{"type":"string"}},{"name":"phone_region_code","in":"query","description":"The phone region code. See the [GetRegions] method","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_GetAvailableRegulations_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetCountries":{"post":{"operationId":"regulationAddress_GetCountries","summary":"GetCountries","description":"Gets all countries.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`, `Payer`.\n\n**Example request:** Get Germany.","tags":["regulationAddress"],"parameters":[{"name":"country_code","in":"query","description":"The country code according to the **ISO 3166-1 alpha-2**","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_GetCountries_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRegions":{"post":{"operationId":"regulationAddress_GetRegions","summary":"GetRegions","description":"Gets available regions in a country.\n\nAllowed roles: `Owner`, `Admin`, `Accountant`.\n\n**Example request:** Get regions with city AACHEN.","tags":["regulationAddress"],"parameters":[{"name":"country_code","in":"query","description":"The country code according to the **ISO 3166-1 alpha-2**","required":true,"schema":{"type":"string"}},{"name":"phone_category_name","in":"query","description":"The phone category name. See the [GetPhoneNumberCategories] method","required":true,"schema":{"type":"string"}},{"name":"city_name","in":"query","description":"The pattern of city's name","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The returned regions count","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/regulation-address_GetRegions_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddPushCredential":{"post":{"operationId":"pushCredentials_AddPushCredential","summary":"AddPushCredential","description":"Adds push credentials.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Add new Apple credentials.","tags":["pushCredentials"],"parameters":[{"name":"push_provider_name","in":"query","description":"The push provider name. The possible values are APPLE, APPLE_VOIP, GOOGLE, HUAWEI. **Required** unless **push_provider_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"push_provider_id","in":"query","description":"The push provider id. The possible values are: 1 — APPLE, 2 — GOOGLE, 3 — APPLE_VOIP, 5 — HUAWEI. **Required** unless **push_provider_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application id","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name that can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"credential_bundle","in":"query","description":"The bundle of Android/iOS/Huawei application","required":false,"schema":{"type":"string"}},{"name":"cert_file_name","in":"query","description":"The parameter is required, when set 'cert_content' as POST body. Credentials for APPLE push","required":false,"schema":{"type":"string"}},{"name":"cert_password","in":"query","description":"The secret password for private key. Credentials for APPLE push","required":false,"schema":{"type":"string"}},{"name":"is_dev_mode","in":"query","description":"Whether to use this certificate in apple's sandbox environment. Credentials for APPLE push","required":false,"schema":{"type":"boolean"}},{"name":"sender_id","in":"query","description":"The sender id, provided by Google. Credentials for GOOGLE push","required":false,"schema":{"type":"string"}},{"name":"server_key","in":"query","description":"The server key, provided by Google. Credentials for GOOGLE push","required":false,"schema":{"type":"string"}},{"name":"huawei_client_id","in":"query","description":"The client id, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}},{"name":"huawei_client_secret","in":"query","description":"The client secret, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}},{"name":"huawei_application_id","in":"query","description":"The application id, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/push-credentials_AddPushCredential_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"cert_content":{"type":"string","format":"binary","description":"Public and private keys in PKCS12 format. Credentials for APPLE push"},"service_account_file":{"type":"string","format":"binary","description":"The service account key file, provided by Google. Can be used instead of **server_key**. Credentials for GOOGLE push"}}}}}},"security":[{"JwtAuth":[]}]}},"/SetPushCredential":{"post":{"operationId":"pushCredentials_SetPushCredential","summary":"SetPushCredential","description":"Modifies push credentials.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Modify credentials.","tags":["pushCredentials"],"parameters":[{"name":"push_credential_id","in":"query","description":"The push credentials id","required":true,"schema":{"type":"integer"}},{"name":"cert_password","in":"query","description":"The secret password for private key. Credentials for APPLE push","required":false,"schema":{"type":"string"}},{"name":"is_dev_mode","in":"query","description":"Whether to use this certificate in apple's sandbox environment. Credentials for APPLE push","required":false,"schema":{"type":"boolean"}},{"name":"sender_id","in":"query","description":"The sender id, provided by Google. Credentials for GOOGLE push","required":false,"schema":{"type":"string"}},{"name":"server_key","in":"query","description":"The server key, provided by Google. Credentials for GOOGLE push","required":false,"schema":{"type":"string"}},{"name":"huawei_client_id","in":"query","description":"The client id, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}},{"name":"huawei_client_secret","in":"query","description":"The client secret, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}},{"name":"huawei_application_id","in":"query","description":"The application id, provided by Huawei. Credentials for HUAWEI push","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/push-credentials_SetPushCredential_Response_200"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"cert_content":{"type":"string","format":"binary","description":"Public and private keys in PKCS12 format. Credentials for APPLE push"},"service_account_file":{"type":"string","format":"binary","description":"The service account key file, provided by Google. Can be used instead of **server_key**. Credentials for GOOGLE push"}}}}}},"security":[{"JwtAuth":[]}]}},"/DelPushCredential":{"post":{"operationId":"pushCredentials_DelPushCredential","summary":"DelPushCredential","description":"Removes push credentials.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Remove credentials.","tags":["pushCredentials"],"parameters":[{"name":"push_credential_id","in":"query","description":"The push credentials id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/push-credentials_DelPushCredential_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetPushCredential":{"post":{"operationId":"pushCredentials_GetPushCredential","summary":"GetPushCredential","description":"Gets push credentials.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Get push credentials.","tags":["pushCredentials"],"parameters":[{"name":"push_credential_id","in":"query","description":"The push credentials id","required":false,"schema":{"type":"integer"}},{"name":"push_provider_name","in":"query","description":"The push provider name. The possible values are APPLE, APPLE_VOIP, GOOGLE, HUAWEI","required":false,"schema":{"type":"string"}},{"name":"push_provider_id","in":"query","description":"The push provider id. Can be used instead of **push_provider_name**. The possible values are: 1 — APPLE, 2 — GOOGLE, 3 — APPLE_VOIP, 5 — HUAWEI.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Name of the bound application","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"ID of the bound application","required":false,"schema":{"type":"integer"}},{"name":"with_cert","in":"query","description":"Whether to get the user's certificate","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/push-credentials_GetPushCredential_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindPushCredential":{"post":{"operationId":"pushCredentials_BindPushCredential","summary":"BindPushCredential","description":"Binds push credentials to applications.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Bind the push credential to the application.","tags":["pushCredentials"],"parameters":[{"name":"push_credential_id","in":"query","description":"The push credentials ID list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;). Use the 'all' value to select all applications","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/push-credentials_BindPushCredential_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddDialogflowKey":{"post":{"operationId":"dialogflowCredentials_AddDialogflowKey","summary":"AddDialogflowKey","description":"Adds a Dialogflow key.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.","tags":["dialogflowCredentials"],"parameters":[{"name":"application_id","in":"query","description":"The application ID","required":true,"schema":{"type":"string"}},{"name":"application_name","in":"query","description":"The application name. Can be used instead of **application_id**","required":false,"schema":{"type":"string"}},{"name":"json_credentials","in":"query","description":"Dialogflow credentials, provided by JWK (Json web key)","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"The Dialogflow key's description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialogflow-credentials_AddDialogflowKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetDialogflowKey":{"post":{"operationId":"dialogflowCredentials_SetDialogflowKey","summary":"SetDialogflowKey","description":"Edits a Dialogflow key.","tags":["dialogflowCredentials"],"parameters":[{"name":"dialogflow_key_id","in":"query","description":"The Dialogflow key's ID","required":true,"schema":{"type":"integer"}},{"name":"description","in":"query","description":"The Dialogflow key's description. To clear previously set description leave the parameter blank or put whitespaces only","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialogflow-credentials_SetDialogflowKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelDialogflowKey":{"post":{"operationId":"dialogflowCredentials_DelDialogflowKey","summary":"DelDialogflowKey","description":"Removes a Dialogflow key.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Remove key.","tags":["dialogflowCredentials"],"parameters":[{"name":"dialogflow_key_id","in":"query","description":"The Dialogflow key's ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialogflow-credentials_DelDialogflowKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetDialogflowKeys":{"post":{"operationId":"dialogflowCredentials_GetDialogflowKeys","summary":"GetDialogflowKeys","description":"Gets Dialogflow keys.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Get push credentials.","tags":["dialogflowCredentials"],"parameters":[{"name":"dialogflow_key_id","in":"query","description":"Dialogflow key's ID","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Name of the bound application","required":false,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"ID of the bound application","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialogflow-credentials_GetDialogflowKeys_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/BindDialogflowKeys":{"post":{"operationId":"dialogflowCredentials_BindDialogflowKeys","summary":"BindDialogflowKeys","description":"Binds a Dialogflow key to the specified applications.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** Bind a Dialogflow key to the application.","tags":["dialogflowCredentials"],"parameters":[{"name":"dialogflow_key_id","in":"query","description":"The Dialogflow key's ID","required":true,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application ID list separated by semicolons (;). Use the 'all' value to select all applications","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"bind","in":"query","description":"Whether to bind or unbind (set true or false respectively)","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialogflow-credentials_BindDialogflowKeys_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/A2PGetSmsHistory":{"post":{"operationId":"sms_a2p-get-sms-history","summary":"A2PGetSmsHistory","description":"Gets the history of sent/or received A2P SMS.\n\nAllowed roles: `Owner`, `Admin`, `CallsSMS`.\n\n**Example request:** Get messages that had been sent to number 12345678222 starting from March 1, 2019. Number of resulting rows is limited to 2.","tags":["SMS"],"parameters":[{"name":"source_number","in":"query","description":"The source phone number","required":false,"schema":{"type":"string"}},{"name":"destination_number","in":"query","description":"The destination phone number","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"from_date","in":"query","description":"Date from which the search is to start. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Date from which the search is to end. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC","required":false,"schema":{"type":"string"}},{"name":"output","in":"query","description":"The output format. The following values available: **json**, **csv**, **xls**. The default value is **json**","required":false,"schema":{"type":"string","default":"json"}},{"name":"delivery_status","in":"query","description":"The delivery status ID: QUEUED - 1, DISPATCHED - 2, ABORTED - 3, REJECTED - 4, DELIVERED - 5, FAILED - 6, EXPIRED - 7, UNKNOWN - 8","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_a2p-get-sms-history_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/A2PSendSms":{"post":{"operationId":"sms_a2p-send-sms","summary":"A2PSendSms","description":"Sends an A2P SMS message from the application to customers. A SenderID is required for A2P messages. Please contact support for installing a SenderID.\n\nAllowed roles: `CallsSMS`.\n\n**Example request:** Send the SMS message with the text \"Test message\" from the phone number 447443332211 to the phone numbers 447443332212 and 447443332213.","tags":["SMS"],"parameters":[{"name":"src_number","in":"query","description":"The SenderID for outgoing SMS. Please contact support for installing a SenderID","required":true,"schema":{"type":"string"}},{"name":"dst_numbers","in":"query","description":"The destination phone numbers separated by semicolons (;). The maximum number of these phone numbers is 100","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"text","in":"query","description":"The message text, up to 1600 characters. We split long messages greater than 160 GSM-7 characters or 70 UTF-16 characters into multiple segments. Each segment is charged as one message","required":true,"schema":{"type":"string"}},{"name":"store_body","in":"query","description":"Whether to store outgoing message texts. Default value is false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_a2p-send-sms_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/ControlSms":{"post":{"operationId":"sms_ControlSms","summary":"ControlSms","description":"Enables or disables sending and receiving SMS for the phone number. Can be used only for phone numbers with SMS support, which is indicated by the **is_sms_supported** property in the objects returned by the [GetPhoneNumbers] Management API. Each incoming SMS message is charged according to the pricing. If enabled, SMS can be sent from this phone number via the [SendSmsMessage] Management API and received via the [InboundSmsCallback] property of the HTTP callback. See this article for HTTP callback details.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Accountant`.\n\n**Example request:** Enable work with SMS for phone number 447443332211.","tags":["SMS"],"parameters":[{"name":"phone_number","in":"query","description":"The phone number","required":true,"schema":{"type":"string"}},{"name":"command","in":"query","description":"The SMS control command. The following values are possible: enable, disable","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_ControlSms_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSmsHistory":{"post":{"operationId":"sms_GetSmsHistory","summary":"GetSmsHistory","description":"Gets the history of sent and/or received SMS.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `Supervisor`, `Accountant`, `CallsSMS`.\n\n**Example request:** Get messages that had been sent to number 12345678222 starting from March 1, 2019. Number of resulting rows is limited to 2.","tags":["SMS"],"parameters":[{"name":"source_number","in":"query","description":"The source phone number","required":false,"schema":{"type":"string"}},{"name":"destination_number","in":"query","description":"The destination phone number","required":false,"schema":{"type":"string"}},{"name":"direction","in":"query","description":"Sent or received SMS. Possible values: 'IN', 'OUT', 'in, 'out'. Leave blank to get both incoming and outgoing messages","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Maximum number of resulting rows fetched. Must be not bigger than 1000. If left blank, then the default value of 1000 is used","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"from_date","in":"query","description":"Date from which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC","required":false,"schema":{"type":"string"}},{"name":"to_date","in":"query","description":"Date until which to perform search. Format is 'yyyy-MM-dd HH:mm:ss', time zone is UTC","required":false,"schema":{"type":"string"}},{"name":"output","in":"query","description":"The output format. The following values available: **json**, **csv**, **xls**. The default value is **json**","required":false,"schema":{"type":"string","default":"json"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_GetSmsHistory_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SendSmsMessage":{"post":{"operationId":"sms_SendSmsMessage","summary":"SendSmsMessage","description":"Sends an SMS message between two phone numbers. The source phone number should be purchased from Voximplant and support SMS (which is indicated by the **is_sms_supported** property in the objects returned by the [GetPhoneNumbers] Management API) and SMS should be enabled for it via the [ControlSms] Management API. SMS messages can be received via HTTP callbacks, see this article for details.\n\nAllowed roles: `Owner`, `Admin`, `Developer`, `CallsSMS`.\n\n**Example request:** Send the SMS message with the text \"Test message\" from the phone number 447443332211 to the phone number 447443332212.","tags":["SMS"],"parameters":[{"name":"source","in":"query","description":"The source phone number","required":true,"schema":{"type":"string"}},{"name":"destination","in":"query","description":"The destination phone number","required":true,"schema":{"type":"string"}},{"name":"sms_body","in":"query","description":"The message text, up to 765 characters. We split long messages greater than 160 GSM-7 characters or 70 UTF-16 characters into multiple segments. Each segment is charged as one message","required":true,"schema":{"type":"string"}},{"name":"store_body","in":"query","description":"Whether to store outgoing message texts. Default value is false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_SendSmsMessage_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRecordStorages":{"post":{"operationId":"recordStorages_GetRecordStorages","summary":"GetRecordStorages","description":"Gets the record storages.\n\n**Example request:** Get all record storages.","tags":["recordStorages"],"parameters":[{"name":"record_storage_id","in":"query","description":"The record storage ID list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"record_storage_name","in":"query","description":"The record storage name list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/record-storages_GetRecordStorages_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/CreateKey":{"post":{"operationId":"roleSystem_CreateKey","summary":"CreateKey","description":"Creates a public/private key pair. You can optionally specify one or more roles for the key. You can find all available service account roles [here](/platform/management-api/overview#service-account-roles).\n\n**Example request:** Create a key pair.","tags":["roleSystem"],"parameters":[{"name":"description","in":"query","description":"The key's description","required":false,"schema":{"type":"string"}},{"name":"key_name","in":"query","description":"The key's name, up to 50 characters. Cannot be empty","required":false,"schema":{"type":"string"}},{"name":"role_id","in":"query","description":"The role ID list separated by semicolons (;). Use it instead of **role_name**, but not combine with","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;). Use it instead of **role_id**, but not combine with","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_CreateKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetKeys":{"post":{"operationId":"roleSystem_GetKeys","summary":"GetKeys","description":"Gets key info of the specified account.\n\n**Example request:** Get keys info of the specified account.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":false,"schema":{"type":"string"}},{"name":"with_roles","in":"query","description":"Whether to show roles for the key","required":false,"schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetKeys_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/UpdateKey":{"post":{"operationId":"roleSystem_UpdateKey","summary":"UpdateKey","description":"Updates info of the specified key.\n\n**Example request:** Create a new subuser for account_id = 1.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"The key's description","required":true,"schema":{"type":"string"}},{"name":"key_name","in":"query","description":"The key's name, up to 50 characters. Cannot be empty","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_UpdateKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DeleteKey":{"post":{"operationId":"roleSystem_DeleteKey","summary":"DeleteKey","description":"Deletes the specified key.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_DeleteKey_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetKeyRoles":{"post":{"operationId":"roleSystem_SetKeyRoles","summary":"SetKeyRoles","description":"Set roles for the specified key.\n\n**Example request:** Set roles 1, 2, 3 for the key.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"query","description":"The role id list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_SetKeyRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetKeyRoles":{"post":{"operationId":"roleSystem_GetKeyRoles","summary":"GetKeyRoles","description":"Gets roles of the specified key.\n\n**Example request:** Get roles of the key.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":true,"schema":{"type":"string"}},{"name":"with_expanded_roles","in":"query","description":"Whether to show the roles' additional properties","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetKeyRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/RemoveKeyRoles":{"post":{"operationId":"roleSystem_RemoveKeyRoles","summary":"RemoveKeyRoles","description":"Removes the specified roles of a key.\n\n**Example request:** Remove the roles 1, 2, 3 from the key.","tags":["roleSystem"],"parameters":[{"name":"key_id","in":"query","description":"The key's ID","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"query","description":"The role id list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_RemoveKeyRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddSubUser":{"post":{"operationId":"roleSystem_AddSubUser","summary":"AddSubUser","description":"Creates a subuser.\n\nAllowed roles: `Owner`.\n\n**Example request:** Create a new subuser for account_id = 1.","tags":["roleSystem"],"parameters":[{"name":"new_subuser_name","in":"query","description":"The new subuser login for management api authentication, should be unique within the Voximplant account. The login specified is always converted to lowercase","required":true,"schema":{"type":"string"}},{"name":"new_subuser_password","in":"query","description":"The new subuser password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":true,"schema":{"type":"string"}},{"name":"role_id","in":"query","description":"The role id list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"description","in":"query","description":"Description of a new subuser","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_AddSubUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSubUsers":{"post":{"operationId":"roleSystem_GetSubUsers","summary":"GetSubUsers","description":"Gets subusers.\n\nAllowed roles: `Owner`.\n\n**Example request:** Get subusers info.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":false,"schema":{"type":"integer"}},{"name":"with_roles","in":"query","description":"Whether to show subuser's roles","required":false,"schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"The first **N** records are skipped in the output","required":false,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"The max returning record count","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetSubUsers_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetSubUserInfo":{"post":{"operationId":"roleSystem_SetSubUserInfo","summary":"SetSubUserInfo","description":"Edits a subuser.\n\n**Example request:** Edit the password and description for the subuser with id = 12 from account_id = 1.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":true,"schema":{"type":"integer"}},{"name":"old_subuser_password","in":"query","description":"The subuser old password. It is required if __new_subuser_password__ is specified","required":false,"schema":{"type":"string"}},{"name":"new_subuser_password","in":"query","description":"The new user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"The new subuser description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_SetSubUserInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelSubUser":{"post":{"operationId":"roleSystem_DelSubUser","summary":"DelSubUser","description":"Deletes a subuser.\n\nAllowed roles: `Owner`.\n\n**Example request:** Delete the subuser with id = 12 from account_id = 1.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_DelSubUser_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetSubUserRoles":{"post":{"operationId":"roleSystem_SetSubUserRoles","summary":"SetSubUserRoles","description":"Adds the specified roles for a subuser.\n\nAllowed roles: `Owner`.\n\n**Example request:** Add the roles 1, 2, 3 to the subuser with id = 12.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":true,"schema":{"type":"integer"}},{"name":"role_id","in":"query","description":"The role id list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_SetSubUserRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSubUserRoles":{"post":{"operationId":"roleSystem_GetSubUserRoles","summary":"GetSubUserRoles","description":"Gets the subuser's roles.\n\nAllowed roles: `Owner`.\n\n**Example request:** Get subuser's roles.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":true,"schema":{"type":"integer"}},{"name":"with_expanded_roles","in":"query","description":"Whether to show the roles' additional properties","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetSubUserRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/RemoveSubUserRoles":{"post":{"operationId":"roleSystem_RemoveSubUserRoles","summary":"RemoveSubUserRoles","description":"Removes the specified roles of a subuser.\n\nAllowed roles: `Owner`.\n\n**Example request:** Remove roles 1,2,3 from the subuser with id = 12.","tags":["roleSystem"],"parameters":[{"name":"subuser_id","in":"query","description":"The subuser's ID","required":true,"schema":{"type":"integer"}},{"name":"role_id","in":"query","description":"The role id list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"role_name","in":"query","description":"The role name list separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"force","in":"query","description":"Whether to remove roles from all subuser keys","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_RemoveSubUserRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRoles":{"post":{"operationId":"roleSystem_GetRoles","summary":"GetRoles","description":"Gets all roles.\n\n**Example request:** Get all roles.","tags":["roleSystem"],"parameters":[{"name":"group_name","in":"query","description":"The role group","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetRoles_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetRoleGroups":{"post":{"operationId":"roleSystem_GetRoleGroups","summary":"GetRoleGroups","description":"Gets role groups.\n\n**Example request:** Get all role groups.","tags":["roleSystem"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/role-system_GetRoleGroups_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetKeyValueItem":{"post":{"operationId":"keyValueStorage_SetKeyValueItem","summary":"SetKeyValueItem","description":"Creates or updates a key-value pair. If an existing key is passed, the method returns the existing item and changes the value if needed. The keys should be unique within a Voximplant application.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** SetKeyValueItem example.","tags":["keyValueStorage"],"parameters":[{"name":"key","in":"query","description":"Key, up to 200 characters. A key can contain a namespace that is written before the ':' symbol, for example, test:1234. Thus, namespace 'test' can be used as a pattern in the [GetKeyValueItems](/api-reference/management-api/reference/key-value-storage/get-key-value-items) and [GetKeyValueKeys](/api-reference/management-api/reference/key-value-storage/get-key-value-keys) methods to find the keys with the same namespace.\n\nThe key should match the following regular expression: `^[a-zA-Z0-9а-яА-ЯёЁ_\\-:;.#+]*$`","required":true,"schema":{"type":"string"}},{"name":"value","in":"query","description":"Value for the specified key, up to 2000 characters","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"Application ID","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name","required":false,"schema":{"type":"string"}},{"name":"ttl","in":"query","description":"Key expiry time in seconds. The value is in range of 0..7,776,000 (90 days), the default value is 30 days (2,592,000 seconds). The TTL is converted to an **expires_at** Unix timestamp field as part of the storage object. Note that one of the two parameters (ttl or expires_at) must be set","required":false,"schema":{"type":"integer"}},{"name":"expires_at","in":"query","description":"Expiration date based on **ttl** (timestamp without milliseconds). Note that one of the two parameters (ttl or expires_at) must be set","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key-value-storage_SetKeyValueItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelKeyValueItem":{"post":{"operationId":"keyValueStorage_DelKeyValueItem","summary":"DelKeyValueItem","description":"Deletes the specified key-value pair from the storage.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** DelKeyValueItem example.","tags":["keyValueStorage"],"parameters":[{"name":"key","in":"query","description":"Key, up to 200 characters","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key-value-storage_DelKeyValueItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetKeyValueItem":{"post":{"operationId":"keyValueStorage_GetKeyValueItem","summary":"GetKeyValueItem","description":"Gets the specified key-value pair from the storage.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** GetKeyValueItem example.","tags":["keyValueStorage"],"parameters":[{"name":"key","in":"query","description":"Key, up to 200 characters","required":true,"schema":{"type":"string"}},{"name":"application_id","in":"query","description":"The application ID","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key-value-storage_GetKeyValueItem_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetKeyValueItems":{"post":{"operationId":"keyValueStorage_GetKeyValueItems","summary":"GetKeyValueItems","description":"Gets all the key-value pairs in which the keys begin with a pattern.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** GetKeyValueItems example.","tags":["keyValueStorage"],"parameters":[{"name":"key","in":"query","description":"Namespace that keys should contain, up to 200 characters","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of items to show per page with a maximum value of 50. Default value is 10","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application ID","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key-value-storage_GetKeyValueItems_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetKeyValueKeys":{"post":{"operationId":"keyValueStorage_GetKeyValueKeys","summary":"GetKeyValueKeys","description":"Gets all the keys of key-value pairs.\n\nAllowed roles: `Owner`, `Admin`, `Developer`.\n\n**Example request:** GetKeyValueKeys example.","tags":["keyValueStorage"],"parameters":[{"name":"key","in":"query","description":"Namespace that keys should contain, up to 200 characters","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of items to show per page with a maximum value of 50. Default value is 10","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of items to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0","required":false,"schema":{"type":"integer"}},{"name":"application_id","in":"query","description":"The application ID","required":true,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"The application name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/key-value-storage_GetKeyValueKeys_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetAccountInvoices":{"post":{"operationId":"invoices_GetAccountInvoices","summary":"GetAccountInvoices","description":"Gets all invoices for the specified USD or EUR account.\n\n**Example request:** GetAccountInvoices example.","tags":["Invoices"],"parameters":[{"name":"count","in":"query","description":"Number of invoices to show per page. Default value is 20","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of invoices to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoices_GetAccountInvoices_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DownloadInvoice":{"post":{"operationId":"invoices_DownloadInvoice","summary":"DownloadInvoice","description":"Downloads the specified invoice.\n\n**Example request:** Download the invoice with id = 1.","tags":["Invoices"],"parameters":[{"name":"invoice_id","in":"query","description":"Invoice ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoices_DownloadInvoice_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/AddSecret":{"post":{"operationId":"secrets_AddSecret","summary":"AddSecret","description":"Adds a new secret.\n\n**Example request:** Add a new secret to application 1","tags":["Secrets"],"parameters":[{"name":"application_id","in":"query","description":"Application ID to add the secret to. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"secret_name","in":"query","description":"Secret name. The name must start with a Latin letter and can contain up to 64 characters, including Latin letters, digits and underscores","required":true,"schema":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","maxLength":64}},{"name":"secret_value","in":"query","description":"Secret value. Maximum length is 8192 characters","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Optional. Secret description. When processing, the length is truncated to the first 200 characters","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets_AddSecret_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/DelSecret":{"post":{"operationId":"secrets_DelSecret","summary":"DelSecret","description":"Deletes an existing secret.\n\n**Example request:** Delete secret with ID 10.","tags":["Secrets"],"parameters":[{"name":"application_id","in":"query","description":"Application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"secret_id","in":"query","description":"IDs to delete. A list separated by semicolons (;). Use the 'all' value to delete all secrets","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"secret_name","in":"query","description":"Secret names to delete. List separated by semicolons (;)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets_DelSecret_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSecretValue":{"post":{"operationId":"secrets_GetSecretValue","summary":"GetSecretValue","description":"Gets the value of a specific secret.\n\n**Example request:** Get the value of secret 10.","tags":["Secrets"],"parameters":[{"name":"application_id","in":"query","description":"Application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"secret_id","in":"query","description":"Secret ID. **Required** unless **secret_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"secret_name","in":"query","description":"Secret name. **Required** unless **secret_id** is provided.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets_GetSecretValue_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/GetSecrets":{"post":{"operationId":"secrets_GetSecrets","summary":"GetSecrets","description":"Gets the list of an application's secrets.\n\n**Example request:** Get secrets of application 1.","tags":["Secrets"],"parameters":[{"name":"application_id","in":"query","description":"Application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"secret_name_part","in":"query","description":"Filter by the secret name part","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"Maximum returning record number","required":false,"schema":{"type":"integer","default":20}},{"name":"offset","in":"query","description":"First **N** records to be skipped in the output","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets_GetSecrets_Response_200"}}}}},"security":[{"JwtAuth":[]}]}},"/SetSecretInfo":{"post":{"operationId":"secrets_SetSecretInfo","summary":"SetSecretInfo","description":"Edits a secret's parameters.\n\n**Example request:** Update the value for secret 10.","tags":["Secrets"],"parameters":[{"name":"application_id","in":"query","description":"Application ID. **Required** unless **application_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"application_name","in":"query","description":"Application name. **Required** unless **application_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"secret_id","in":"query","description":"Secret ID to edit. **Required** unless **secret_name** is provided.","required":false,"schema":{"type":"integer"}},{"name":"secret_name","in":"query","description":"Secret name. **Required** unless **secret_id** is provided.","required":false,"schema":{"type":"string"}},{"name":"new_secret_name","in":"query","description":"New secret name. The name must start with a Latin letter and can contain up to 64 characters, including Latin letters, digits and underscores","required":false,"schema":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","maxLength":64}},{"name":"secret_value","in":"query","description":"Secret value. Maximum length is 8192 characters","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Secret description. When processing, the length is truncated to the first 200 characters","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets_SetSecretInfo_Response_200"}}}}},"security":[{"JwtAuth":[]}]}}},"tags":[{"name":"Accounts"},{"name":"Applications"},{"name":"Users"},{"name":"callLists"},{"name":"Scenarios"},{"name":"Rules"},{"name":"History"},{"name":"phoneNumbers"},{"name":"pstnBlacklist"},{"name":"sipWhiteList"},{"name":"sipRegistration"},{"name":"wabPhoneNumbers"},{"name":"CallerIDs"},{"name":"OutboundTestNumbers"},{"name":"Queues"},{"name":"SmartQueue"},{"name":"Skills"},{"name":"adminUsers"},{"name":"adminRoles"},{"name":"authorizedIps"},{"name":"regulationAddress"},{"name":"pushCredentials"},{"name":"dialogflowCredentials"},{"name":"SMS"},{"name":"recordStorages"},{"name":"roleSystem"},{"name":"keyValueStorage"},{"name":"Invoices"},{"name":"Secrets"}],"servers":[{"url":"https://api.voximplant.com/platform_api","description":"https://api.voximplant.com/platform_api"}],"components":{"schemas":{"BillingLimitInfoType":{"type":"object","properties":{"min_amount":{"type":"number","format":"double","description":"The minimum amount"},"currency":{"type":"string","description":"The currency"}},"description":"The payment limit info.","title":"BillingLimitInfoType"},"BankCardBillingLimitInfoType":{"type":"object","properties":{"min_amount":{"type":"number","format":"double","description":"The minimum amount"},"currency":{"type":"string","description":"The currency"},"max_day_payment":{"type":"number","format":"double"}},"description":"The payment limit info.","title":"BankCardBillingLimitInfoType"},"BillingLimitsType":{"type":"object","properties":{"robokassa":{"$ref":"#/components/schemas/BillingLimitInfoType","description":"The Robokassa limits"},"bank_card":{"$ref":"#/components/schemas/BankCardBillingLimitInfoType","description":"The bank card limits"},"invoice":{"$ref":"#/components/schemas/BillingLimitInfoType","description":"The invoice limits"}},"description":"The payments limits applicable to each payment method. Payments that are beyond limits are declined.","title":"BillingLimitsType"},"AccountInfoType":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account's ID"},"account_name":{"type":"string","description":"The account's name"},"account_email":{"type":"string","description":"The account's email"},"api_key":{"type":"string","description":"The account API key. Use password or api_key authentication to show the api_key"},"account_first_name":{"type":"string","description":"The first name"},"account_last_name":{"type":"string","description":"The last name"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC account created time in 24-h format: YYYY-MM-DD HH:mm:ss"},"language_code":{"type":"string","description":"The notification language code (2 symbols, ISO639-1). Examples: en, ru"},"location":{"type":"string","description":"The account location (timezone). Examples: America/Los_Angeles, Etc/GMT-8, Etc/GMT+10"},"min_balance_to_notify":{"type":"number","format":"double","description":"The min balance value to notify by email or SMS"},"account_notifications":{"type":"boolean","description":"Whether Voximplant notifications are required"},"tariff_changing_notifications":{"type":"boolean","description":"Whether Voximplant plan changing notifications are required"},"news_notifications":{"type":"boolean","description":"Whether Voximplant news notifications are required"},"billing_address_name":{"type":"string","description":"The company or businessman name"},"billing_address_country_code":{"type":"string","description":"The billing address country code (2 symbols, ISO 3166-1 alpha-2). Examples: US, RU, GB"},"billing_address_address":{"type":"string","description":"The office address"},"billing_address_zip":{"type":"string","description":"The office ZIP"},"billing_address_phone":{"type":"string","description":"The office phone number"},"billing_address_state":{"type":"string","description":"The office state (US) or province (Canada), up to 100 characters. Examples: California, Illinois, British Columbia"},"active":{"type":"boolean","description":"Whether the account is active"},"frozen":{"type":"boolean","description":"Whether account is blocked by Voximplant admins"},"balance":{"type":"number","format":"double","description":"The account's money"},"credit_limit":{"type":"number","format":"double","description":"The account's credit limit"},"currency":{"type":"string","description":"The currency code (USD, RUR, EUR...)"},"support_robokassa":{"type":"boolean","description":"Whether Robokassa payments are allowed"},"support_bank_card":{"type":"boolean","description":"Whether Bank card payments are allowed"},"support_invoice":{"type":"boolean","description":"Whether Bank invoices are allowed"},"account_custom_data":{"type":"string","description":"The custom data"},"access_entries":{"type":"array","items":{"type":"string"},"description":"The allowed access entries (the API function names)"},"with_access_entries":{"type":"boolean","default":false,"description":"Whether the admin user permissions are granted"},"callback_url":{"type":"string","description":"If URL is specified, Voximplant cloud makes HTTP POST requests to it when something happens. For a full list of reasons see the **type** field of the [AccountCallback] structure. The HTTP request has a JSON-encoded body that conforms to the [AccountCallbacks] structure"},"callback_salt":{"type":"string","description":"If salt string is specified, each HTTP request made by the Voximplant cloud toward the **callback_url** has a **salt** field set to MD5 hash of account information and salt. That hash can be used be a developer to ensure that HTTP request is made by the Voximplant cloud"},"send_js_error":{"type":"boolean","description":"Whether to send an email when a JS error occurs"},"billing_limits":{"$ref":"#/components/schemas/BillingLimitsType","description":"The payments limits applicable to each payment method"},"a2p_sms_enabled":{"type":"boolean","description":"Whether to activate one-way SMS"},"max_sip_registrations":{"type":"integer"},"fixed_balance":{"type":"number","format":"double"},"money_on_hold":{"type":"number","format":"double"},"bank_card_provider":{"type":"string"},"enabled_3ds":{"type":"boolean"},"record_storage_id":{"type":"integer"},"mobile_phone":{"type":"string"},"allow_invoice":{"type":"boolean"},"is_bank_card_auto_charge_prohibited":{"type":"boolean"},"taxpayer_type":{"type":"string"},"custom_pricing":{"type":"boolean"},"grace_credit":{"type":"integer"},"record_storage_name":{"type":"string"},"credit_limit_aware_balance_notifications":{"type":"boolean"},"live_balance":{"type":"number","format":"double"}},"description":"The [GetAccountInfo] function result.","title":"AccountInfoType"},"accounts_GetAccountInfo_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/AccountInfoType","description":"Account's info as the [AccountInfoType] object instance"},"api_address":{"type":"string","description":"The preferred address for the Management API requests"},"debugger_address":{"type":"string"}},"title":"accounts_GetAccountInfo_Response_200"},"accounts_SetAccountInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"accounts_SetAccountInfo_Response_200"},"accounts_SetChildAccountInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"accounts_SetChildAccountInfo_Response_200"},"ExchangeRatesType":{"type":"object","properties":{"RUR":{"type":"number","format":"double","description":"The RUR exchange rate"},"KZT":{"type":"number","format":"double","description":"The KZT exchange rate"},"EUR":{"type":"number","format":"double","description":"The EUR exchange rate"},"USD":{"type":"number","format":"double","description":"The USD exchange rate. It is always equal to 1"}},"description":"The [GetCurrencyRate] function result.","title":"ExchangeRatesType"},"accounts_GetCurrencyRate_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/ExchangeRatesType","description":"The exchange rates"}},"title":"accounts_GetCurrencyRate_Response_200"},"ResourceParams":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string"},"description":"The allowed parameter prefixes. Example: 7495"},"forbidden":{"type":"array","items":{"type":"string"},"description":"The forbidden parameter prefixes. Example: 7800"},"requested":{"type":"array","items":{"type":"string"},"description":"The requested parameters. Example: 79263331122"}},"description":"The available resource parameters.","title":"ResourceParams"},"PriceGroup":{"type":"object","properties":{"price_group_name":{"type":"string","description":"The price group name. Example: Russia Mobile"},"price_group_id":{"type":"integer","description":"The price group ID"},"price":{"type":"number","format":"double","description":"The price for the 'num_resources_per_price' resource count"},"num_resources_per_price":{"type":"integer","description":"The resource count per price"},"quantum":{"type":"integer","description":"The resource rounding quantum"},"params":{"$ref":"#/components/schemas/ResourceParams","description":"The available resource parameters"},"quant":{"type":"integer"}},"description":"The resource price group.","title":"PriceGroup"},"ResourcePrice":{"type":"object","properties":{"resource_type":{"type":"string","description":"The resource type name. The possible values are AUDIOHDCONFERENCE, AUDIOHDRECORD, AUDIORECORD, CALLLIST, CALLSESSION, DIALOGFLOW, IM, PSTN_IN_ALASKA, PSTN_IN_GB, PSTN_IN_GEOGRAPHIC, PSTN_IN_GEO_PH, PSTN_IN_RU, PSTN_IN_RU_TOLLFREE, PSTN_INTERNATIONAL, PSTNINTEST, PSTN_IN_TF_AR, PSTN_IN_TF_AT, PSTN_IN_TF_AU, PSTN_IN_TF_BE, PSTN_IN_TF_BR, PSTN_IN_TF_CA, PSTN_IN_TF_CO, PSTN_IN_TF_CY, PSTN_IN_TF_DE, PSTN_IN_TF_DK, PSTN_IN_TF_DO, PSTN_IN_TF_FI, PSTN_IN_TF_FR, PSTN_IN_TF_GB, PSTN_IN_TF_HR, PSTN_IN_TF_HU, PSTN_IN_TF_IL, PSTN_IN_TF_LT, PSTN_IN_TF_PE, PSTN_IN_TF_US, PSTN_IN_US, PSTNOUT, PSTNOUT_EEA, PSTNOUTEMERG, PSTNOUT_KZ, PSTNOUT_LOCAL, PSTN_OUT_LOCAL_RU, RELAYED_TRAFFIC, SIPOUT, SIPOUTVIDEO, SMSINPUT, SMSOUT, SMSOUT_INTERNATIONAL, TRANSCRIPTION, TTS_TEXT_GOOGLE, USER_LOGON, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, VOIPIN, VOIPOUT, VOIPOUTVIDEO, ASR, ASR_GOOGLE_ENHANCED"},"price_groups":{"type":"array","items":{"$ref":"#/components/schemas/PriceGroup"},"description":"The price group array"}},"description":"The [GetResourcePrice] function result.","title":"ResourcePrice"},"accounts_GetResourcePrice_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ResourcePrice"},"description":"The resource prices"}},"title":"accounts_GetResourcePrice_Response_200"},"SubscriptionTemplateType":{"type":"object","properties":{"subscription_template_id":{"type":"integer","description":"Subscription's template ID"},"currency":{"type":"string","description":"Subscription's currency"},"installation_price":{"type":"number","format":"double","description":"Subscription's installation price (without the first monthly fee)"},"installation_price_in_currency":{"type":"integer","description":"Subscription's installation price in the original currency"},"price":{"type":"number","format":"double","description":"Subscription's monthly fee, including taxes and discounts"},"price_in_currency":{"type":"number","format":"double","description":"Subscription's monthly fee in the original currency"},"period":{"type":"string","description":"Charge period in 24-h format: Y-M-D H:m:s. Example: 0-1-0 0:0:0 is 1 month"},"subscription_template_type":{"type":"string","description":"Subscription template type. The following values are possible: PHONE_NUM, SIP_REGISTRATION"},"subscription_template_name":{"type":"string","description":"Subscription template name (example: SIP registration, Phone GB, Phone RU 495...)"},"required_verification":{"type":"string","description":"Whether verification is required for the account"},"verification_status":{"type":"string","description":"Verification status. Possible values are REQUIRED, IN_PROGRESS, VERIFIED, NOT_REQUIRED"},"installation_tax_reserve":{"type":"integer","description":"Phone number's installation tax reserve"},"tax_reserve":{"type":"integer","description":"Phone number's tax reserve"}},"description":"The subscription template info.","title":"SubscriptionTemplateType"},"accounts_GetSubscriptionPrice_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionTemplateType"},"description":"The subscription template prices"},"total_count":{"type":"integer"},"count":{"type":"integer"}},"title":"accounts_GetSubscriptionPrice_Response_200"},"accounts_GetChildrenAccounts_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountInfoType"}},"total_count":{"type":"integer","description":"The total found user count"},"count":{"type":"integer","description":"The returned user count"}},"title":"accounts_GetChildrenAccounts_Response_200"},"SubscriptionsToChargeType":{"type":"object","properties":{"subscription_amount":{"type":"number","format":"double","description":"The money amount to charge in the specified currency"},"subscription_type":{"type":"string","description":"The subscription type, example: PHONE_NUM, SIP_REGISTRATION"},"subscription_description":{"type":"string","description":"The subscription description (details). Example: the subscribed phone number"},"subscription_auto_charge":{"type":"boolean","description":"Whether the subscription charges automatically"},"subscription_next_renewal":{"type":"string","description":"Date string as returned by the Management API.\n\nThe next renewal date, format: YYYY-MM-DD. Displayed for only verified phone numbers"}},"description":"The [GetMoneyAmountToCharge] function result field.","title":"SubscriptionsToChargeType"},"GetMoneyAmountToChargeResult":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The money amount of the subscriptions + plan + negative_balance in the specified currency"},"min_amount":{"type":"number","format":"double","description":"The 'amount' value minus the positive account balance in the specified currency"},"bank_card_amount_usd":{"type":"number","format":"double","description":"Exists if bank card payments are allowed. It is the maximum of the 'amount' in USD and the min_card_payment (10$)"},"min_bank_card_amount_usd":{"type":"number","format":"double","description":"Exists if bank card payments are allowed. It is the maximum of the 'min_amount' in USD and the min_card_payment (10$)"},"robokassa_amount_rub":{"type":"number","format":"double","description":"Exists if robokassa payments are allowed. It is the maximum of the 'min_amount' in RUR and the min_robokassa_payment (500 RUR)"},"min_robokassa_amount_rub":{"type":"number","format":"double","description":"Exists if robokassa payments are allowed. It is the maximum of the 'min_amount' in RUR and the min_robokassa_payment (500 RUR)"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionsToChargeType"},"description":"The subscriptions to charge"}},"description":"The [GetMoneyAmountToCharge] function result.","title":"GetMoneyAmountToChargeResult"},"accounts_GetMoneyAmountToCharge_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/GetMoneyAmountToChargeResult","description":"Result"}},"title":"accounts_GetMoneyAmountToCharge_Response_200"},"ShortAccountInfoType":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account's ID"},"frozen":{"type":"boolean","description":"Whether account is blocked by Voximplant admins or not"},"balance":{"type":"number","format":"double","description":"The account's money"},"currency":{"type":"string","description":"The currency code (USD, RUR, EUR...)"}},"description":"The short account info.","title":"ShortAccountInfoType"},"accounts_ChangeAccountPlan_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"account_info":{"$ref":"#/components/schemas/ShortAccountInfoType","description":"The current account state"}},"title":"accounts_ChangeAccountPlan_Response_200"},"AccountPlanPackageType":{"type":"object","properties":{"price_group_id":{"type":"array","items":{"type":"integer"},"description":"The price group IDs"},"package_name":{"type":"string","description":"The package name"},"may_overrun":{"type":"boolean","description":"Whether overrun is enabled"},"overrun_price":{"type":"number","format":"double","description":"The overrun amount"},"overrun_resources":{"type":"integer","description":"The number of resources (e.g., messages) per overrun"},"resource_left":{"type":"integer","description":"The resource left in the package"},"package_size":{"type":"integer","description":"The current package size (including overrun)"},"orig_package_size":{"type":"integer","description":"The original package size (excluding overrun)"}},"description":"The account plan package info.","title":"AccountPlanPackageType"},"AccountPlanType":{"type":"object","properties":{"plan_subscription_template_id":{"type":"integer","description":"The current plan ID"},"next_charge":{"type":"string","description":"Date string as returned by the Management API.\n\nThe next charge date, format: YYYY-MM-DD"},"plan_type":{"type":"string","description":"The plan type. The possible values are IM, MAU"},"plan_name":{"type":"string","description":"The plan name"},"periodic_charge":{"type":"number","format":"double","description":"The plan monthly charge"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/AccountPlanPackageType"},"description":"The account plan package array"}},"description":"The [GetAccountPlans] function result item.","title":"AccountPlanType"},"accounts_GetAccountPlans_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountPlanType"}}},"title":"accounts_GetAccountPlans_Response_200"},"PlanPackageType":{"type":"object","properties":{"price_group_id":{"type":"array","items":{"type":"integer"},"description":"The price group IDs"},"package_name":{"type":"string","description":"The package name"},"may_overrun":{"type":"boolean","description":"Whether overrun is enabled"},"overrun_price":{"type":"number","format":"double","description":"The overrun amount"},"overrun_resources":{"type":"integer","description":"The number of resources (e.g., messages) per overrun"},"package_size":{"type":"integer","description":"The package size"}},"description":"The plan package info.","title":"PlanPackageType"},"PlanType":{"type":"object","properties":{"plan_subscription_template_id":{"type":"integer","description":"The current plan ID"},"plan_type":{"type":"string","description":"The plan type. The possible values are IM, MAU"},"plan_name":{"type":"string","description":"The plan name"},"periodic_charge":{"type":"number","format":"double","description":"The plan monthly charge"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PlanPackageType"},"description":"The account package array"}},"description":"The [GetAvailablePlans] function result item.","title":"PlanType"},"accounts_GetAvailablePlans_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PlanType"}}},"title":"accounts_GetAvailablePlans_Response_200"},"AccountVerificationDocument":{"type":"object","properties":{"account_document_id":{"type":"integer","description":"The account verification document ID"},"is_individual":{"type":"boolean","description":"Whether the account belongs to an individual"},"comment":{"type":"string","description":"The reviewer's comment"},"uploaded":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC date of the document upload in the following format: YYYY-MM-DD HH::mm:ss"},"account_document_status":{"type":"string","description":"The account document status. The following values are possible: ACCEPTED, REJECTED, IN_PROGRESS, INCOMPLETE_SET"}},"description":"The account verification document info. The [AccountVerificationType] field.","title":"AccountVerificationDocument"},"AccountVerificationType":{"type":"object","properties":{"verification_name":{"type":"string","description":"The verification name"},"verification_status":{"type":"string","description":"The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED, NOT_REQUIRED"},"unverified_hold_until":{"type":"string","description":"Date string as returned by the Management API.\n\nUnverified subscriptions hold until the date in the following format: YYYY-MM-DD (if the account verification is required). Some subscriptions are detached on that day automatically!"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/AccountVerificationDocument"},"description":"The uploaded documents"}},"description":"The account verification info. The [AccountVerificationsType] field.","title":"AccountVerificationType"},"AccountDocumentsType":{"type":"object","properties":{"account_id":{"type":"integer","description":"The account ID"},"verifications":{"type":"array","items":{"$ref":"#/components/schemas/AccountVerificationType"},"description":"The account verifications"}},"description":"The account documents with verification states","title":"AccountDocumentsType"},"accounts_GetAccountDocuments_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountDocumentsType"},"description":"The account documents with verification states"}},"title":"accounts_GetAccountDocuments_Response_200"},"AccountVerificationsTypeCredentialsIndividualActualAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsIndividualActualAddress"},"AccountVerificationsTypeCredentialsIndividualInternalRfPassportFullName":{"type":"object","properties":{"paternity_name":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsIndividualInternalRfPassportFullName"},"AccountVerificationsTypeCredentialsIndividualInternalRfPassportRegistrationAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsIndividualInternalRfPassportRegistrationAddress"},"AccountVerificationsTypeCredentialsIndividualInternalRfPassport":{"type":"object","properties":{"number":{"type":"string"},"issued_by":{"type":"string"},"full_name":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsIndividualInternalRfPassportFullName"},"issue_date":{"type":"string"},"series":{"type":"string"},"birth_date":{"type":"string"},"registration_address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsIndividualInternalRfPassportRegistrationAddress"}},"title":"AccountVerificationsTypeCredentialsIndividualInternalRfPassport"},"AccountVerificationsTypeCredentialsIndividual":{"type":"object","properties":{"actual_address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsIndividualActualAddress"},"correspondence_emails":{"type":"array","items":{"type":"string"}},"identification_document_type":{"type":"string"},"phone_number":{"type":"string"},"internal_rf_passport":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsIndividualInternalRfPassport"}},"description":"Details of a person who takes the verification","title":"AccountVerificationsTypeCredentialsIndividual"},"AccountVerificationsTypeCredentialsLegalEntityActualAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntityActualAddress"},"AccountVerificationsTypeCredentialsLegalEntityBank":{"type":"object","properties":{"expense_account":{"type":"string"},"correspondent_account":{"type":"string"},"name":{"type":"string"},"bic":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntityBank"},"AccountVerificationsTypeCredentialsLegalEntityLegalAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntityLegalAddress"},"AccountVerificationsTypeCredentialsLegalEntityCorrespondenceAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntityCorrespondenceAddress"},"AccountVerificationsTypeCredentialsLegalEntityCorrespondence":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntityCorrespondenceAddress"}},"title":"AccountVerificationsTypeCredentialsLegalEntityCorrespondence"},"AccountVerificationsTypeCredentialsLegalEntitySignatoryFullName":{"type":"object","properties":{"paternity_name":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntitySignatoryFullName"},"AccountVerificationsTypeCredentialsLegalEntitySignatory":{"type":"object","properties":{"full_name":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntitySignatoryFullName"},"signatory_type":{"type":"string"},"confirming_authority_credentials":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsLegalEntitySignatory"},"AccountVerificationsTypeCredentialsLegalEntity":{"type":"object","properties":{"ogrn":{"type":"string"},"actual_address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntityActualAddress"},"bank":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntityBank"},"legal_address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntityLegalAddress"},"correspondence":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntityCorrespondence"},"inn":{"type":"string"},"name":{"type":"string"},"kpp":{"type":"string"},"phone_number":{"type":"string"},"signatory":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntitySignatory"}},"description":"Company details for a legal entity","title":"AccountVerificationsTypeCredentialsLegalEntity"},"AccountVerificationsTypeCredentialsEntrepreneurBank":{"type":"object","properties":{"expense_account":{"type":"string"},"correspondent_account":{"type":"string"},"name":{"type":"string"},"bic":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurBank"},"AccountVerificationsTypeCredentialsEntrepreneurCorrespondenceAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurCorrespondenceAddress"},"AccountVerificationsTypeCredentialsEntrepreneurCorrespondence":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}},"address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurCorrespondenceAddress"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurCorrespondence"},"AccountVerificationsTypeCredentialsEntrepreneurSignatoryFullName":{"type":"object","properties":{"paternity_name":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurSignatoryFullName"},"AccountVerificationsTypeCredentialsEntrepreneurSignatory":{"type":"object","properties":{"full_name":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurSignatoryFullName"},"signatory_type":{"type":"string"},"confirming_authority_credentials":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurSignatory"},"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportFullName":{"type":"object","properties":{"paternity_name":{"type":"string"},"last_name":{"type":"string"},"first_name":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportFullName"},"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportRegistrationAddress":{"type":"object","properties":{"country":{"type":"string"},"apartment_number":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"district":{"type":"string"},"building_block":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"building_number":{"type":"string"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportRegistrationAddress"},"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassport":{"type":"object","properties":{"number":{"type":"string"},"issued_by":{"type":"string"},"full_name":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportFullName"},"issue_date":{"type":"string"},"series":{"type":"string"},"birth_date":{"type":"string"},"registration_address":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassportRegistrationAddress"}},"title":"AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassport"},"AccountVerificationsTypeCredentialsEntrepreneur":{"type":"object","properties":{"ogrnip":{"type":"string"},"bank":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurBank"},"correspondence":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurCorrespondence"},"inn":{"type":"string"},"egrip_registration_credentials":{"type":"string"},"phone_number":{"type":"string"},"signatory":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurSignatory"},"owner_identification_document_type":{"type":"string"},"internal_rf_passport":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneurInternalRfPassport"}},"description":"Company details for a individual entrepreneur","title":"AccountVerificationsTypeCredentialsEntrepreneur"},"AccountVerificationsTypeCredentials":{"type":"object","properties":{"individual":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsIndividual","description":"Details of a person who takes the verification"},"legal_entity":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsLegalEntity","description":"Company details for a legal entity"},"entrepreneur":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentialsEntrepreneur","description":"Company details for a individual entrepreneur"},"legal_status":{"type":"string","description":"Subscriber type. Possible values are: INDIVIDUAL, LEGAL_ENTITY, ENTREPRENEUR"}},"description":"Person or company who takes the verification.","title":"AccountVerificationsTypeCredentials"},"AccountVerificationsTypeDefaultEndUser":{"type":"object","properties":{"end_user_uuid":{"type":"integer","description":"Customer's UUID"},"credentials":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Customer's data"}},"description":"Verification's default customer.","title":"AccountVerificationsTypeDefaultEndUser"},"AccountVerificationsTypeAgreements":{"type":"object","properties":{"agreement_id":{"type":"integer","description":"Agreement ID"},"type":{"type":"string","description":"Agreement type"},"status":{"type":"string","description":"Agreement status. Possible values are: NEW, IN_PROCESS, VERIFIED, REJECTED"},"agreement_number":{"type":"string","description":"Agreement number"},"agreement_date":{"type":"string","description":"Agreement signing date"},"signing_type":{"type":"string","description":"Agreement signing date. Possible values are: MANUAL, ESIGNATURE"},"comments":{"type":["string","null"],"description":"Comments for the customer in case of agreement rejection"}},"description":"Agreements list.","title":"AccountVerificationsTypeAgreements"},"AccountVerificationsType":{"type":"object","properties":{"verification_id":{"type":"integer","description":"Verification ID"},"status":{"type":"string","description":"Verification status. Possible values are: AWAITING_DOCUMENTS_UPLOADING, AWAITING_AGREEMENT_UPLOADING, AWAITING_VERIFICATION, WAITING_FOR_CONFIRMATION_DOCUMENTS, VERIFIED, REJECTED, WAITING_PERIOD_EXPIRED"},"status_scheme":{"type":"string","description":"Status scheme name"},"creation_type":{"type":"string","description":"Verification creation type. Possible values are: MANUAL, GOSUSLUGI, TRANSFER_RIGHTS"},"created":{"type":"string","description":"Date created in the following format: 2022-07-12 07:06:05"},"comments":{"type":["string","null"],"description":"Comments for the customer in case of verification rejection"},"credentials":{"$ref":"#/components/schemas/AccountVerificationsTypeCredentials","description":"Person or company who takes the verification"},"default_end_user":{"oneOf":[{"$ref":"#/components/schemas/AccountVerificationsTypeDefaultEndUser"},{"type":"null"}],"description":"Verification's default customer"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/AccountVerificationsTypeAgreements"},"description":"Agreements list"}},"description":"Account verifications.","title":"AccountVerificationsType"},"accounts_GetAccountVerifications_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountVerificationsType"},"description":"Account verifications"}},"title":"accounts_GetAccountVerifications_Response_200"},"applications_AddApplication_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"application_id":{"type":"integer","description":"The application ID"},"application_name":{"type":"string","description":"The full application name"},"secure_record_storage":{"type":"boolean","description":"Whether a secure storage for logs and records is enabled or not"}},"title":"applications_AddApplication_Response_200"},"applications_DelApplication_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"applications_DelApplication_Response_200"},"applications_SetApplicationInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"application_name":{"type":"string","description":"The new full application name"},"secure_record_storage":{"type":"boolean","description":"Whether a secure storage for logs and records is enabled or not"}},"title":"applications_SetApplicationInfo_Response_200"},"ApplicationInfoType":{"type":"object","properties":{"application_id":{"type":"integer","description":"The application ID"},"application_name":{"type":"string","description":"The full application name"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe application editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"secure_record_storage":{"type":"boolean","description":"Whether a secure storage for logs and records is enabled"}},"description":"The [GetApplications] function result.","title":"ApplicationInfoType"},"applications_GetApplications_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInfoType"}},"total_count":{"type":"integer","description":"The total found application count"},"count":{"type":"integer","description":"The returned application count"}},"title":"applications_GetApplications_Response_200"},"users_AddUser_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"user_id":{"type":"integer","description":"The new user ID"}},"title":"users_AddUser_Response_200"},"users_DelUser_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"users_DelUser_Response_200"},"users_SetUserInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"users_SetUserInfo_Response_200"},"SkillInfoType":{"type":"object","properties":{"skill_id":{"type":"integer","description":"The skill ID"},"skill_name":{"type":"string","description":"The skill name"}},"description":"The [GetSkills] function result.","title":"SkillInfoType"},"ACDQueueOperatorInfoType":{"type":"object","properties":{"acd_queue_id":{"type":"integer","description":"The ACD queue ID"},"acd_queue_name":{"type":"string","description":"The ACD queue name"},"auto_link":{"type":"boolean","description":"Whether the user is bound to the ACD queue in manual mode if false"}},"description":"The 'acd_queues' element of the [GetUsers] function result.","title":"ACDQueueOperatorInfoType"},"UserInfoType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID"},"user_name":{"type":"string","description":"The user name"},"user_display_name":{"type":"string","description":"The display user name"},"user_active":{"type":"boolean","description":"Whether the user is active. Inactive users cannot log in to applications"},"parent_accounting":{"type":"boolean","description":"Whether the user uses the parent account's money, 'false' if the user has a separate balance"},"live_balance":{"type":"number","format":"double","description":"The current user's money in the currency specified for the account. The value is the number rounded to 4 decimal places, and it changes during the calls, transcribing, purchases etc"},"balance":{"type":"number","format":"double","description":"The current user's money in the currency specified for the account. The value is the number rounded to 4 decimal places. The parameter is the alias to live_balance by default. But there is a possibility to make the alias to fixed_balance: just to pass return_live_balance=false into the [GetAccountInfo] method"},"fixed_balance":{"type":"number","format":"double","description":"The last committed balance which has been approved by billing's transaction"},"user_custom_data":{"type":"string","description":"The custom data"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInfoType"},"description":"The bound applications"},"skills":{"type":"array","items":{"$ref":"#/components/schemas/SkillInfoType"},"description":"The bound skills"},"acd_queues":{"type":"array","items":{"$ref":"#/components/schemas/ACDQueueOperatorInfoType"},"description":"The bound ACD queues"},"acd_status":{"type":"string","description":"The ACD operator status. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND"},"acd_status_change_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe ACD status changing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe user editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe user editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"frozen":{"type":"boolean"}},"description":"The [GetUsers] function result.","title":"UserInfoType"},"users_GetUsers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/UserInfoType"},"description":"The UserInfoType records"},"total_count":{"type":"integer","description":"The total found user count"},"count":{"type":"integer","description":"The returned user count"}},"title":"users_GetUsers_Response_200"},"call-lists_CreateCallList_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"},"count":{"type":"integer","description":"Number of stored records"},"list_id":{"type":"integer","description":"List ID"},"batch_id":{"type":"string","description":"Batch UUID"}},"title":"call-lists_CreateCallList_Response_200"},"AppendToCallListPostResponsesContentApplicationJsonSchemaBatchId":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Batch UUID","title":"AppendToCallListPostResponsesContentApplicationJsonSchemaBatchId"},"call-lists_AppendToCallList_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"},"count":{"type":"integer","description":"Number of stored records"},"list_id":{"type":"integer","description":"List ID"},"batch_id":{"$ref":"#/components/schemas/AppendToCallListPostResponsesContentApplicationJsonSchemaBatchId","description":"Batch UUID"}},"title":"call-lists_AppendToCallList_Response_200"},"call-lists_CancelCallListBatch_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"}},"title":"call-lists_CancelCallListBatch_Response_200"},"call-lists_EditCallList_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"}},"title":"call-lists_EditCallList_Response_200"},"EditCallListTasksPriorityPostResponsesContentApplicationJsonSchemaResults":{"oneOf":[{"type":"string"},{"type":"array","items":{"description":"Any type"}}],"description":"JSON-encoded array of each task update.","title":"EditCallListTasksPriorityPostResponsesContentApplicationJsonSchemaResults"},"call-lists_EditCallListTasksPriority_Response_200":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/EditCallListTasksPriorityPostResponsesContentApplicationJsonSchemaResults","description":"JSON-encoded array of each task update."}},"title":"call-lists_EditCallListTasksPriority_Response_200"},"call-lists_DeleteCallList_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Result"},"msg":{"type":"string","description":"Text description"}},"title":"call-lists_DeleteCallList_Response_200"},"CallListType":{"type":"object","properties":{"list_id":{"type":"integer","description":"The list ID"},"list_name":{"type":"string","description":"The list name"},"priority":{"type":"integer","description":"The priority of the call list"},"rule_id":{"type":"integer","description":"The rule id"},"max_simultaneous":{"type":"integer","description":"The maximum number of simultaneous tasks"},"num_attempts":{"type":"integer","description":"The number of task attempts run, which failed to call"},"dt_submit":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe date of submitted the list in 24-h format: YYYY-MM-DD HH:mm:ss"},"dt_complete":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe completion date in 24-h format: YYYY-MM-DD HH:mm:ss"},"interval_seconds":{"type":"integer","description":"The interval between attempts in seconds"},"status":{"type":"string","description":"The status name. The possible values are __In progress__, __Completed__, __Canceled__"},"task_priority_strategy":{"type":"string","description":"Whether the first or repeated calls have priority."},"user_id":{"type":"integer"}},"description":"Information about call list's configurations.","title":"CallListType"},"call-lists_GetCallLists_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CallListType"},"description":"Array of lists"},"count":{"type":"integer","description":"Returned call list count"},"total_count":{"type":"integer","description":"Total found call list count"}},"title":"call-lists_GetCallLists_Response_200"},"CallListDetailType":{"type":"object","properties":{"list_id":{"type":"integer","description":"The list ID"},"custom_data":{"type":"string","description":"Data for transmission to the script"},"start_execution_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nTime with which to start the job in 24-h format: HH:mm:ss"},"finish_execution_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nTime after which the task cannot be performed in 24-h format: HH:mm:ss"},"result_data":{"type":"string","description":"Results of the task, if it is granted, or information about the runtime error"},"last_attempt":{"type":"string","description":"Date and time of the last attempt to perform a task"},"attempts_left":{"type":"integer","description":"Number of remaining attempts"},"status_id":{"type":"integer","description":"The status ID. The possible values are __0__ (status = New), __1__ (status = In progress), __2__ (status = Processed), __3__ (status = Error), __4__ (status = Canceled)"},"status":{"type":"string","description":"The status name. The possible values are __New__ (status_id = 0), __In progress__ (status_id = 1), __Processed__ (status_id = 2), __Error__ (status_id = 3), __Canceled__ (status_id = 4)"},"task_id":{"type":"integer","description":"The call list task ID"},"task_uuid":{"type":"string","description":"The call list task UUID"}},"description":"Detailing job telephone calls.","title":"CallListDetailType"},"call-lists_GetCallListDetails_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CallListDetailType"},"description":"Array of tasks for the roll call"},"count":{"type":"integer","description":"The number of tasks"}},"title":"call-lists_GetCallListDetails_Response_200"},"call-lists_EditCallListTask_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"}},"title":"call-lists_EditCallListTask_Response_200"},"CancelCallListTaskPostResponsesContentApplicationJsonSchemaResult":{"oneOf":[{"type":"boolean"},{"type":"array","items":{"description":"Any type"}}],"description":"Result of the operation","title":"CancelCallListTaskPostResponsesContentApplicationJsonSchemaResult"},"call-lists_CancelCallListTask_Response_200":{"type":"object","properties":{"task_id":{"type":"integer","description":"Task's ID"},"task_uuid":{"type":"string","description":"Task's UUID"},"result":{"$ref":"#/components/schemas/CancelCallListTaskPostResponsesContentApplicationJsonSchemaResult","description":"Result of the operation"},"error_msg":{"type":"string","description":"Reason for the error"}},"title":"call-lists_CancelCallListTask_Response_200"},"call-lists_StopCallListProcessing_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"},"msg":{"type":"string","description":"Result message"}},"title":"call-lists_StopCallListProcessing_Response_200"},"call-lists_RecoverCallList_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the request completed successfully"},"count_recovery":{"type":"integer","description":"Number restored tasks"}},"title":"call-lists_RecoverCallList_Response_200"},"scenarios_AddScenario_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"scenario_id":{"type":"integer","description":"The new scenario ID"}},"title":"scenarios_AddScenario_Response_200"},"scenarios_DelScenario_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"scenarios_DelScenario_Response_200"},"scenarios_BindScenario_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"scenarios_BindScenario_Response_200"},"ScenarioInfoType":{"type":"object","properties":{"scenario_id":{"type":"integer","description":"The scenario ID"},"scenario_name":{"type":"string","description":"The scenario name"},"scenario_script":{"type":"string","description":"The scenario text"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe scenario editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"parent":{"type":"boolean","description":"Whether the scenario belongs to the parent account, 'false' if the scenario belongs to the current account"}},"description":"The [GetScenarios] function result.","title":"ScenarioInfoType"},"scenarios_GetScenarios_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioInfoType"}},"total_count":{"type":"integer","description":"The total found scenario count"},"count":{"type":"integer","description":"The returned scenario count"},"application_id":{"type":"integer","description":"ID of the scenario's application"},"application_name":{"type":"string","description":"Name of the scenario's application"},"extended_application_name":{"type":"string","description":"Application name including the node name"}},"title":"scenarios_GetScenarios_Response_200"},"scenarios_SetScenarioInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"scenarios_SetScenarioInfo_Response_200"},"scenarios_ReorderScenarios_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"scenarios_ReorderScenarios_Response_200"},"scenarios_StartScenarios_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"media_session_access_url":{"type":"string","description":"The URL to control a created media session. You can use it for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTP request on this URL results in the [AppEvents.HttpRequest](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for scenario, with HTTP request data passed to it"},"media_session_access_secure_url":{"type":"string","description":"The URL to control a created media session. You can use it for arbitrary tasks such as stopping scenario or passing additional data to it. Making HTTPS request on this URL results in the [AppEvents.HttpRequest](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for scenario, with HTTP request data passed to it"},"call_session_history_id":{"type":"integer","description":"The call session history ID. To search a call session result, paste the ID to the GetCallHistory method's **call_session_history_id** parameter"}},"title":"scenarios_StartScenarios_Response_200"},"scenarios_StartConference_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"media_session_access_url":{"type":"string","description":"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 results in the [AppEvents.HttpRequest](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for a scenario, with an HTTP request data passed to it"},"media_session_access_secure_url":{"type":"string","description":"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 HTTPS request on this URL results in the [AppEvents.HttpRequest](/api-reference/voxengine/app-events#httprequest) VoxEngine event being triggered for a scenario, with an HTTP request data passed to it"},"call_session_history_id":{"type":"integer","description":"The call session history ID. To search a call session result, paste the ID to the GetCallHistory method's **call_session_history_id** parameter"}},"title":"scenarios_StartConference_Response_200"},"rules_AddRule_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"rule_id":{"type":"integer","description":"The new rule ID"}},"title":"rules_AddRule_Response_200"},"rules_DelRule_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"rules_DelRule_Response_200"},"rules_SetRuleInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"rules_SetRuleInfo_Response_200"},"RuleInfoType":{"type":"object","properties":{"rule_id":{"type":"integer","description":"The rule ID"},"application_id":{"type":"integer","description":"The application ID"},"rule_name":{"type":"string","description":"The rule name"},"rule_pattern":{"type":"string","description":"The rule pattern regex"},"rule_pattern_exclude":{"type":"string","description":"The rule pattern excluding regex"},"video_conference":{"type":"boolean","description":"Whether video conference is required"},"scenarios":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioInfoType"},"description":"The bound scenarios"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe rule editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"}},"description":"The [GetRules] function result item.","title":"RuleInfoType"},"rules_GetRules_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RuleInfoType"}},"total_count":{"type":"integer","description":"The total found rule count"},"count":{"type":"integer","description":"The returned rule count"}},"title":"rules_GetRules_Response_200"},"rules_ReorderRules_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"rules_ReorderRules_Response_200"},"CallInfoTypeEndReason":{"type":"object","properties":{"code":{"type":"integer"},"details":{"type":"string"}},"description":"End reason code and description","title":"CallInfoTypeEndReason"},"CallInfoType":{"type":"object","properties":{"call_id":{"type":"integer","description":"Call's history ID"},"start_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nCall start time in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"diversion_number":{"type":"string","description":"Call forwarding number"},"duration":{"type":"integer","description":"Call duration in seconds"},"local_number":{"type":"string","description":"Local number on the platform side"},"remote_number":{"type":"string","description":"Remote number on the client side"},"remote_number_type":{"type":"string","description":"Type of the remote number, e.g., a PSTN, mobile, user or sip address"},"incoming":{"type":"boolean","description":"Whether the call is incoming"},"successful":{"type":"boolean","description":"Whether the call is successful"},"transaction_id":{"type":"integer","description":"Transaction ID"},"record_url":{"type":"string","description":"Record URL"},"media_server_address":{"type":"string","description":"Media server's IP address"},"cost":{"type":"number","format":"double","description":"Call's cost"},"custom_data":{"type":"string","description":"Custom data passed to the JS session"},"end_reason":{"$ref":"#/components/schemas/CallInfoTypeEndReason","description":"End reason code and description"},"audio_quality":{"type":"string"},"direction":{"type":"string"}},"description":"The call info.","title":"CallInfoType"},"ResourceUsageType":{"type":"object","properties":{"resource_usage_id":{"type":"integer","description":"The resource usage ID"},"resource_type":{"type":"string","description":"The resource type. The possible values are CALLSESSION, VIDEOCALL, VIDEORECORD, VOICEMAILDETECTION, ASR, TRANSCRIPTION, TTS_TEXT_GOOGLE, AUDIOHDCONFERENCE"},"cost":{"type":"number","format":"double","description":"The resource cost"},"description":{"type":"string","description":"The description"},"used_at":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe start resource using time in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"transaction_id":{"type":"integer","description":"The transaction ID"},"resource_quantity":{"type":"integer","description":"The resource quantity"},"unit":{"type":"string","description":"The resource unit"},"ref_call_id":{"type":"integer","description":"The reference to call"}},"description":"The resource usage info.","title":"ResourceUsageType"},"RecordType":{"type":"object","properties":{"record_id":{"type":"integer","description":"The record ID"},"record_name":{"type":"string","description":"The record name"},"cost":{"type":"number","format":"double","description":"The record cost"},"start_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe start recording time in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"duration":{"type":"integer","description":"The call duration in seconds"},"record_url":{"type":"string","description":"The record URL. If you have issues accessing the record file, check if the application has \"Secure storage of applications and logs\" feature enabled. In this case, you need to authorize."},"transaction_id":{"type":"integer","description":"The transaction ID"},"file_size":{"type":"number","format":"double","description":"The file size"},"transcription_url":{"type":"string","description":"Transcription URL. To open the URL, please add authorization parameters and **record_id** to it"},"transcription_status":{"type":"string","description":"The status of transcription. The possible values are Not required, In progress, Complete"},"hd_audio":{"type":"boolean"},"transcription_transaction_id":{"type":"integer"},"is_removed":{"type":"boolean"},"lossless":{"type":"boolean"},"expiration_date":{"type":"string"},"media_parameters":{"type":"string"}},"description":"The record info.","title":"RecordType"},"CallSessionInfoType":{"type":"object","properties":{"audio_quality":{"type":"string","description":"Call's audio quality. The possible values are: Standard | HD | Ultra HD."},"rule_name":{"type":"string","description":"Routing rule name"},"application_name":{"type":"string","description":"Application name"},"call_session_history_id":{"type":"integer","description":"Unique JS session identifier"},"account_id":{"type":"integer","description":"Account ID that initiates the JS session"},"application_id":{"type":"integer","description":"Application ID that initiates the JS session"},"user_id":{"type":"integer","description":"User ID that initiates the JS session"},"start_date":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nStart date in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"duration":{"type":"integer","description":"Entire JS session duration in seconds. The session can contain multiple calls"},"initiator_address":{"type":"string","description":"Initiator's IP address"},"media_server_address":{"type":"string","description":"Media server IP address"},"log_file_url":{"type":"string","description":"Link to the session log. The log retention policy is 1 month, after that time this field clears. If you have issues accessing the log file, check if the application has \"Secure storage of applications and logs\" feature enabled. In this case, you need to authorize."},"finish_reason":{"type":"string","description":"Finish reason. Possible values are __Normal termination__, __Insufficient funds__, __Internal error (billing timeout)__, __Terminated administratively__, __JS session error__, __Timeout__"},"calls":{"type":"array","items":{"$ref":"#/components/schemas/CallInfoType"},"description":"Calls within the JS session, including durations, cost, phone numbers and other information"},"other_resource_usage":{"type":"array","items":{"$ref":"#/components/schemas/ResourceUsageType"},"description":"Used resources"},"records":{"type":"array","items":{"$ref":"#/components/schemas/RecordType"},"description":"Bound records"},"custom_data":{"type":"string","description":"Custom data"},"active":{"type":"boolean"}},"description":"The [GetCallHistory] function result item.","title":"CallSessionInfoType"},"history_GetCallHistory_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CallSessionInfoType"},"description":"The CallSessionInfoType records"},"total_count":{"type":"integer","description":"The total found call session count"},"count":{"type":"integer","description":"The returned call session count"},"timezone":{"type":"string","description":"The used timezone"}},"title":"history_GetCallHistory_Response_200"},"history_GetCallHistoryAsync_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"history_report_id":{"type":"integer","description":"The history report ID"}},"title":"history_GetCallHistoryAsync_Response_200"},"history_GetBriefCallHistory_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"history_report_id":{"type":"integer","description":"The history report ID"}},"title":"history_GetBriefCallHistory_Response_200"},"HistoryReportTypeCalculatedData":{"type":"object","properties":{"session_count":{"type":"integer"},"total_session_count":{"type":"integer"},"transaction_count":{"type":"integer"},"total_transaction_count":{"type":"integer"},"start_balance":{"type":"string"},"end_balance":{"type":"string"},"account_id":{"type":"integer"}},"description":"The calculated report data (the specific report data, see [CalculatedCallHistoryDataType], [CalculatedTransactionHistoryDataType])","title":"HistoryReportTypeCalculatedData"},"HistoryReportTypeError":{"type":"object","properties":{"code":{"type":"integer"},"msg":{"type":"string"}},"title":"HistoryReportTypeError"},"HistoryReportType":{"type":"object","properties":{"history_report_id":{"type":"integer","description":"The call history report ID"},"history_type":{"type":"string","description":"The history report type. The following values are possible: calls, transactions, audit, call_list"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe creation time in the UTC timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"format":{"type":"string","description":"The report format type. The following values are possible: csv"},"completed":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC completion time in 24-h format: YYYY-MM-DD HH:mm:ss. The report is completed if the field exists"},"file_name":{"type":"string","description":"The report file name"},"file_size":{"type":"number","format":"double","description":"The report file size"},"download_size":{"type":"number","format":"double","description":"The gzipped report size to download"},"download_count":{"type":"integer","description":"The download attempt count"},"last_downloaded":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe last download UTC time in 24-h format: YYYY-MM-DD HH:mm:ss. The report is completed if the field exists"},"store_until":{"type":"string","description":"Date string as returned by the Management API.\n\nStore the report until the date in the following format: YYYY-MM-DD. The report is completed if the field exists"},"filters":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The report order filters (the saved [GetCallHistory], [GetTransactionHistory] parameters)"},"calculated_data":{"$ref":"#/components/schemas/HistoryReportTypeCalculatedData","description":"The calculated report data (the specific report data, see [CalculatedCallHistoryDataType], [CalculatedTransactionHistoryDataType])"},"error":{"$ref":"#/components/schemas/HistoryReportTypeError"}},"description":"The history report info.","title":"HistoryReportType"},"history_GetHistoryReports_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/HistoryReportType"}},"total_count":{"type":"integer","description":"The total found reports count"},"count":{"type":"integer","description":"The returned reports count"}},"title":"history_GetHistoryReports_Response_200"},"history_DownloadHistoryReport_Response_200":{"type":"object","properties":{"file_content":{"type":"string","format":"binary","description":"The method returns a raw data, there is no 'file_content' parameter in fact"}},"title":"history_DownloadHistoryReport_Response_200"},"GetTransactionHistoryPostResponsesContentApplicationJsonSchemaResult":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"type":"integer"}],"title":"GetTransactionHistoryPostResponsesContentApplicationJsonSchemaResult"},"history_GetTransactionHistory_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/GetTransactionHistoryPostResponsesContentApplicationJsonSchemaResult"},"total_count":{"type":"integer","description":"The total found transaction count"},"timezone":{"type":"string","description":"The used timezone. 'Etc/GMT' for example"},"count":{"type":"integer","description":"The returned transaction count"},"history_report_id":{"type":"integer"}},"title":"history_GetTransactionHistory_Response_200"},"history_GetTransactionHistoryAsync_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"history_report_id":{"type":"integer","description":"The history report ID"}},"title":"history_GetTransactionHistoryAsync_Response_200"},"history_DeleteRecord_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"history_DeleteRecord_Response_200"},"ACDSessionEventInfoType":{"type":"object","properties":{"acd_session_event_id":{"type":"integer","description":"The ACD session event ID"},"time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC start date in 24-h format: YYYY-MM-DD HH:mm:ss"},"type":{"type":"string","description":"The event type name"},"user_id":{"type":"integer","description":"The user ID"},"custom_data":{"type":"string","description":"The custom data"}},"description":"The ACD session event info.","title":"ACDSessionEventInfoType"},"ACDSessionInfoType":{"type":"object","properties":{"acd_session_history_id":{"type":"integer","description":"The ACD session history ID"},"acd_request_id":{"type":"string","description":"The ACD request ID. See the [ACDRequest.id()](/api-reference/voxengine/acd-request#id) VoxEngine method"},"account_id":{"type":"integer","description":"The account ID"},"begin_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC start date in 24-h format: YYYY-MM-DD HH:mm:ss"},"priority":{"type":"integer","description":"The request priority"},"acd_queue_id":{"type":"integer","description":"The ACD queue ID"},"user_id":{"type":"integer","description":"The user ID"},"waiting_duration":{"type":"integer","description":"The waiting duration in seconds"},"in_service_duration":{"type":"integer","description":"The conversation duration in seconds"},"after_service_duration":{"type":"integer","description":"The after service duration in seconds"},"events":{"type":"array","items":{"$ref":"#/components/schemas/ACDSessionEventInfoType"},"description":"The bound events"},"unserviced":{"type":"boolean"},"rejected":{"type":"boolean"},"operator_hangup":{"type":"boolean"}},"description":"The [GetACDHistory] function result item.","title":"ACDSessionInfoType"},"history_GetACDHistory_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ACDSessionInfoType"}},"total_count":{"type":"integer","description":"The total found ACD session count"},"count":{"type":"integer","description":"The returned ACD session count"}},"title":"history_GetACDHistory_Response_200"},"AuditLogInfoTypeCmdArgs":{"type":"object","properties":{"skill_name":{"type":"string"},"bind":{"type":"boolean"},"skill_id":{"type":"array","items":{"type":"integer"}},"acd_queue_id":{"type":"array","items":{"type":"integer"}}},"description":"The arguments of the called function (they may be masked or resolved)","title":"AuditLogInfoTypeCmdArgs"},"AuditLogInfoTypeCmdResultDeletedSkillsItems":{"type":"object","properties":{"skill_name":{"type":"string"},"skill_id":{"type":"integer"}},"title":"AuditLogInfoTypeCmdResultDeletedSkillsItems"},"AuditLogInfoTypeCmdResult":{"type":"object","properties":{"skill_id":{"type":"integer"},"deleted_skills":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogInfoTypeCmdResultDeletedSkillsItems"}}},"description":"The modified values","title":"AuditLogInfoTypeCmdResult"},"AuditLogInfoType":{"type":"object","properties":{"audit_log_id":{"type":"integer","description":"The audit log ID"},"subuser_id":{"type":"integer","description":"The subuser's ID"},"subuser_name":{"type":"string","description":"The subuser's name"},"account_id":{"type":"integer","description":"The account ID"},"requested":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe action time in the selected timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"ip":{"type":"string","description":"The initiator IP address"},"cmd_name":{"type":"string","description":"The called function"},"cmd_args":{"$ref":"#/components/schemas/AuditLogInfoTypeCmdArgs","description":"The arguments of the called function (they may be masked or resolved)"},"cmd_result":{"$ref":"#/components/schemas/AuditLogInfoTypeCmdResult","description":"The modified values"}},"description":"The [GetAuditLog] function result item.","title":"AuditLogInfoType"},"history_GetAuditLog_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogInfoType"}},"total_count":{"type":"integer","description":"The total found item count"},"count":{"type":"integer","description":"The returned item count"},"timezone":{"type":"string","description":"The used timezone"}},"title":"history_GetAuditLog_Response_200"},"history_GetAuditLogAsync_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"history_report_id":{"type":"integer","description":"The history report ID"}},"title":"history_GetAuditLogAsync_Response_200"},"CommonReportTypeError":{"type":"object","properties":{"msg":{"type":"string"},"code":{"type":"integer"}},"title":"CommonReportTypeError"},"CommonReportType":{"type":"object","properties":{"report_id":{"type":"integer","description":"The phone number report ID"},"type":{"type":"string","description":"The report type. The following values are possible: phone_numbers, phone_numbers_awaiting_configuration, none"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe creation time in the UTC timezone in 24-h format: YYYY-MM-DD HH:mm:ss"},"format":{"type":"string","description":"The report format type. The following values are possible: csv"},"completed":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC completion time in 24-h format: YYYY-MM-DD HH:mm:ss. The report is completed if the field exists"},"file_name":{"type":"string","description":"The report file name"},"file_size":{"type":"number","format":"double","description":"The report file size"},"download_size":{"type":"number","format":"double","description":"The gzipped report size to download"},"download_count":{"type":"integer","description":"The download attempt count"},"last_downloaded":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe last download UTC time in 24-h format: YYYY-MM-DD HH:mm:ss. The report is completed if the field exists"},"store_until":{"type":"string","description":"Date string as returned by the Management API.\n\nStore the report until the date in the following format: YYYY-MM-DD. The report is completed if the field exists"},"filters":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The report order filters (the saved [GetCallHistory], [GetTransactionHistory] parameters)"},"calculated_data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The calculated report data (the specific report data, see [CalculatedCallHistoryDataType], [CalculatedTransactionHistoryDataType])"},"report_type":{"type":"string"},"error":{"$ref":"#/components/schemas/CommonReportTypeError"}},"description":"The phone number report info.","title":"CommonReportType"},"phone-numbers_GetPhoneNumberReports_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CommonReportType"}},"total_count":{"type":"integer","description":"The total found reports count"},"count":{"type":"integer","description":"The returned reports count"}},"title":"phone-numbers_GetPhoneNumberReports_Response_200"},"NewAttachedPhoneInfoType":{"type":"object","properties":{"phone_id":{"type":"integer","description":"The phone ID"},"phone_number":{"type":"string","description":"The phone number"},"required_verification":{"type":"string","description":"Country code, where the verification is required for the account. Currently, the only possible value for this field is `RU` (Russia)"},"verification_status":{"type":"string","description":"The account verification status. Available only for RU accounts. The following values are possible: REQUIRED, IN_PROGRESS"},"unverified_hold_until":{"type":"string","description":"Date string as returned by the Management API.\n\nUnverified phone hold until the date in the following format: YYYY-MM-DD (if the account verification is required). The number is detached on that day automatically!"}},"description":"The [AttachPhoneNumber] function result.","title":"NewAttachedPhoneInfoType"},"AttachPhoneNumberPostResponsesContentApplicationJsonSchemaErrorDetails":{"type":"object","properties":{"verification_name":{"type":"string"}},"title":"AttachPhoneNumberPostResponsesContentApplicationJsonSchemaErrorDetails"},"AttachPhoneNumberPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"integer"},"msg":{"type":"string"},"details":{"$ref":"#/components/schemas/AttachPhoneNumberPostResponsesContentApplicationJsonSchemaErrorDetails"}},"title":"AttachPhoneNumberPostResponsesContentApplicationJsonSchemaError"},"phone-numbers_AttachPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/NewAttachedPhoneInfoType"},"description":"The attached phone numbers"},"error":{"$ref":"#/components/schemas/AttachPhoneNumberPostResponsesContentApplicationJsonSchemaError"}},"title":"phone-numbers_AttachPhoneNumber_Response_200"},"phone-numbers_BindPhoneNumberToApplication_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"phone-numbers_BindPhoneNumberToApplication_Response_200"},"phone-numbers_DeactivatePhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"phone-numbers_DeactivatePhoneNumber_Response_200"},"phone-numbers_SetPhoneNumberInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"phone-numbers_SetPhoneNumberInfo_Response_200"},"AttachedPhoneInfoType":{"type":"object","properties":{"phone_id":{"type":"integer","description":"The phone ID"},"phone_number":{"type":"string","description":"The phone number"},"phone_price":{"type":"number","format":"double","description":"The phone monthly charge in the account's currency"},"phone_country_code":{"type":"string","description":"The phone country code (2 symbols)"},"activation_status":{"type":"string","description":"Phone number activation status"},"phone_next_renewal":{"type":"string","description":"Date string as returned by the Management API.\n\nThe next renewal date in the following format: YYYY-MM-DD"},"phone_purchase_date":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe purchase date in 24-h format: YYYY-MM-DD HH:mm:ss"},"deactivated":{"type":"boolean","description":"Whether the subscription is frozen"},"canceled":{"type":"boolean","description":"Whether the subscription is cancelled"},"auto_charge":{"type":"boolean","description":"Whether to charge automatically"},"application_id":{"type":"integer","description":"ID of the bound application"},"application_name":{"type":"string","description":"Name of the bound application"},"rule_id":{"type":"integer","description":"ID of the bound rule"},"rule_name":{"type":"string","description":"Name of the bound rule"},"category_name":{"type":"string","description":"The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)"},"required_verification":{"type":"string","description":"Whether the verification is required for the account"},"verification_status":{"type":"string","description":"The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED"},"unverified_hold_until":{"type":"string","description":"Date string as returned by the Management API.\n\nUnverified phone hold until the date in the following format: YYYY-MM-DD (if the account verification is required). The number is detached on that day automatically!"},"can_be_used":{"type":"boolean","description":"Whether a not verified account can use the phone"},"is_sms_supported":{"type":"boolean","description":"Whether SMS is supported for this phone number. SMS needs to be explicitly enabled via the [ControlSms] Management API before sending or receiving SMS. If SMS is supported and enabled, SMS can be sent from this phone number via the [SendSmsMessage] Management API and received via the [InboundSmsCallback] property of the HTTP callback. See this article for HTTP callback details"},"is_sms_enabled":{"type":"boolean","description":"Whether SMS sending and receiving is enabled for this phone number via the [ControlSms] Management API"},"incoming_sms_callback_url":{"type":"string","description":"If set, the callback of an incoming SMS is sent to this url, otherwise, it is sent to the general account URL"},"emergency_calls_to_be_enabled":{"type":"boolean","description":"Whether you need to make a request to enable calls to emergency numbers"},"emergency_calls_enabled":{"type":"boolean","description":"Whether calls to emergency numbers are enabled"},"subscription_id":{"type":"integer","description":"Phone number subscription ID"},"extended_application_name":{"type":"string","description":"Full application name, e.g. myapp.myaccount.n1.voximplant.com"},"phone_region_name":{"type":"string","description":"Phone region name"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of an event associated with the number in 24-h format: YYYY-MM-DD HH:mm:ss"}},"description":"The [GetPhoneNumbers] function result.","title":"AttachedPhoneInfoType"},"phone-numbers_GetPhoneNumbers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AttachedPhoneInfoType"},"description":"Phone numbers info"},"total_count":{"type":"integer","description":"Total found phone count"},"count":{"type":"integer","description":"Returned phone count"}},"title":"phone-numbers_GetPhoneNumbers_Response_200"},"phone-numbers_IsAccountPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the number belongs to the account"}},"title":"phone-numbers_IsAccountPhoneNumber_Response_200"},"phone-numbers_GetPhoneNumbersAsync_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"The report ID (async mode)"}},"title":"phone-numbers_GetPhoneNumbersAsync_Response_200"},"NewPhoneInfoType":{"type":"object","properties":{"phone_id":{"type":"integer","description":"The phone ID"},"phone_number":{"type":"string","description":"The phone number"},"phone_price":{"type":"number","format":"double","description":"The phone monthly fee. It consists of `phone_price` and `phone_tax_reserve`"},"phone_installation_price":{"type":"number","format":"double","description":"The phone installation price (without the first monthly fee). It consists of `phone_installation_price` and `phone_installation_tax_reserve`"},"phone_country_code":{"type":"string","description":"The phone country code (2 symbols)"},"phone_period":{"type":"string","description":"The charge period in 24-h format: Y-M-D H:m:s. Example: 0-1-0 0:0:0 is 1 month"},"phone_category_name":{"type":"string","description":"The phone category name (MOBILE, GEOGRAPHIC, TOLLFREE, MOSCOW495)"},"phone_region_name":{"type":"string","description":"The phone region name"},"phone_installation_tax_reserve":{"type":"integer","description":"The phone number installation tax reserve. The phone installation price consists of `phone_installation_price` and `phone_installation_tax_reserve`"},"phone_tax_reserve":{"type":"integer","description":"The phone number tax reserve. The phone monthly fee consists of `phone_price` and `phone_tax_reserve`"}},"description":"The [GetNewPhoneNumbers] function result item.","title":"NewPhoneInfoType"},"phone-numbers_GetNewPhoneNumbers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/NewPhoneInfoType"}},"total_count":{"type":"integer","description":"The total found phone count"},"count":{"type":"integer","description":"The returned phone count"}},"title":"phone-numbers_GetNewPhoneNumbers_Response_200"},"PhoneNumberCountryCategoryInfoType":{"type":"object","properties":{"phone_category_name":{"type":"string","description":"The phone category name"},"country_has_states":{"type":"boolean","description":"Whether the chosen phone number country has states"},"localized_country_name":{"type":"string","description":"The localized country name"},"localized_phone_category_name":{"type":"string","description":"The localized phone category name"},"localized_phone_region_name":{"type":"string","description":"The localized phone region name"}},"description":"The 'phone_categories' element of the [GetPhoneNumberCategories] function result.","title":"PhoneNumberCountryCategoryInfoType"},"PhoneNumberCountryInfoType":{"type":"object","properties":{"country_code":{"type":"string","description":"The country code"},"localized_country_name":{"type":"string","description":"The localized country name"},"phone_prefix":{"type":"string","description":"The country phone prefix"},"can_list_phone_numbers":{"type":"boolean","description":"Whether to list phone numbers"},"phone_categories":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberCountryCategoryInfoType"},"description":"The phone categories"},"emergency_calls_to_be_enabled":{"type":"boolean","description":"Whether you need to make a request to enable calls to emergency numbers"}},"description":"The [GetPhoneNumberCategories] function result.","title":"PhoneNumberCountryInfoType"},"phone-numbers_GetPhoneNumberCategories_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberCountryInfoType"}}},"title":"phone-numbers_GetPhoneNumberCategories_Response_200"},"PhoneNumberCountryStateInfoType":{"type":"object","properties":{"country_state":{"type":"string","description":"The country state code"},"country_state_name":{"type":"string","description":"The full country state name"}},"description":"The [GetPhoneNumberCountryStates] function result.","title":"PhoneNumberCountryStateInfoType"},"phone-numbers_GetPhoneNumberCountryStates_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberCountryStateInfoType"}}},"title":"phone-numbers_GetPhoneNumberCountryStates_Response_200"},"MultipleNumbersPrice":{"type":"object","properties":{"count":{"type":"integer","description":"The number of subscriptions which must be purchased simultaneously to enable a multiple numbers subscription"},"installation_tax_reserve":{"type":"integer","description":"The phone number installation tax reserve"},"tax_reserve":{"type":"integer","description":"The phone number tax reserve"},"local_price":{"type":"integer","description":"Phone number price from the price list"},"local_installation_price":{"type":"integer","description":"Phone number installation price from the price list"},"local_currency":{"type":"string","description":"Price list currency"},"account_price":{"type":"integer","description":"Phone number price in the account currency"},"account_installation_price":{"type":"integer","description":"Phone number installation price in the account currency"},"account_currency":{"type":"string","description":"Account currency"},"price":{"type":"number","format":"double"},"installation_price":{"type":"integer"}},"description":"Info about multiple numbers subscription for the child accounts.","title":"MultipleNumbersPrice"},"PhoneNumberCountryRegionInfoType":{"type":"object","properties":{"phone_region_id":{"type":"integer","description":"The region ID"},"phone_region_name":{"type":"string","description":"The full region name"},"phone_region_code":{"type":"string","description":"The region phone prefix"},"phone_count":{"type":"integer","description":"The phone number count in stock for the region"},"verification_status":{"type":"string","description":"The account verification status. Available only for RU accounts. The following values are possible: REQUIRED, IN_PROGRESS"},"required_verification":{"type":"string","description":"Country code, where the verification is required for the account. Currently, the only possible value for this field is `RU` (Russia)"},"phone_period":{"type":"string","description":"The charge period in 24-h format: Y-M-D H:m:s. Example: 0-1-0 0:0:0 is 1 month"},"is_need_regulation_address":{"type":"boolean","description":"Whether to need proof of address"},"regulation_address_type":{"type":"string","description":"The type of regulation address. The possible values are LOCAL, NATIONAL, WORLDWIDE"},"is_sms_supported":{"type":"boolean","description":"Whether SMS is supported for phone numbers in this region. SMS needs to be explicitly enabled for a phone number via the [ControlSms] Management API before sending or receiving SMS. If SMS is supported and enabled, SMS can be sent from a phone number via the [SendSmsMessage] Management API and received via the [InboundSmsCallback] property of the HTTP callback. See this article for HTTP callback details"},"multiple_numbers_price":{"type":"array","items":{"$ref":"#/components/schemas/MultipleNumbersPrice"},"description":"[Array](MultipleNumbersPrice) with info about multiple numbers subscription for the child accounts"},"localized_country_name":{"type":"string","description":"The localized country name"},"localized_phone_category_name":{"type":"string","description":"The localized phone category name"},"localized_phone_region_name":{"type":"string","description":"The localized phone region name"},"phone_installation_tax_reserve":{"type":"integer","description":"The phone number installation tax reserve"},"phone_tax_reserve":{"type":"integer","description":"The phone number tax reserve"},"local_price":{"type":"integer","description":"Phone number price from the price list"},"local_installation_price":{"type":"integer","description":"Phone number installation price from the price list"},"local_currency":{"type":"string","description":"Price list currency"},"account_price":{"type":"integer","description":"Phone number price in the account currency"},"account_installation_price":{"type":"integer","description":"Phone number installation price in the account currency"},"account_currency":{"type":"string","description":"Account currency"},"phone_price":{"type":"number","format":"double"},"phone_installation_price":{"type":"number","format":"double"}},"description":"The [GetPhoneNumberRegions] function result.","title":"PhoneNumberCountryRegionInfoType"},"phone-numbers_GetPhoneNumberRegions_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberCountryRegionInfoType"}}},"title":"phone-numbers_GetPhoneNumberRegions_Response_200"},"phone-numbers_GetActualPhoneNumberRegion_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/PhoneNumberCountryRegionInfoType"}},"title":"phone-numbers_GetActualPhoneNumberRegion_Response_200"},"phone-numbers_GetAccountPhoneNumberCountries_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"type":"string"},"description":"Array of country codes"}},"title":"phone-numbers_GetAccountPhoneNumberCountries_Response_200"},"pstn-blacklist_AddPstnBlackListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"pstn_blacklist_id":{"type":"integer","description":"The PSTN black list item ID"}},"title":"pstn-blacklist_AddPstnBlackListItem_Response_200"},"pstn-blacklist_SetPstnBlackListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"pstn-blacklist_SetPstnBlackListItem_Response_200"},"pstn-blacklist_DelPstnBlackListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"pstn-blacklist_DelPstnBlackListItem_Response_200"},"PstnBlackListInfoType":{"type":"object","properties":{"pstn_blacklist_id":{"type":"integer","description":"The black list item ID"},"pstn_blacklist_phone ":{"type":"string","description":"The phone number"},"pstn_blacklist_phone":{"type":"string"}},"description":"The PSTN black list item info.","title":"PstnBlackListInfoType"},"pstn-blacklist_GetPstnBlackList_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PstnBlackListInfoType"}},"total_count":{"type":"integer","description":"The total found phone numbers count"},"count":{"type":"integer","description":"The returned phone numbers count"}},"title":"pstn-blacklist_GetPstnBlackList_Response_200"},"sip-white-list_AddSipWhiteListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"sip_whitelist_id":{"type":"integer","description":"The SIP white list item ID"}},"title":"sip-white-list_AddSipWhiteListItem_Response_200"},"sip-white-list_DelSipWhiteListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"sip-white-list_DelSipWhiteListItem_Response_200"},"sip-white-list_SetSipWhiteListItem_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"sip-white-list_SetSipWhiteListItem_Response_200"},"SipWhiteListInfoType":{"type":"object","properties":{"sip_whitelist_id":{"type":"integer","description":"The SIP white list item ID"},"sip_whitelist_network":{"type":"string","description":"The network address in format A.B.C.D/L"},"description":{"type":"string","description":"The network address description"}},"description":"The [GetSipWhiteList] function result item.","title":"SipWhiteListInfoType"},"sip-white-list_GetSipWhiteList_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SipWhiteListInfoType"}},"total_count":{"type":"integer","description":"The total found networks count"},"count":{"type":"integer","description":"The returned networks count"}},"title":"sip-white-list_GetSipWhiteList_Response_200"},"CreateSipRegistrationPostResponsesContentApplicationJsonSchemaErrorDetails":{"type":"object","properties":{"required_money":{"type":"number","format":"double"}},"title":"CreateSipRegistrationPostResponsesContentApplicationJsonSchemaErrorDetails"},"CreateSipRegistrationPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"msg":{"type":"string"},"code":{"type":"integer"},"details":{"$ref":"#/components/schemas/CreateSipRegistrationPostResponsesContentApplicationJsonSchemaErrorDetails"}},"title":"CreateSipRegistrationPostResponsesContentApplicationJsonSchemaError"},"sip-registration_CreateSipRegistration_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"sip_registration_id":{"type":"integer","description":"The sip registration id"},"account_info":{"$ref":"#/components/schemas/ShortAccountInfoType","description":"The current account state"},"error":{"$ref":"#/components/schemas/CreateSipRegistrationPostResponsesContentApplicationJsonSchemaError"}},"title":"sip-registration_CreateSipRegistration_Response_200"},"sip-registration_UpdateSipRegistration_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"sip-registration_UpdateSipRegistration_Response_200"},"sip-registration_BindSipRegistration_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"sip-registration_BindSipRegistration_Response_200"},"sip-registration_DeleteSipRegistration_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"sip-registration_DeleteSipRegistration_Response_200"},"SipRegistrationTypeLastUpdated":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The last time updated","title":"SipRegistrationTypeLastUpdated"},"SipRegistrationTypeSubscriptionPrice":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"The subscription monthly charge","title":"SipRegistrationTypeSubscriptionPrice"},"SIPRegistrationType":{"type":"object","properties":{"sip_registration_id":{"type":"integer","description":"The SIP registration ID"},"sip_username":{"type":"string","description":"The user name from sip proxy"},"proxy":{"type":"string","description":"The sip proxy"},"last_updated":{"$ref":"#/components/schemas/SipRegistrationTypeLastUpdated","description":"The last time updated"},"auth_user":{"type":"string","description":"The SIP authentications user"},"outbound_proxy":{"type":"string","description":"The outgoing proxy"},"successful":{"type":"boolean","description":"Whether the SIP registration is successful"},"status_code":{"type":"integer","description":"The status code from a SIP registration"},"error_message":{"type":"string","description":"The error message from a SIP registration"},"deactivated":{"type":"boolean","description":"Whether the subscription is deactivation. The SIP registration is frozen if true"},"next_subscription_renewal":{"type":"string","description":"Date string as returned by the Management API.\n\nThe next subscription renewal date in the following format: YYYY-MM-DD"},"purchase_date":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe purchase date in 24-h format: YYYY-MM-DD HH:mm:ss"},"subscription_price":{"$ref":"#/components/schemas/SipRegistrationTypeSubscriptionPrice","description":"The subscription monthly charge"},"is_persistent":{"type":"boolean","description":"Whether the SIP registration is persistent. Set false to activate it only on the user login"},"user_id":{"type":"integer","description":"ID of the bound user"},"user_name":{"type":"string","description":"Name of the bound user"},"application_id":{"type":"integer","description":"ID of the bound application"},"application_name":{"type":"string","description":"Name of the bound application"},"rule_id":{"type":"integer","description":"ID of the bound rule"},"rule_name":{"type":"string","description":"Name of the bound rule"}},"description":"Detailing SIP registration.","title":"SIPRegistrationType"},"sip-registration_GetSipRegistrations_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SIPRegistrationType"},"description":"Active SIP registrations"},"count":{"type":"integer","description":"Count rows"}},"title":"sip-registration_GetSipRegistrations_Response_200"},"AddWabPhoneNumberPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"integer"},"msg":{"type":"string"}},"title":"AddWabPhoneNumberPostResponsesContentApplicationJsonSchemaError"},"wab-phone-numbers_AddWABPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"error":{"$ref":"#/components/schemas/AddWabPhoneNumberPostResponsesContentApplicationJsonSchemaError"}},"title":"wab-phone-numbers_AddWABPhoneNumber_Response_200"},"wab-phone-numbers_DeleteWABPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"wab-phone-numbers_DeleteWABPhoneNumber_Response_200"},"wab-phone-numbers_SetWABPhoneNumberInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"wab-phone-numbers_SetWABPhoneNumberInfo_Response_200"},"WABPhoneInfoType":{"type":"object","properties":{"wab_phone_number":{"type":"string","description":"WhatsApp Business phone number"},"country_code":{"type":"string","description":"The WhatsApp Business country code (2 symbols)"},"application_id":{"type":"integer","description":"ID of the bound application"},"application_name":{"type":"string","description":"Name of the bound application"},"rule_id":{"type":"integer","description":"ID of the bound rule"},"rule_name":{"type":"string","description":"Name of the bound rule"},"extended_application_name":{"type":"string","description":"Full application name, e.g. myapp.myaccount.n1.voximplant.com"},"description":{"type":"string","description":"WhatsApp Business phone number description"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of an event associated with the number in 24-h format: YYYY-MM-DD HH:mm:ss"},"creared":{"type":"string"}},"description":"The [GetWABPhoneNumbers] function result.","title":"WABPhoneInfoType"},"wab-phone-numbers_GetWABPhoneNumbers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/WABPhoneInfoType"},"description":"WhatsApp Business phone numbers info"},"total_count":{"type":"integer","description":"Number of total records found"},"count":{"type":"integer","description":"Number of returned records"}},"title":"wab-phone-numbers_GetWABPhoneNumbers_Response_200"},"callerids_DelCallerID_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"callerids_DelCallerID_Response_200"},"CallerIDInfoType":{"type":"object","properties":{"callerid_id":{"type":"integer","description":"The callerID id"},"callerid_number":{"type":"string","description":"The callerID number"},"active":{"type":"boolean","description":"Whether active"},"code_entering_attempts_left":{"type":"integer","description":"The code entering attempts left for the unverified callerID"},"verification_call_attempts_left":{"type":"integer","description":"The verification call attempts left for the unverified callerID"},"verified_until":{"type":"string","description":"Date string as returned by the Management API.\n\nThe verification ending date in the following format: YYYY-MM-DD (for the verified callerID)"}},"description":"The [GetCallerIDs] function result.","title":"CallerIDInfoType"},"callerids_GetCallerIDs_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/CallerIDInfoType"}},"total_count":{"type":"integer","description":"The total found record count"},"count":{"type":"integer","description":"The returned record count"}},"title":"callerids_GetCallerIDs_Response_200"},"outboundtestnumbers_AddOutboundTestPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"outboundtestnumbers_AddOutboundTestPhoneNumber_Response_200"},"VerifyOutboundTestPhoneNumberPostResponsesContentApplicationJsonSchemaResult":{"type":"object","properties":{"daily_attempts_left":{"type":"integer"}},"title":"VerifyOutboundTestPhoneNumberPostResponsesContentApplicationJsonSchemaResult"},"outboundtestnumbers_VerifyOutboundTestPhoneNumber_Response_200":{"type":"object","properties":{"daily_attempts_left":{"type":"integer","description":"The number of attempts left for the day. The number is reset every day at 00:00 UTC"},"result":{"$ref":"#/components/schemas/VerifyOutboundTestPhoneNumberPostResponsesContentApplicationJsonSchemaResult"}},"title":"outboundtestnumbers_VerifyOutboundTestPhoneNumber_Response_200"},"outboundtestnumbers_ActivateOutboundTestPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"outboundtestnumbers_ActivateOutboundTestPhoneNumber_Response_200"},"outboundtestnumbers_DelOutboundTestPhoneNumber_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"outboundtestnumbers_DelOutboundTestPhoneNumber_Response_200"},"OutboundTestPhonenumberInfoType":{"type":"object","properties":{"phone_number":{"type":"string","description":"The personal phone number"},"is_verified":{"type":"boolean","description":"Whether the phone number is verified"},"country_code":{"type":"string","description":"The country code"}},"description":"The [GetOutboundTestPhoneNumbers] function result.","title":"OutboundTestPhonenumberInfoType"},"outboundtestnumbers_GetOutboundTestPhoneNumbers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/OutboundTestPhonenumberInfoType"}}},"title":"outboundtestnumbers_GetOutboundTestPhoneNumbers_Response_200"},"queues_AddQueue_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"acd_queue_id":{"type":"integer","description":"The ACD queue ID"}},"title":"queues_AddQueue_Response_200"},"queues_BindUserToQueue_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"queues_BindUserToQueue_Response_200"},"queues_DelQueue_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"queues_DelQueue_Response_200"},"queues_SetQueueInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"queues_SetQueueInfo_Response_200"},"QueueUsers":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID"}},"description":"The queue users info.","title":"QueueUsers"},"QueueSkills":{"type":"object","properties":{"skill_id":{"type":"integer","description":"The skill ID"},"skill_name":{"type":"string","description":"The skill name"}},"description":"The queue skills info.","title":"QueueSkills"},"QueueInfoType":{"type":"object","properties":{"acd_queue_id":{"type":"integer","description":"The ACD queue ID"},"acd_queue_name":{"type":"string","description":"The queue name"},"application_id":{"type":"integer","description":"The application ID"},"acd_queue_priority":{"type":"integer","description":"The integer queue priority. The highest priority is 0"},"service_probability":{"type":"number","format":"double","description":"The value in the range of [0.5 ... 1.0]. The value 1.0 means the service probability 100% in challenge with a lower priority queue"},"auto_binding":{"type":"boolean","description":"Whether to enable the auto binding of operators to a queue by skills comparing"},"max_waiting_time":{"type":"integer","description":"The maximum predicted waiting time in minutes. When a call is going to be enqueued to the queue, its predicted waiting time should be less or equal to the maximum predicted waiting time; otherwise, a call would be rejected"},"max_queue_size":{"type":"integer","description":"The maximum number of calls that can be enqueued into this queue"},"average_service_time":{"type":"integer","description":"The average service time in seconds. Specify the parameter to correct or initialize the waiting time prediction"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe ACD queue creating UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe ACD queue editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"deleted":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe ACD queue deleting UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"users":{"type":"array","items":{"$ref":"#/components/schemas/QueueUsers"},"description":"The queue users info"},"skills":{"type":"array","items":{"$ref":"#/components/schemas/QueueSkills"},"description":"The queue skills info"},"sl_thresholds":{"type":"array","items":{"type":"integer"},"description":"The service level thresholds in seconds"},"operatorcount":{"type":"integer","description":"Number of agents bound to the queue"}},"description":"The [GetQueues] function result item.","title":"QueueInfoType"},"queues_GetQueues_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/QueueInfoType"}},"total_count":{"type":"integer","description":"The total found queue count"},"count":{"type":"integer","description":"The returned queue count"}},"title":"queues_GetQueues_Response_200"},"ACDReadyOperatorStateType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID of the operator"},"user_name":{"type":"string","description":"The user name of the operator"},"user_display_name":{"type":"string","description":"The display user name of the operator"},"idle_duration":{"type":"integer","description":"The idle duration in seconds. The minimum of the duration after the last hangup and the duration after the operator status changing to READY"}},"description":"The ready operator state.","title":"ACDReadyOperatorStateType"},"ACDLock":{"type":"object","properties":{"id":{"type":"string","description":"The ACD lock ID"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC lock created time in 24-h format: YYYY-MM-DD HH:mm:ss"}},"description":"The [ACD](/api-reference/voxengine/voxengine#enqueueacdrequest) lock type.","title":"ACDLock"},"ACDOperatorCall":{"type":"object","properties":{"acd_session_history_id":{"type":"integer","description":"The ACD session history ID of the request"},"acd_request_id":{"type":"string","description":"The internal ACD session history ID"},"acd_queue_id":{"type":"integer","description":"The ACD queue ID"},"acd_queue_name":{"type":"string","description":"The ACD queue name"},"callerid":{"type":"string","description":"The client callerid"},"begin_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss"},"submitted":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe submission time of the request in 24-h format: YYYY-MM-DD HH:mm:ss"}},"description":"The ACD operator call type.","title":"ACDOperatorCall"},"ACDLockedOperatorStateType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID of the operator"},"user_name":{"type":"string","description":"The user name of the operator"},"user_display_name":{"type":"string","description":"The display user name of the operator"},"unreached":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe UTC time when the operator becomes unavailable in 24-h format: YYYY-MM-DD HH:mm:ss"},"locks":{"type":"array","items":{"$ref":"#/components/schemas/ACDLock"},"description":"The operator locks"},"acd_calls":{"type":"array","items":{"$ref":"#/components/schemas/ACDOperatorCall"},"description":"The ACD operator calls"},"status":{"type":"string","description":"The operator status string. 'BANNED' string indicates temporarily banned operators. The following values are possible: READY, BANNED"}},"description":"The locked operator state.","title":"ACDLockedOperatorStateType"},"ACDAfterServiceOperatorStateType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID of the operator"},"user_name":{"type":"string","description":"The user name of the operator"},"user_display_name":{"type":"string","description":"The display user name of the operator"},"status":{"type":"string","description":"The operator status string"}},"description":"The after service operator state.","title":"ACDAfterServiceOperatorStateType"},"ACDServicingCallStateType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID of the operator"},"user_name":{"type":"string","description":"The user name of the operator"},"user_display_name":{"type":"string","description":"The display user name of the operator"},"priority":{"type":"integer","description":"The request priority"},"callerid":{"type":"string","description":"The client callerid"},"begin_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss"},"waiting_time":{"type":"integer","description":"The waiting time before servicing in seconds"},"acd_session_history_id":{"type":"integer","description":"The ACD session history ID of the request"}},"description":"The servicing call state.","title":"ACDServicingCallStateType"},"ACDWaitingCallStateType":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID of the operator to try to service the request"},"user_name":{"type":"string","description":"The user name of the operator"},"user_display_name":{"type":"string","description":"The display user name of the operator"},"priority":{"type":"integer","description":"The request priority"},"callerid":{"type":"string","description":"The client callerid"},"begin_time":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe begin time of the request in 24-h format: YYYY-MM-DD HH:mm:ss"},"waiting_time":{"type":"integer","description":"The waiting time in seconds"},"minutes_to_submit":{"type":"integer","description":"The predicted minutes left to start servicing"},"acd_session_history_id":{"type":"integer","description":"The ACD session history ID of the request"}},"description":"The waiting call state.","title":"ACDWaitingCallStateType"},"ACDQueueStateType":{"type":"object","properties":{"acd_queue_id":{"type":"integer","description":"The ACD queue ID"},"ready_operators":{"type":"array","items":{"$ref":"#/components/schemas/ACDReadyOperatorStateType"},"description":"List of operators with the 'READY' state that can accept a call from this queue"},"ready_operators_count":{"type":"integer","description":"Number of ready operators"},"locked_operators":{"type":"array","items":{"$ref":"#/components/schemas/ACDLockedOperatorStateType"},"description":"List of operators with the 'READY' state that cannot accept a call from this queue. Operator cannot accept a call if they are temporarily banned, or they are servicing a call right now"},"locked_operators_count":{"type":"integer","description":"Number of locked operators"},"after_service_operators":{"type":"array","items":{"$ref":"#/components/schemas/ACDAfterServiceOperatorStateType"},"description":"List of operators with the 'AFTER_SERVICE' state. This state is set right after a call is ended to indicate a call postprocessing"},"after_service_operator_count":{"type":"integer","description":"Number of operators with the 'AFTER SERVICE' state"},"servicing_calls":{"type":"array","items":{"$ref":"#/components/schemas/ACDServicingCallStateType"},"description":"List of calls enqueued into this queue that are being serviced right now by operators"},"waiting_calls":{"type":"array","items":{"$ref":"#/components/schemas/ACDWaitingCallStateType"},"description":"List of calls enqueued into this queue that are not yet serviced by operators"},"acd_queue_name":{"type":"string"},"ready_operator_count":{"type":"integer"},"locked_operator_count":{"type":"integer"}},"description":"The ACD queue state.","title":"ACDQueueStateType"},"ACDStateType":{"type":"object","properties":{"acd_queues":{"type":"array","items":{"$ref":"#/components/schemas/ACDQueueStateType"},"description":"The queues' states"}},"description":"The [GetACDState] function result item.","title":"ACDStateType"},"queues_GetACDState_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/ACDStateType"}},"title":"queues_GetACDState_Response_200"},"AcdOperatorAggregationGroupTypeUserId":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"If aggregation is enabled, contains user ID for the results","title":"AcdOperatorAggregationGroupTypeUserId"},"ACDStatisticsItemType":{"type":"object","properties":{"min":{"type":"integer","description":"Minimum value over the aggregated interval, in seconds"},"avg":{"type":"integer","description":"Average value over the aggregated interval, in seconds"},"max":{"type":"integer","description":"Maximum value over the aggregated interval, in seconds"},"count":{"type":"integer","description":"Samples count over the aggregated interval"},"sum":{"type":"integer","description":"Sum of all samples over the aggregated interval, in seconds"}},"description":"Individual statistics item in the [ACDOperatorStatisticsType], [ACDQueueStatisticsType], and [ACDOperatorStatusStatisticsDetail] records.","title":"ACDStatisticsItemType"},"ACDOperatorStatisticsType":{"type":"object","properties":{"user_id":{"type":"string","description":"If aggregation is enabled, contains user ID for the results"},"date":{"type":"string","description":"Date string as returned by the Management API.\n\nIf aggregation is enabled, contains UTC date for the results in 24-h 'YYYY-MM-DD' format"},"hour":{"type":"integer","description":"If aggregation is enabled, contains the 60-minute interval number from 1 to 24"},"SA":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Delay between a call started to ring and operator answered it. Name is 'SpeedOfAnswer' if 'abbreviation' is set to 'false'"},"TT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Time between operator answering and ending a call. Name is 'TalkTime' if 'abbreviation' is set to 'false'"},"ACW":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Time between operator ended a call and changed status to a one different from the 'AFTER_SERVICE'. This time is tracked only if operator changed status to 'AFTER_SERVICE' after the call. Name is 'AfterCallWork' if 'abbreviation' is set to 'false'"},"HT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Sum of 'TalkTime' and 'AfterCallWork'. Name is 'HandlingTime' if 'abbreviation' is set to 'false'"},"AC":{"type":"integer","description":"Number of answered calls. Name is 'AnsweredCalls' if 'abbreviation' is set to 'false'"},"UAC":{"type":"integer","description":"Number of unanswered calls. Name is 'UnansweredCalls' if 'abbreviation' is set to 'false'"},"TDT":{"type":"integer","description":"Sum of delays between calls started to ring and operator answered them, in seconds. Name is 'TotalDialingTime' if 'abbreviation' is set to 'false'"},"THT":{"type":"integer","description":"Sum of 'HandlingTime', in seconds. Name is 'TotalHandlingTime' if 'abbreviation' is set to 'false'"},"TTT":{"type":"integer","description":"Sum of 'TalkTime', in seconds. Name is 'TotalTalkTime' if 'abbreviation' is set to 'false'"},"TACW":{"type":"integer","description":"Sum of 'AfterCallWork', in seconds. Name is 'TotalAfterCallWork' if 'abbreviation' is set to 'false'"}},"description":"Individual record in the [ACDOperatorAggregationGroupType] group.","title":"ACDOperatorStatisticsType"},"ACDOperatorAggregationGroupType":{"type":"object","properties":{"user_id":{"$ref":"#/components/schemas/AcdOperatorAggregationGroupTypeUserId","description":"If aggregation is enabled, contains user ID for the results"},"date":{"type":"string","description":"Date string as returned by the Management API.\n\nIf aggregation is enabled, contains UTC date for the results in 24-h 'YYYY-MM-DD' format"},"hour":{"type":"integer","description":"If aggregation is enabled, contains the 60-minute interval number from 1 to 24"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/ACDOperatorStatisticsType"},"description":"List of records grouped by date or user ID according to the 'group' method call argument"}},"description":"The [GetACDOperatorStatistics] function result item.","title":"ACDOperatorAggregationGroupType"},"queues_GetACDOperatorStatistics_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ACDOperatorAggregationGroupType"},"description":"List of groups, grouped by user ID or date according to the 'group' method call argument"}},"title":"queues_GetACDOperatorStatistics_Response_200"},"ACDStatisticsCalls":{"type":"object","properties":{"count":{"type":"integer","description":"Absolute number of calls"},"percent":{"type":"integer","description":"Percentage of answered/rejected/unanswered calls, is counted against total number of calls"}},"description":"Individual statistics item in the [ACDQueueStatisticsType] record.","title":"ACDStatisticsCalls"},"ACDQueueStatisticsServiceLevelType":{"type":"object","properties":{"acceptable_waiting_time":{"type":"integer","description":"Maximum time, is seconds, user is waiting operator for a given service level"},"call_count":{"type":"integer","description":"Number of calls for a given service level"},"service_level":{"type":"integer","description":"Percentage of calls for a given service level, from 0 (non-inclusive) up to 1 (all calls)"}},"description":"Individual service level description used in the [ACDQueueStatisticsType].","title":"ACDQueueStatisticsServiceLevelType"},"ACDQueueStatisticsType":{"type":"object","properties":{"date":{"type":"string","description":"Date string as returned by the Management API.\n\nIf aggregation is enabled, contains UTC date for the results in 24-h 'YYYY-MM-DD' format"},"hour":{"type":"integer","description":"If aggregation is enabled, contains the 60-minute interval number from 1 to 24"},"WT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Delay between user called and operator answered the call (or call is terminated). Name is 'WaitingTime' if 'abbreviation' is set to 'false'"},"SA":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Delay between a call started to ring and operator answered it. Name is 'SpeedOfAnswer' if 'abbreviation' is set to 'false'"},"AT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Time between user called Voximplant cloud and time they disconnect not reaching the operator. Name is 'AbandonmentTime' if 'abbreviation' is set to 'false'"},"HT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Sum of 'TalkTime' and 'AfterCallWork'. Name is 'HandlingTime' if 'abbreviation' is set to 'false'"},"TT":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Time between operator answering and ending a call. Name is 'TalkTime' if 'abbreviation' is set to 'false'"},"ACW":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"Time between operator ended a call and changed status to a one different from the 'AFTER_SERVICE'. This time is tracked only if operator changed status to 'AFTER_SERVICE' after the call. Name is 'AfterCallWork' if 'abbreviation' is set to 'false'"},"QL":{"$ref":"#/components/schemas/ACDStatisticsItemType","description":"How many users are in the queue. Name is 'QueueLength' if 'abbreviation' is set to 'false'"},"TC":{"type":"integer","description":"Total number of calls. Name is 'TotalCalls' if 'abbreviation' is set to 'false'"},"AC":{"type":"array","items":{"$ref":"#/components/schemas/ACDStatisticsCalls"},"description":"Number of answered calls. Name is 'AnsweredCalls' if 'abbreviation' is set to 'false'"},"UAC":{"type":"array","items":{"$ref":"#/components/schemas/ACDStatisticsCalls"},"description":"Number of unanswered calls. Name is 'UnansweredCalls' if 'abbreviation' is set to 'false'"},"RC":{"type":"array","items":{"$ref":"#/components/schemas/ACDStatisticsCalls"},"description":"Number of calls rejected by the ACD. Call is rejected if all operators are offline or banned, or queue length is exceeded, or predicted answer time exceeds maximum specified for the query. Name is 'RejectedCalls' if 'abbreviation' is set to 'false'"},"SL":{"type":"array","items":{"$ref":"#/components/schemas/ACDQueueStatisticsServiceLevelType"},"description":"List of service levels. Name is 'ServiceLevel' if 'abbreviation' is set to 'false'"},"TWT":{"type":"integer","description":"Sum of 'WaitingTime', in seconds. Name is 'TotalWaitingTime' if 'abbreviation' is set to 'false'"},"TST":{"type":"integer","description":"Sum of 'SpeedOfAnswer', in seconds. Name is 'TotalSubmissionTime' if 'abbreviation' is set to 'false'"},"TAT":{"type":"integer","description":"Sum for all times between user called Voximplant cloud and time they disconnect not reaching the operator, in seconds. Name is 'TotalAbandonmentTime' if 'abbreviation' is set to 'false'"},"THT":{"type":"integer","description":"Sum of 'HandlingTime', in seconds. Name is 'TotalHandlingTime' if 'abbreviation' is set to 'false'"},"TTT":{"type":"integer","description":"Sum of 'TalkTime', in seconds. Name is 'TotalTalkTime' if 'abbreviation' is set to 'false'"},"TACW":{"type":"integer","description":"Sum of 'AfterCallWork', in seconds. Name is 'TotalAfterCallWork' if 'abbreviation' is set to 'false'"}},"description":"Individual record in the [ACDOperatorAggregationGroupType] group.","title":"ACDQueueStatisticsType"},"queues_GetACDQueueStatistics_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ACDQueueStatisticsType"},"description":"List of records grouped grouped by date according to the 'aggregation' method call argument"}},"title":"queues_GetACDQueueStatistics_Response_200"},"AcdOperatorStatusAggregationGroupTypeUserId":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"If aggregation is enabled, contains user ID for the results","title":"AcdOperatorStatusAggregationGroupTypeUserId"},"AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Ready":{"type":"object","properties":{"min":{"type":"integer"},"avg":{"type":"integer"},"max":{"type":"integer"},"count":{"type":"integer"},"sum":{"type":"integer"}},"title":"AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Ready"},"AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Online":{"type":"object","properties":{"min":{"type":"integer"},"avg":{"type":"integer"},"max":{"type":"integer"},"count":{"type":"integer"},"sum":{"type":"integer"}},"title":"AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Online"},"AcdOperatorStatusStatisticsTypeAcdStatus1":{"type":"object","properties":{"READY":{"$ref":"#/components/schemas/AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Ready"},"ONLINE":{"$ref":"#/components/schemas/AcdOperatorStatusStatisticsTypeAcdStatusOneOf1Online"}},"title":"AcdOperatorStatusStatisticsTypeAcdStatus1"},"AcdOperatorStatusStatisticsTypeAcdStatus":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"$ref":"#/components/schemas/AcdOperatorStatusStatisticsTypeAcdStatus1"}],"description":"The user statistics","title":"AcdOperatorStatusStatisticsTypeAcdStatus"},"ACDOperatorStatusStatisticsType":{"type":"object","properties":{"user_id":{"type":"string","description":"If aggregation is enabled, contains user ID for the results"},"date":{"type":"string","description":"Date string as returned by the Management API.\n\nIf aggregation is enabled, contains UTC date for the results in 24-h 'YYYY-MM-DD' format"},"hour":{"type":"integer","description":"If aggregation is enabled, contains the 60-minute interval number from 1 to 24"},"acd_status":{"$ref":"#/components/schemas/AcdOperatorStatusStatisticsTypeAcdStatus","description":"The user statistics"}},"description":"Individual record in the [ACDOperatorStatusAggregationGroupType] group.","title":"ACDOperatorStatusStatisticsType"},"ACDOperatorStatusAggregationGroupType":{"type":"object","properties":{"user_id":{"$ref":"#/components/schemas/AcdOperatorStatusAggregationGroupTypeUserId","description":"If aggregation is enabled, contains user ID for the results"},"date":{"type":"string","description":"Date string as returned by the Management API.\n\nIf aggregation is enabled, contains UTC date for the results in 24-h 'YYYY-MM-DD' format"},"hour":{"type":"integer","description":"If aggregation is enabled, contains the 60-minute interval number from 1 to 24"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/ACDOperatorStatusStatisticsType"},"description":"List of records grouped by date or user ID according to the 'group' method call argument"}},"description":"The [GetACDOperatorStatusStatistics] function result item.","title":"ACDOperatorStatusAggregationGroupType"},"queues_GetACDOperatorStatusStatistics_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ACDOperatorStatusAggregationGroupType"},"description":"List of groups, grouped by user ID or date according to the 'group' method call argument"}},"title":"queues_GetACDOperatorStatusStatistics_Response_200"},"SmartQueueMetricsGroupsValues":{"type":"object","properties":{"from_date":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe start of the period"},"to_date":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe end of the period"},"value":{"type":"integer","description":"The report value"}},"description":"The [SmartQueueMetricsGroups] details.","title":"SmartQueueMetricsGroupsValues"},"SmartQueueMetricsGroups":{"type":"object","properties":{"sq_queue_id":{"type":"integer","description":"The SmartQueue ID"},"sq_queue_name":{"type":"string","description":"The SmartQueue name"},"user_id":{"type":"integer","description":"The user ID"},"user_name":{"type":"string","description":"The user name"},"user_display_name":{"type":"string","description":"The user display name"},"values":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueMetricsGroupsValues"},"description":"The group values"}},"description":"The [SmartQueueMetricsResult] details.","title":"SmartQueueMetricsGroups"},"SmartQueueMetricsResult":{"type":"object","properties":{"report_type":{"type":"string","description":"The report type(s). Possible values are calls_blocked_percentage, count_blocked_calls, average_abandonment_rate, count_abandonment_calls, service_level, occupancy_rate, sum_agents_online_time, sum_agents_ready_time, sum_agents_dialing_time, sum_agents_in_service_time, sum_agents_afterservice_time, sum_agents_dnd_time, sum_agents_banned_time, min_time_in_queue,max_time_in_queue, average_time_in_queue, min_answer_speed, max_answer_speed, average_answer_speed, min_handle_time, max_handle_time, average_handle_time, count_handled_calls, min_after_call_worktime, max_after_call_worktime, average_after_call_worktime, sum_agents_custom_1_time ... sum_agents_custom_10_time, call_count_assigned_to_queue, im_count_assigned_to_queue"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueMetricsGroups"},"description":"Grouping by agent or queue"}},"description":"The [GetSmartQueueRealtimeMetrics] function result.","title":"SmartQueueMetricsResult"},"smartqueue_GetSmartQueueRealtimeMetrics_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueMetricsResult"}},"timezone":{"type":"string","description":"The used timezone, e.g., 'Etc/GMT'"}},"title":"smartqueue_GetSmartQueueRealtimeMetrics_Response_200"},"smartqueue_GetSmartQueueDayHistory_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueMetricsResult"}},"timezone":{"type":"string","description":"The used timezone, e.g., 'Etc/GMT'"}},"title":"smartqueue_GetSmartQueueDayHistory_Response_200"},"smartqueue_RequestSmartQueueHistory_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"history_report_id":{"type":"integer","description":"History report ID"}},"title":"smartqueue_RequestSmartQueueHistory_Response_200"},"SmartQueueAgent_Skill":{"type":"object","properties":{"sq_skill_id":{"type":"integer","description":"The agent skill ID"},"sq_skill_name":{"type":"string","description":"The agent skill name"},"sq_skill_level":{"type":"integer","description":"The agent skill level"}},"description":"Agent skill info.","title":"SmartQueueAgent_Skill"},"SmartQueueStateAgentSqStatusesOneOf1Call":{"type":"object","properties":{"from_date":{"type":"string"},"sq_status_name":{"type":"string"}},"title":"SmartQueueStateAgentSqStatusesOneOf1Call"},"SmartQueueStateAgentSqStatusesOneOf1Im":{"type":"object","properties":{"from_date":{"type":"string"},"sq_status_name":{"type":"string"}},"title":"SmartQueueStateAgentSqStatusesOneOf1Im"},"SmartQueueStateAgentSqStatuses1":{"type":"object","properties":{"CALL":{"$ref":"#/components/schemas/SmartQueueStateAgentSqStatusesOneOf1Call"},"IM":{"$ref":"#/components/schemas/SmartQueueStateAgentSqStatusesOneOf1Im"}},"title":"SmartQueueStateAgentSqStatuses1"},"SmartQueueStateAgentSqStatuses":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"$ref":"#/components/schemas/SmartQueueStateAgentSqStatuses1"}],"description":"Agent statuses info","title":"SmartQueueStateAgentSqStatuses"},"SmartQueueState_Agent":{"type":"object","properties":{"user_id":{"type":"integer","description":"The user ID"},"user_name":{"type":"string","description":"The user name"},"user_display_name":{"type":"string","description":"The display user name"},"sq_skills":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueAgent_Skill"},"description":"Agent skills"},"sq_statuses":{"$ref":"#/components/schemas/SmartQueueStateAgentSqStatuses","description":"Agent statuses info"}},"description":"SmartQueueState.sq_agents item.","title":"SmartQueueState_Agent"},"SmartQueueTask_Skill":{"type":"object","properties":{"sq_skill_name":{"type":"string","description":"The skill name"},"sq_skill_level":{"type":"integer","description":"The skill level"}},"description":"Task skill info.","title":"SmartQueueTask_Skill"},"SmartQueueState_Task":{"type":"object","properties":{"task_type":{"type":"string","description":"The task type. Possible values are CALL, IM"},"status":{"type":"string","description":"The task status. Possible values are IN_QUEUE, DISTRIBUTED, IN_PROCESSING"},"user_id":{"type":"integer","description":"Selected agent"},"sq_skills":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueTask_Skill"},"description":"Task skills"},"waiting_time":{"type":"integer","description":"Waiting time in ms"},"processing_time":{"type":"integer","description":"Processing time in ms"},"custom_data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Custom data text string for the current task. You can set the custom data in the [enqueueTask](/api-reference/voxengine/voxengine#enqueuetask) method"}},"description":"SmartQueueState.tasks item.","title":"SmartQueueState_Task"},"SmartQueueState":{"type":"object","properties":{"sq_queue_id":{"type":"integer","description":"The SmartQueue ID"},"sq_queue_name":{"type":"string","description":"The SmartQueue name"},"sq_agents":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueState_Agent"},"description":"The list of logged-in agents with their skills and statuses"},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueState_Task"},"description":"The list of tasks"}},"description":"The [GetSQState] function result.","title":"SmartQueueState"},"smartqueue_GetSQState_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SmartQueueState"}}},"title":"smartqueue_GetSQState_Response_200"},"smartqueue_SQ_SetAgentCustomStatusMapping_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_SetAgentCustomStatusMapping_Response_200"},"SqGetAgentCustomStatusMappingPostResponsesContentApplicationJsonSchemaResultItems":{"type":"object","properties":{"custom_status_name":{"type":"string"},"sq_status_name":{"type":"string"}},"title":"SqGetAgentCustomStatusMappingPostResponsesContentApplicationJsonSchemaResultItems"},"smartqueue_SQ_GetAgentCustomStatusMapping_Response_200":{"type":"object","properties":{"sq_status_name":{"type":"string","description":"Status name"},"custom_status_name":{"type":"string","description":"Custom status name"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SqGetAgentCustomStatusMappingPostResponsesContentApplicationJsonSchemaResultItems"}}},"title":"smartqueue_SQ_GetAgentCustomStatusMapping_Response_200"},"smartqueue_SQ_DeleteAgentCustomStatusMapping_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_DeleteAgentCustomStatusMapping_Response_200"},"SQAddQueueResult":{"type":"object","properties":{"sq_queue_id":{"type":"integer","description":"ID of the added queue"}},"description":"The [SQ_AddQueue] function result.","title":"SQAddQueueResult"},"smartqueue_SQ_AddQueue_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/SQAddQueueResult","description":"Result with ID of the added queue"}},"title":"smartqueue_SQ_AddQueue_Response_200"},"smartqueue_SQ_SetQueueInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_SetQueueInfo_Response_200"},"smartqueue_SQ_DelQueue_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_DelQueue_Response_200"},"GetSqQueuesResultCall":{"type":"object","properties":{"task_selection":{"type":"string"},"agent_selection":{"type":"string"},"max_waiting_time":{"type":"integer"},"max_queue_size":{"type":"integer"},"max_waiting_time_in_seconds":{"type":"integer"}},"title":"GetSqQueuesResultCall"},"GetSqQueuesResultIm":{"type":"object","properties":{"task_selection":{"type":"string"},"agent_selection":{"type":"string"},"max_waiting_time":{"type":"integer"},"max_queue_size":{"type":"integer"},"max_waiting_time_in_seconds":{"type":"integer"}},"title":"GetSqQueuesResultIm"},"GetSQQueuesResult":{"type":"object","properties":{"sq_queue_id":{"type":"integer","description":"ID of the SmartQueue"},"sq_queue_name":{"type":"string","description":"Name of the SmartQueue"},"hold_im_if_inactive_agents":{"type":"boolean","description":"Whether the tasks are queued when there are no active agents"},"agent_selection":{"type":"string","description":"Agent selection strategy"},"task_selection":{"type":"string","description":"Strategy of prioritizing requests for service"},"hold_calls_if_inactive_agents":{"type":"boolean","description":"Whether the call task is kept in the queue if all agents are unavailable"},"description":{"type":"string","description":"Comment"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of the queue creation in 24-h format: YYYY-MM-DD HH:mm:ss"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of the queue modification in 24-h format: YYYY-MM-DD HH:mm:ss"},"call_max_waiting_time":{"type":"integer","default":120,"description":"Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent in minutes. If the value has been passed in seconds, this field is also present in the answer, rounded to the bigger number"},"call_max_waiting_time_in_seconds":{"type":"integer","description":"Maximum time in minutes that a CALL-type request can remain in the queue without being assigned to an agent in seconds. If the value has been passed in minutes, this field is also present in the answer"},"im_max_waiting_time":{"type":"integer","default":120,"description":"Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent in minutes. If the value has been passed in seconds, this field is also present in the answer, rounded to the bigger number"},"im_max_waiting_time_in_seconds":{"type":"integer","description":"Maximum time in minutes that an IM-type request can remain in the queue without being assigned to an agent in seconds. If the value has been passed in minutes, this field is also present in the answer"},"call_max_queue_size":{"type":"integer","default":1000,"description":"Maximum size of the queue with CALL-type requests"},"im_max_queue_size":{"type":"integer","default":1000,"description":"Maximum size of the queue with IM-type requests"},"agentcount":{"type":"integer","description":"Number of agents bound to the queue"},"CALL":{"$ref":"#/components/schemas/GetSqQueuesResultCall"},"IM":{"$ref":"#/components/schemas/GetSqQueuesResultIm"},"call_agent_selection":{"type":"string"},"priority":{"type":"integer"},"im_task_selection":{"type":"string"},"im_agent_selection":{"type":"string"},"call_task_selection":{"type":"string"}},"description":"The [SQ_GetQueues] function result.","title":"GetSQQueuesResult"},"smartqueue_SQ_GetQueues_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/GetSQQueuesResult"},"description":"The found queue(s)"},"total_count":{"type":"integer"},"count":{"type":"integer"}},"title":"smartqueue_SQ_GetQueues_Response_200"},"smartqueue_SQ_AddSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Result with ID of the added skill"}},"title":"smartqueue_SQ_AddSkill_Response_200"},"smartqueue_SQ_DelSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_DelSkill_Response_200"},"smartqueue_SQ_SetSkillInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_SetSkillInfo_Response_200"},"smartqueue_SQ_BindSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_BindSkill_Response_200"},"smartqueue_SQ_UnbindSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_UnbindSkill_Response_200"},"GetSQSkillsResult":{"type":"object","properties":{"sq_skill_id":{"type":"integer","description":"ID of the skill"},"sq_skill_name":{"type":"string","description":"Name of the skill"},"description":{"type":"string","description":"Comment"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of the queue creation in 24-h format: YYYY-MM-DD HH:mm:ss"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nUTC date of the queue modification in 24-h format: YYYY-MM-DD HH:mm:ss"},"sq_skill_name:":{"type":"string"}},"description":"The [SQ_GetSkills] function result.","title":"GetSQSkillsResult"},"smartqueue_SQ_GetSkills_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/GetSQSkillsResult"},"description":"The found skill(s)."},"count":{"type":"integer"},"total_count":{"type":"integer"}},"title":"smartqueue_SQ_GetSkills_Response_200"},"smartqueue_SQ_BindAgent_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_BindAgent_Response_200"},"smartqueue_SQ_UnbindAgent_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_UnbindAgent_Response_200"},"GetSqAgentsResultSqStatusesOneOf1Call":{"type":"object","properties":{"sq_status_name":{"type":"string"}},"title":"GetSqAgentsResultSqStatusesOneOf1Call"},"GetSqAgentsResultSqStatusesOneOf1Im":{"type":"object","properties":{"sq_status_name":{"type":"string"}},"title":"GetSqAgentsResultSqStatusesOneOf1Im"},"GetSqAgentsResultSqStatuses1":{"type":"object","properties":{"CALL":{"$ref":"#/components/schemas/GetSqAgentsResultSqStatusesOneOf1Call"},"IM":{"$ref":"#/components/schemas/GetSqAgentsResultSqStatusesOneOf1Im"}},"title":"GetSqAgentsResultSqStatuses1"},"GetSqAgentsResultSqStatuses":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"$ref":"#/components/schemas/GetSqAgentsResultSqStatuses1"}],"description":"Agent statuses info","title":"GetSqAgentsResultSqStatuses"},"GetSQAgentsResult":{"type":"object","properties":{"user_id":{"type":"integer","description":"ID of the user"},"user_name":{"type":"string","description":"Name of the user"},"user_display_name":{"type":"string","description":"Display name of the user"},"max_simultaneous_conversations":{"type":"integer","description":"Maximum number of chats that the user processes simultaneously"},"sq_statuses":{"$ref":"#/components/schemas/GetSqAgentsResultSqStatuses","description":"Agent statuses info"},"sq_queues":{"type":"object","additionalProperties":{"description":"Any type"},"description":"JSON array of the agent's queues"},"sq_skills":{"type":"object","additionalProperties":{"description":"Any type"},"description":"JSON array of the agent's skills"},"user_name:":{"type":"string"}},"description":"The [SQ_GetAgents] function result.","title":"GetSQAgentsResult"},"smartqueue_SQ_GetAgents_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/GetSQAgentsResult"},"description":"The found agent(s)"},"count":{"type":"integer"},"total_count":{"type":"integer"}},"title":"smartqueue_SQ_GetAgents_Response_200"},"smartqueue_SQ_SetAgentInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"smartqueue_SQ_SetAgentInfo_Response_200"},"skills_AddSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"skill_id":{"type":"integer","description":"The skill ID"}},"title":"skills_AddSkill_Response_200"},"skills_DelSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"skills_DelSkill_Response_200"},"skills_SetSkillInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"skills_SetSkillInfo_Response_200"},"skills_GetSkills_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SkillInfoType"}},"total_count":{"type":"integer","description":"The total found skill count"},"count":{"type":"integer","description":"The returned skill count"}},"title":"skills_GetSkills_Response_200"},"skills_BindSkill_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"skills_BindSkill_Response_200"},"admin-users_AddAdminUser_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"admin_user_id":{"type":"integer","description":"The new admin user ID"},"admin_user_api_key":{"type":"string","description":"The admin user API key"}},"title":"admin-users_AddAdminUser_Response_200"},"admin-users_DelAdminUser_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"admin-users_DelAdminUser_Response_200"},"admin-users_SetAdminUserInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"admin-users_SetAdminUserInfo_Response_200"},"AdminRoleTypeAdminUsersItems":{"type":"object","properties":{"admin_user_id":{"type":"integer"}},"title":"AdminRoleTypeAdminUsersItems"},"AdminRoleType":{"type":"object","properties":{"admin_role_id":{"type":"integer","description":"The admin role ID"},"admin_role_name":{"type":"string","description":"The admin role name"},"admin_role_active":{"type":"boolean","description":"Whether to ignore the allowed and denied entries"},"system_role":{"type":"boolean","description":"Whether it is a system role"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe admin role editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"allowed_entries":{"type":"array","items":{"type":"string"},"description":"The allowed access entries (the API function names)"},"denied_entries":{"type":"array","items":{"type":"string"},"description":"The denied access entries (the API function names)"},"admin_users":{"type":"array","items":{"$ref":"#/components/schemas/AdminRoleTypeAdminUsersItems"}}},"description":"The [GetAdminRoles] function result.","title":"AdminRoleType"},"AdminUserType":{"type":"object","properties":{"admin_user_id":{"type":"integer","description":"The admin user ID"},"admin_user_name":{"type":"string","description":"The admin user name"},"admin_user_display_name":{"type":"string","description":"The admin user display name"},"admin_user_active":{"type":"boolean","description":"Whether login is allowed"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe admin user editing UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"},"access_entries":{"type":"array","items":{"type":"string"},"description":"The allowed access entries (the API function names)"},"admin_roles":{"type":"array","items":{"$ref":"#/components/schemas/AdminRoleType"},"description":"The attached admin roles"}},"description":"The [GetAdminUsers] function result.","title":"AdminUserType"},"admin-users_GetAdminUsers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserType"}},"total_count":{"type":"integer","description":"The total found admin user count"},"count":{"type":"integer","description":"The returned admin user count"}},"title":"admin-users_GetAdminUsers_Response_200"},"admin-users_AttachAdminRole_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"admin-users_AttachAdminRole_Response_200"},"admin-roles_AddAdminRole_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"},"admin_role_id":{"type":"integer","description":"The new admin role ID"}},"title":"admin-roles_AddAdminRole_Response_200"},"admin-roles_DelAdminRole_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"admin-roles_DelAdminRole_Response_200"},"admin-roles_SetAdminRoleInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"admin-roles_SetAdminRoleInfo_Response_200"},"admin-roles_GetAdminRoles_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AdminRoleType"}},"total_count":{"type":"integer","description":"The total found admin role count"},"count":{"type":"integer","description":"The returned admin role count"}},"title":"admin-roles_GetAdminRoles_Response_200"},"admin-roles_GetAvailableAdminRoleEntries_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"type":"string"},"description":"Array of the admin role entries"}},"title":"admin-roles_GetAvailableAdminRoleEntries_Response_200"},"authorized-ips_AddAuthorizedAccountIP_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the request has been completed successfully"}},"title":"authorized-ips_AddAuthorizedAccountIP_Response_200"},"authorized-ips_DelAuthorizedAccountIP_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"The removed network count"}},"title":"authorized-ips_DelAuthorizedAccountIP_Response_200"},"AuthorizedAccountIpTypeAllowed":{"oneOf":[{"type":"boolean"},{"type":"string"}],"description":"Whether the IP is allowed (true - whitelist, false - blacklist)","title":"AuthorizedAccountIpTypeAllowed"},"AuthorizedAccountIPType":{"type":"object","properties":{"authorized_ip":{"type":"string","description":"The authorized IP4 or network"},"allowed":{"$ref":"#/components/schemas/AuthorizedAccountIpTypeAllowed","description":"Whether the IP is allowed (true - whitelist, false - blacklist)"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nThe item creating UTC date in 24-h format: YYYY-MM-DD HH:mm:ss"}},"description":"The [GetAuthorizedAccountIPs] function result.","title":"AuthorizedAccountIPType"},"authorized-ips_GetAuthorizedAccountIPs_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AuthorizedAccountIPType"}},"total_count":{"type":"integer","description":"The total found network count"},"count":{"type":"integer","description":"The returned network count"}},"title":"authorized-ips_GetAuthorizedAccountIPs_Response_200"},"authorized-ips_CheckAuthorizedAccountIP_Response_200":{"type":"object","properties":{"result":{"type":"boolean","description":"Whether the IP is allowed"},"authorized_ip":{"type":"string","description":"The matched authorized IP or network (if found)"}},"title":"authorized-ips_CheckAuthorizedAccountIP_Response_200"},"LinkRegulationAddressPostResponsesContentApplicationJsonSchemaResult":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"title":"LinkRegulationAddressPostResponsesContentApplicationJsonSchemaResult"},"regulation-address_LinkRegulationAddress_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/LinkRegulationAddressPostResponsesContentApplicationJsonSchemaResult"}},"title":"regulation-address_LinkRegulationAddress_Response_200"},"ZipCode":{"type":"object","properties":{"city":{"type":"string","description":"The city name"},"zip_code":{"type":"string","description":"The zip code"}},"description":"The ZipCode record.","title":"ZipCode"},"regulation-address_GetZIPCodes_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/ZipCode"},"description":"The ZipCode records"},"count":{"type":"integer","description":"The returned zip codes count"}},"title":"regulation-address_GetZIPCodes_Response_200"},"RegulationAddress":{"type":"object","properties":{"regulation_address_id":{"type":"integer","description":"The regulation address ID"},"external_id":{"type":"string","description":"The external ID"},"country_code":{"type":"string","description":"The country code"},"phone_category_name":{"type":"string","description":"The phone category name"},"salutation":{"type":"string","description":"The salutation. Possible values: MR, MS, COMPANY"},"company":{"type":"string","description":"The company name"},"first_name":{"type":"string","description":"The first name"},"last_name":{"type":"string","description":"The last name"},"owner_country_code":{"type":"string","description":"The owner country code"},"city":{"type":"string","description":"The city name"},"zip_code":{"type":"string","description":"The zip code"},"street":{"type":"string","description":"The zip code"},"builder_number":{"type":"string","description":"The builder number"},"builder_latter":{"type":"string","description":"The builder latter"},"status":{"type":"string","description":"The status verification. Possible values: IN_PROGRESS, VERIFIED, DECLINED"},"reject_message":{"type":"string","description":"The reject message"},"id":{"type":"integer"}},"description":"The [GetRegulationsAddress] and [GetAvailableRegulations] result.","title":"RegulationAddress"},"regulation-address_GetRegulationsAddress_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RegulationAddress"},"description":"The RegulationAddress records"},"count":{"type":"integer","description":"The returned regulation address count"}},"title":"regulation-address_GetRegulationsAddress_Response_200"},"GetAvailableRegulationsPostResponsesContentApplicationJsonSchemaResult":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"description":"Whether the user has at least one regulation address which is appropriate for verification or the verification is not required. If result is false, the regulations address needs to be created","title":"GetAvailableRegulationsPostResponsesContentApplicationJsonSchemaResult"},"regulation-address_GetAvailableRegulations_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/GetAvailableRegulationsPostResponsesContentApplicationJsonSchemaResult","description":"Whether the user has at least one regulation address which is appropriate for verification or the verification is not required. If result is false, the regulations address needs to be created"},"available_address":{"type":"array","items":{"$ref":"#/components/schemas/RegulationAddress"},"description":"The available RegulationAddress records"},"count_in_progress":{"type":"integer","description":"The count of RegulationAddress in progress status"}},"title":"regulation-address_GetAvailableRegulations_Response_200"},"RegulationCountry":{"type":"object","properties":{"country_code":{"type":"string","description":"The country code A2"},"country_name":{"type":"string","description":"The country name"}},"description":"The country record.","title":"RegulationCountry"},"regulation-address_GetCountries_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RegulationCountry"}},"count":{"type":"integer"}},"title":"regulation-address_GetCountries_Response_200"},"RegulationRegionRecord":{"type":"object","properties":{"phone_region_id":{"type":"integer","description":"The regulation address ID"},"phone_region_name":{"type":"string","description":"The region name"},"phone_region_code":{"type":"string","description":"The phone region code"},"is_need_regulation_address":{"type":"boolean","description":"Whether need to confirm the address"},"regulation_address_type":{"type":"string","description":"The regulation address type. Available: LOCAL, NATIONAL, WORLDWIDE"}},"description":"The [GetRegions] function result.","title":"RegulationRegionRecord"},"regulation-address_GetRegions_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RegulationRegionRecord"}},"count":{"type":"integer"}},"title":"regulation-address_GetRegions_Response_200"},"push-credentials_AddPushCredential_Response_200":{"type":"object","properties":{"result":{"type":"integer"},"push_credential_id":{"type":"integer"}},"title":"push-credentials_AddPushCredential_Response_200"},"push-credentials_SetPushCredential_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"push-credentials_SetPushCredential_Response_200"},"push-credentials_DelPushCredential_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"push-credentials_DelPushCredential_Response_200"},"PushCredentialInfoContent1":{"type":"object","properties":{"file_name":{"type":"string"}},"title":"PushCredentialInfoContent1"},"PushCredentialInfoContent":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"$ref":"#/components/schemas/PushCredentialInfoContent1"}],"description":"The credentials content","title":"PushCredentialInfoContent"},"PushCredentialInfo":{"type":"object","properties":{"push_credential_id":{"type":"integer","description":"The push credential id"},"push_provider_id":{"type":"integer","description":"The push provider id"},"push_provider_name":{"type":"string","description":"The push provider name. The possible values are APPLE, APPLE_VOIP, GOOGLE, HUAWEI"},"expiration_date":{"type":"string","description":"The expiration date of the push certificate"},"credential_bundle":{"type":"string","description":"The bundle of Android/iOS application"},"content":{"$ref":"#/components/schemas/PushCredentialInfoContent","description":"The credentials content"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInfoType"},"description":"Bound applications"}},"description":"The push credentials list item info.","title":"PushCredentialInfo"},"push-credentials_GetPushCredential_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PushCredentialInfo"}}},"title":"push-credentials_GetPushCredential_Response_200"},"push-credentials_BindPushCredential_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"push-credentials_BindPushCredential_Response_200"},"dialogflow-credentials_AddDialogflowKey_Response_200":{"type":"object","properties":{"result":{"type":"integer"},"dialogflow_key_id":{"type":"integer"}},"title":"dialogflow-credentials_AddDialogflowKey_Response_200"},"dialogflow-credentials_SetDialogflowKey_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"dialogflow-credentials_SetDialogflowKey_Response_200"},"dialogflow-credentials_DelDialogflowKey_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"dialogflow-credentials_DelDialogflowKey_Response_200"},"DialogflowKey":{"type":"object","properties":{"project_id":{"type":"string","description":"The project ID from Json Web Key"}},"description":"The [Dialogflow](/api-reference/management-api/reference/dialogflow-credentials) key's content.","title":"DialogflowKey"},"DialogflowKeyInfo":{"type":"object","properties":{"dialogflow_key_id":{"type":"integer","description":"The Dialogflow key's id"},"content":{"$ref":"#/components/schemas/DialogflowKey","description":"The key's content"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationInfoType"},"description":"Bound applications"}},"description":"The Dialogflow keys list info.","title":"DialogflowKeyInfo"},"dialogflow-credentials_GetDialogflowKeys_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/DialogflowKeyInfo"}}},"title":"dialogflow-credentials_GetDialogflowKeys_Response_200"},"dialogflow-credentials_BindDialogflowKeys_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"dialogflow-credentials_BindDialogflowKeys_Response_200"},"A2PSmsHistoryTypeSourceNumber":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"SMS source number","title":"A2PSmsHistoryTypeSourceNumber"},"A2PSmsHistoryTypeDestinationNumber":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"SMS destination number","title":"A2PSmsHistoryTypeDestinationNumber"},"A2PSmsHistoryType":{"type":"object","properties":{"message_id":{"type":"integer","description":"Message ID"},"source_number":{"$ref":"#/components/schemas/A2PSmsHistoryTypeSourceNumber","description":"SMS source number"},"destination_number":{"$ref":"#/components/schemas/A2PSmsHistoryTypeDestinationNumber","description":"SMS destination number"},"fragments":{"type":"integer","description":"Number of fragments the initial message is divided into"},"cost":{"type":"number","format":"double","description":"The message cost"},"status_id":{"type":"string","description":"The message status. The possible values are: 1 — Success, 2 — Error, 3 — Waiting"},"error_message":{"type":"string","description":"Error message (if any)"},"processing_date":{"type":"string","description":"Date string as returned by the Management API.\n\nDate of message processing. The format is yyyy-MM-dd HH:mm:ss"},"transaction_id":{"type":"integer","description":"The transaction ID for this message"},"delivery_status":{"type":"string","description":"Delivery status: QUEUED, DISPATCHED, ABORTED, REJECTED, DELIVERED, FAILED, EXPIRED, UNKNOWN"},"text":{"type":"string","description":"Stored message text"}},"description":"The [A2PGetSmsHistory] function result.","title":"A2PSmsHistoryType"},"sms_a2p-get-sms-history_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/A2PSmsHistoryType"}},"total_count":{"type":"integer","description":"Total number of messages matching the query parameters"}},"title":"sms_a2p-get-sms-history_Response_200"},"SmsTransaction":{"type":"object","properties":{"message_id":{"type":"integer","description":"Message ID"},"destination_number":{"type":"string","description":"The SMS destination number"}},"description":"The part of the [A2PSendSms] function result.","title":"SmsTransaction"},"FailedSms":{"type":"object","properties":{"destination_number":{"type":"string","description":"The SMS destination number"},"error_description":{"type":"string","description":"The error description"},"error_code":{"type":"integer","description":"The error code"}},"description":"The part of the [A2PSendSms] function result.","title":"FailedSms"},"sms_a2p-send-sms_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SmsTransaction"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/FailedSms"}},"fragments_count":{"type":"integer","description":"The number of fragments the message is divided into"}},"title":"sms_a2p-send-sms_Response_200"},"sms_ControlSms_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"sms_ControlSms_Response_200"},"SmsHistoryTypeSourceNumber":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Number being called from","title":"SmsHistoryTypeSourceNumber"},"SmsHistoryTypeDestinationNumber":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Number being called to","title":"SmsHistoryTypeDestinationNumber"},"SmsHistoryType":{"type":"object","properties":{"message_id":{"type":"integer","description":"Message ID"},"source_number":{"$ref":"#/components/schemas/SmsHistoryTypeSourceNumber","description":"Number being called from"},"destination_number":{"$ref":"#/components/schemas/SmsHistoryTypeDestinationNumber","description":"Number being called to"},"direction":{"type":"string","description":"Incoming or outgoing message"},"fragments":{"type":"integer","description":"Number of fragments the initial message is divided into"},"cost":{"type":"number","format":"double","description":"Cost of the message"},"status_id":{"type":"string","description":"Status of the message. The possible values are: 1 — Success, 2 — Error, 3 — Waiting"},"error_message":{"type":"string","description":"Error message (if any)"},"processed_date":{"type":"string","description":"Date string as returned by the Management API.\n\nDate of message processing. The format is yyyy-MM-dd HH:mm:ss"},"transaction_id":{"type":"integer","description":"Id of the transaction for this message"},"text":{"type":"string","description":"Stored message text"}},"description":"The [GetSmsHistory] function result.","title":"SmsHistoryType"},"sms_GetSmsHistory_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SmsHistoryType"}},"total_count":{"type":"integer","description":"Total number of messages matching the query parameters"}},"title":"sms_GetSmsHistory_Response_200"},"sms_SendSmsMessage_Response_200":{"type":"object","properties":{"result":{"type":"integer"},"message_id":{"type":"integer","description":"Message ID"},"fragments_count":{"type":"integer","description":"The number of fragments the message is divided into"}},"title":"sms_SendSmsMessage_Response_200"},"RecordStorageInfoType":{"type":"object","properties":{"record_storage_id":{"type":"integer","description":"The record storage ID"},"record_storage_name":{"type":"string","description":"The record storage name"}},"description":"The [GetRecordStorages] function result.","title":"RecordStorageInfoType"},"record-storages_GetRecordStorages_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RecordStorageInfoType"}}},"title":"record-storages_GetRecordStorages_Response_200"},"KeyInfo":{"type":"object","properties":{"account_email":{"type":"string","description":"Client email"},"account_id":{"type":"integer","description":"The account ID"},"key_id":{"type":"string","description":"The key ID"},"private_key":{"type":"string","description":"The private key"}},"description":"The [CreateKey] function result.","title":"KeyInfo"},"role-system_CreateKey_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/KeyInfo"}},"title":"role-system_CreateKey_Response_200"},"RoleView":{"type":"object","properties":{"role_name":{"type":"string","description":"The role name"},"role_id":{"type":"integer","description":"The role ID"},"inherited":{"type":"boolean","description":"Whether the role is inherited"},"child_ids":{"type":"array","items":{"type":"integer"},"description":"Child roles IDs array"},"parent_role_id":{"type":"array","items":{"type":"integer"},"description":"Parent roles IDs array"},"gui_only":{"type":"boolean","description":"Whether the role is gui only"},"name":{"type":"string"}},"description":"The role view.","title":"RoleView"},"KeyViewSubuser1":{"type":"object","properties":{"subuser_name":{"type":"string"},"subuser_id":{"type":"integer"}},"title":"KeyViewSubuser1"},"KeyViewSubuser":{"oneOf":[{"type":"array","items":{"description":"Any type"}},{"$ref":"#/components/schemas/KeyViewSubuser1"}],"description":"The key subuser","title":"KeyViewSubuser"},"KeyView":{"type":"object","properties":{"key_id":{"type":"string","description":"The key ID"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"},"description":"The key roles"},"description":{"type":["string","null"],"description":"The key description"},"subuser":{"$ref":"#/components/schemas/KeyViewSubuser","description":"The key subuser"},"key_name":{"type":"string","description":"The key's name"}},"description":"The [GetKeys] function result.","title":"KeyView"},"role-system_GetKeys_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/KeyView"}},"total count":{"type":"integer"},"count":{"type":"integer"}},"title":"role-system_GetKeys_Response_200"},"role-system_UpdateKey_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_UpdateKey_Response_200"},"role-system_DeleteKey_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_DeleteKey_Response_200"},"role-system_SetKeyRoles_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_SetKeyRoles_Response_200"},"role-system_GetKeyRoles_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"}}},"title":"role-system_GetKeyRoles_Response_200"},"role-system_RemoveKeyRoles_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_RemoveKeyRoles_Response_200"},"SubUserID":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"The subuser ID"}},"description":"The [AddSubUser] function result.","title":"SubUserID"},"role-system_AddSubUser_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/SubUserID"}},"title":"role-system_AddSubUser_Response_200"},"SubUserView":{"type":"object","properties":{"subuser_id":{"type":"integer","description":"The subuser ID"},"subuser_name":{"type":"string","description":"The subuser name, can be used as __subuser_login__ to authenticate"},"description":{"type":["string","null"],"description":"The subuser description"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"},"description":"The subuser roles"},"login":{"type":"string"}},"description":"The [GetSubUsers] function result.","title":"SubUserView"},"role-system_GetSubUsers_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SubUserView"}},"total count":{"type":"integer"},"count":{"type":"integer"}},"title":"role-system_GetSubUsers_Response_200"},"role-system_SetSubUserInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_SetSubUserInfo_Response_200"},"role-system_DelSubUser_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_DelSubUser_Response_200"},"role-system_SetSubUserRoles_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_SetSubUserRoles_Response_200"},"role-system_GetSubUserRoles_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"}}},"title":"role-system_GetSubUserRoles_Response_200"},"role-system_RemoveSubUserRoles_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"role-system_RemoveSubUserRoles_Response_200"},"role-system_GetRoles_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleView"}}},"title":"role-system_GetRoles_Response_200"},"RoleGroupView":{"type":"object","properties":{"id":{"type":"integer","description":"The role group ID"},"name":{"type":"string","description":"The role group name"}},"description":"The [GetRoleGroups] function result.","title":"RoleGroupView"},"role-system_GetRoleGroups_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleGroupView"}}},"title":"role-system_GetRoleGroups_Response_200"},"KeyValueItems":{"type":"object","properties":{"key":{"type":"string","description":"Key that matches the specified key or key pattern"},"value":{"type":"string","description":"Value for the specified key"},"expires_at":{"type":"integer","description":"Expiration date based on **ttl** (timestamp without milliseconds)"}},"description":"SetKeyValueItem, GetKeyValueItem, and GetKeyValueItems functions result.","title":"KeyValueItems"},"key-value-storage_SetKeyValueItem_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/KeyValueItems","description":"The key-value item"}},"title":"key-value-storage_SetKeyValueItem_Response_200"},"key-value-storage_DelKeyValueItem_Response_200":{"type":"object","properties":{"result":{"type":"integer"}},"title":"key-value-storage_DelKeyValueItem_Response_200"},"key-value-storage_GetKeyValueItem_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/KeyValueItems","description":"The key-value item"}},"title":"key-value-storage_GetKeyValueItem_Response_200"},"key-value-storage_GetKeyValueItems_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueItems"},"description":"The key-value pairs"}},"title":"key-value-storage_GetKeyValueItems_Response_200"},"KeyValueKeys":{"type":"object","properties":{"key":{"type":"string","description":"Key that matches the pattern"},"expires_at":{"type":"integer","description":"Expiration date based on **ttl** (timestamp without milliseconds)"}},"description":"GetKeyValueKeys function result.","title":"KeyValueKeys"},"key-value-storage_GetKeyValueKeys_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueKeys"},"description":"The key-value keys"}},"title":"key-value-storage_GetKeyValueKeys_Response_200"},"InvoicePeriod":{"type":"object","properties":{"from":{"type":"string","description":"Date string as returned by the Management API.\n\nFrom date in the following format: YYYY-MM-DD"},"to":{"type":"string","description":"Date string as returned by the Management API.\n\nTo date in the following format: YYYY-MM-DD"}},"description":"Invoices period.","title":"InvoicePeriod"},"InvoiceTotalDetails":{"type":"object","properties":{"tax_amount":{"type":"number","format":"double","description":"Total amount of taxes"},"total_amount":{"type":"number","format":"double","description":"Invoice total amount including taxes"},"amount_to_pay":{"type":"number","format":"double","description":"Discounted amount to pay"},"discount_amount":{"type":"number","format":"double","description":"Discount"},"currency":{"type":"string","description":"Invoice currency"}},"description":"Invoice total amount details.","title":"InvoiceTotalDetails"},"AccountInvoiceRowsItemsAmount":{"type":"object","properties":{"tax_amount":{"type":"number","format":"double"},"total_amount":{"type":"integer"},"amount_to_pay":{"type":"integer"},"discount_amount":{"type":"integer"},"currency":{"type":"string"}},"title":"AccountInvoiceRowsItemsAmount"},"AccountInvoiceRowsItemsTaxesItems":{"type":"object","properties":{"taxable_measure":{"type":"number","format":"double"},"amount":{"type":"number","format":"double"},"level":{"type":"string"},"rate":{"type":"number","format":"double"},"name":{"type":"string"},"currency":{"type":"string"},"category":{"type":"string"}},"title":"AccountInvoiceRowsItemsTaxesItems"},"AccountInvoiceRowsItems":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/AccountInvoiceRowsItemsAmount"},"service_name":{"type":"string"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/AccountInvoiceRowsItemsTaxesItems"}}},"title":"AccountInvoiceRowsItems"},"AccountInvoice":{"type":"object","properties":{"period":{"$ref":"#/components/schemas/InvoicePeriod","description":"Invoice period"},"amount":{"$ref":"#/components/schemas/InvoiceTotalDetails","description":"Info on all money spent in the invoice"},"invoice_id":{"type":"integer","description":"Invoice id"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/AccountInvoiceRowsItems"},"description":"Detailed info on each spending"},"invoice_number":{"type":"string","description":"Unique invoice number"},"invoice_date":{"type":"string","description":"Date string as returned by the Management API.\n\nDate when the invoice is created in the following format: YYYY-MM-DD"},"status":{"type":"string","description":"Invoice status"}},"description":"GetAccountInvoices function result.","title":"AccountInvoice"},"invoices_GetAccountInvoices_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountInvoice"},"description":"Array of the account invoices"},"total_count":{"type":"integer","description":"Total number of invoices matching the query parameters"},"count":{"type":"integer","description":"Number of returned invoices matching the query parameters"}},"title":"invoices_GetAccountInvoices_Response_200"},"invoices_DownloadInvoice_Response_200":{"type":"object","properties":{"file_content":{"type":"string","format":"binary","description":"The method returns a raw data, there is no 'file_content' parameter in fact"}},"title":"invoices_DownloadInvoice_Response_200"},"AddSecretResult":{"type":"object","properties":{"secret_id":{"type":"integer","description":"Added secret ID"}},"description":"The [AddSecret] function result","title":"AddSecretResult"},"secrets_AddSecret_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/AddSecretResult","description":"Result with the added secret ID"}},"title":"secrets_AddSecret_Response_200"},"secrets_DelSecret_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the secret has been deleted successfully"}},"title":"secrets_DelSecret_Response_200"},"GetSecretValueResultSecretId":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Secret ID","title":"GetSecretValueResultSecretId"},"GetSecretValueResult":{"type":"object","properties":{"secret_id":{"$ref":"#/components/schemas/GetSecretValueResultSecretId","description":"Secret ID"},"secret_name":{"type":"string","description":"Secret name"},"secret_value":{"type":"string","description":"Secret value"},"description":{"type":"string","description":"Secret description"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nSecret creation timestamp"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nSecret modification timestamp"}},"description":"The [GetSecretValue] function result","title":"GetSecretValueResult"},"secrets_GetSecretValue_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/GetSecretValueResult","description":"The full secret info (with value)"}},"title":"secrets_GetSecretValue_Response_200"},"SecretListItem":{"type":"object","properties":{"secret_id":{"type":"integer","description":"Secret ID"},"secret_name":{"type":"string","description":"Secret name"},"description":{"type":"string","description":"Secret description"},"created":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nSecret creation timestamp"},"modified":{"type":"string","description":"Timestamp in YYYY-MM-DD HH:mm:ss format.\n\nSecret modification timestamp"}},"description":"The [GetSecrets] function result list item","title":"SecretListItem"},"secrets_GetSecrets_Response_200":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/SecretListItem"},"description":"Secrets list"},"count":{"type":"integer","description":"Returned secrets number"},"total_count":{"type":"integer","description":"Total found secrets number"}},"title":"secrets_GetSecrets_Response_200"},"secrets_SetSecretInfo_Response_200":{"type":"object","properties":{"result":{"type":"integer","description":"Returns 1 if the secret has been updated successfully"}},"title":"secrets_SetSecretInfo_Response_200"}},"securitySchemes":{"JwtAuth":{"type":"http","scheme":"bearer","description":"Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value:\n\n```\nAuthorization: Bearer $VOXIMPLANT_TOKEN\n```\n\nSee [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token."}}}}