Add Account
This document describes the add_account API endpoint for creating a new account record using the supplied data.
Endpoint
POST /Account/add_account
Request
Request Body
Content-Type: application/json
Example
{
"params": {
"account_info": {
"billing_model": 1,
"expiration_date": "2020-01-01",
"h323_password": "asdfg123",
"i_customer": 10,
"i_product": 5,
"id": "66666666555",
"login": "qwerty",
"password": "Qasdfg123"
}
}
}
Parameters
The following table describes the fields within the account_info object in the request body.
| Field Name | Type | Description | UI Equivalent |
|---|---|---|---|
| activation_date | date | The date on which the account is activated. The date the account is used for the first time. | "Activation date" input field on the Edit Account -> Personal info -> Life cycle panel. |
| address_line_2 | string | The 2nd line of the account owner's address. | "Address, line 2" input field on the Edit Account -> Personal info -> General info -> Address info panel. |
| alias_did_number_list | array[object] | The list of the account's aliases' DID numbers. Note: included in the response if limit_alias_did_number_list parameter is greater than zero. |
|
| alias_did_number_list[].did_number | string | The DID number. Used to specify a phone number. Note: read-only. Possible values: only numbers. | |
| alias_did_number_list[].i_did_number | integer | The unique ID of the DID number record. Note: read-only. | |
| assigned_addons | array[object] | The list of account's add-on products. Add-on products sell additional features/services, enabling access to certain service features (e.g., call waiting) with an associated recurring cost (subscription). Note: if the main product is changed via update_account and this list is not provided, existing add-on products will be removed. |
"Select add-on products to add" panel on Edit Account -> Finances -> Add-on products. |
| assigned_addons[].addon_effective_from | date-time | Indicates the date when a product add-on is effective. | "Activation date" input field on Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel. |
| assigned_addons[].addon_effective_to | date-time | Indicates the date when a product add-on will be ineffective. | "Expiration date" input field on Edit Account -> Finances -> Add-on products -> %YOUR ADD-ON PRODUCT% -> Additional information panel. |
| assigned_addons[].addon_priority | integer | Indicates the priority of an add-on product. Possible values: 0 - main product; 10 - low; 15 - medium low; 20 - medium; 25 - medium high; 30 - high. Note: set only on add-on creation, cannot be changed later. Higher priorities override lower priority settings. | "Priority" input field on the Edit Product main panel. |
| allowed_products | array[integer] | The list of main products compatible with the add-on product. | List of items on Edit Product -> Additional information -> "Add-on product is allowed with". |
| allowed_with_any_product | string | Defines if the add-on product can be assigned with any other main product. Available only for add-on products managed by the administrator and available to resellers. | |
| breakage | number | The breakage. Used to obtain a summary of depleted (practically unusable) accounts. | "Breakage, %YOUR_CURRENCY%" input field on Edit Product -> Charges -> General info main panel. |
| default_i_acl | integer | Indicates the ACL for accounts with this product assigned. Controls which objects end users can access and actions they can perform. | "Account default ACL" input field on Edit Product -> Additional information panel. |
| description | string | The product description. Used to specify the internal product description. | "Description" input field on Edit Product -> Additional info panel. |
| end_user_description | string | The description visible to end users on their self-care interfaces. | "Description visible to end users" input field on Edit Product -> Additional info panel. |
| end_user_name | string | The product name visible to end users on their self-care interfaces. | "Name visible to end users" input field on Edit Product main panel. |
| fraud_protection | string | The overdraft protection mode for the product. Possible values: None, All, Debit. | |
| hidden | string | Indicates whether the product is hidden. Possible values: Y - is hidden; N - is not hidden. Note: read-only. | |
| i_account_role | integer | The ID of the account role. Defines the account's purpose (e.g., phone line, top-up voucher) and validates account ID. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - MSISDN; 9 - Voucher. | "Account role" input field on Edit Account main panel. |
| i_customer | integer | The record ID of the reseller who manages the product. | "Managed by" input field on Edit Product main panel. |
| i_product | integer | The unique ID of the product record. | |
| i_product_group | integer | The ID of the product group. A custom grouping of add-on products. | "Product group" input field on Edit Product -> Additional info panel. |
| i_reseller_subscription | integer | The ID of the Subscription Plan assigned to the reseller. | |
| i Subscription | integer | The ID of the subscription plan. Used to charge recurring fees. Note: applied to each account with this product. | "Subscription" input field on Edit Product -> Charges -> General info -> Subscription -> Subscriptions panel. |
| i_vd_plan | integer | The ID of the assigned volume discount plan. Adjusts prices based on service volume, allocates free services, or transfers balance to a sub-wallet. Note: applied to every account with this product. | "Default discount plan" input field on Edit Product -> Charges -> General info panel. |
| included_services | array[integer] | The list of services provided with the product. Defines service types included. Note: IPTV service requires prior configuration on the Configuration server web interface. | List of items on Edit Product -> Services panel. |
| info_url | string | The URL to an external website describing product features. | "Information URL" input field on Edit Product -> Additional info panel. |
| is_used | integer | Indicates whether the product is used. Possible values: 1 - is used; 0 - is not used. Note: read-only. | |
| is_used_by_resellers | integer | Indicates whether the shared product is used by resellers. Possible values: 1 - is used; 0 - is not used. Note: read-only. | |
| iso_4217 | string | The ISO 4217 currency code for billing. Note: cannot be changed after product creation. Example values: EUR, USD, INR. | |
| managed_by_user | string | Indicates whether the product can be managed by an end user. Possible values: Y - yes; N - no. | "Allow self-care sign-up" switch on Edit Product -> Additional information panel. |
| name | string | The product name. Descriptive name used on the UI. | "Name" input field on Edit Product main panel. |
| notepad | string | Notes about the product. | Input field on Edit Product -> Additional info Notes panel. |
| product_group_name | string | The name of the product group. Note: read-only; cannot be used to set a product group. | "Product group" input field on Edit Product -> Additional info panel. |
| product_subscription | object | The product subscription info. | Edit Product -> Charges -> General info -> Subscriptions panel. |
| product_subscription.activation_fee | number | The one-time fee applied when the subscription is activated. Note: read-only. | "Activation fee, %YOUR_CURRENCY%" input field on Edit Subscription plan -> Fees panel. |
| product_subscription.activation_mode | integer | Specifies the date subscription charges apply. Possible values: 1 - at the given start date; 2 - upon account's first usage. Note: read-only. | "Activation mode" input field on Create Subscription plan main panel. |
| product_subscription.advance_periods | integer | Number of periods to charge in advance. Note: read-only; cannot be changed after subscription plan creation. | "Periods in advance" input field on Edit Subscription plan main panel. |
| product_subscription.cancel_penalty | number | Fee for early cancellation. Note: applicable to subscriptions with cancelation mode "Fixed". | "Fee, %YOUR_CURRENCY%" input field on Edit Subscription plan -> Fees panel. |
| product_subscription.charge_model | integer | Indicates how subscription charges are applied. Possible values: 0 - progressively; 1 - at the end of the billing period; 2 - in advance. Note: read-only. | "Subscription charges applied" input field on Edit Subscription plan main panel. |
| product_subscription.description | string | Subscription plan description. Possible length: 255 characters. | "Description" input field on Edit Subscription plan -> General information panel. |
| product_subscription.effective_fee | number | Effective subscription fee value for the current billing period. | |
| product_subscription.generate_daily_charge | string | Indicates whether to keep total charge or generate daily charges. Possible values: Y - generate daily charges; N - keep total charge only. | |
| product_subscription.i_product | integer | The unique ID of the product record. | |
| product_subscription.i_product_subscription | integer | The unique ID of the product subscription record. | |
| product_subscription.i_subscription | integer | The ID of the subscription plan. | |
| product_subscription.invoice_description | string | Subscription plan name visible to end users on invoices and self-care interfaces. | "Subscription plan name visible to end users" input field on Edit Subscription plan main panel. |
| product_subscription.iso_4217 | string | ISO 4217 code for the subscription plan currency. Note: cannot be changed after creation. Example values: EUR, USD, INR. | "Currency" input field on Edit Subscription plan main panel. |
| product_subscription.minimum_period | integer | Minimum subscription period in months to avoid penalties. Possible length: 1 to min number of months. | "Minimum subscription period, months" input field on Edit Subscription plan -> Fees panel. |
| product_subscription.multi_month_discount_list | array[object] | List of multi-month discounts for subscriptions charged in advance. | |
| product_subscription.multi_month_discount_list[].discount_fee | number | Fee with applied discount for the number of months. | |
| product_subscription.multi_month_discount_list[].i_subscription | integer | The unique ID of the Subscription Plan record. | |
| product_subscription.multi_month_discount_list[].i_subscription_discount | integer | The unique ID of the Subscription Discount record. | |
| product_subscription.multi_month_discount_list[].number_of_months | integer | Number of months covered by the discount. | |
| product_subscription.multi_month_discount_list[].percent | number | Amount of discount for percentage discount type. | |
| product_subscription.multi_month_discount_list[].rate | number | Amount of discount for fixed amount discount type. | |
| product_subscription.multi_month_discount_list[].standard_fee | number | Standard fee for the number of months. | |
| product_subscription.multiple | integer | Indicates whether the same subscription can be assigned multiple times to one account. Possible values: Y - yes; N - no. Note: read-only. | "Can be applied more than once" input field on Edit Subscription plan -> General information panel. |
| product_subscription.name | string | Name of the subscription plan. | "Name" input field on Edit Subscription plan main panel. |
| product_subscription.periodic_fees | array[array[object]] | List of periodic fees for the subscription plan. | Input fields on Edit Subscription plan -> Fees -> "Monthly fee, %YOUR_CURRENCY%" -> "Adjust periodic fees for non-monthly periods" modal window. |
| product_subscription.periodic_fees[].fee | number | Amount of the fee for one billing period. Note: read-only, inherited from subscription. | "Periodic fee by usage period" on Product Info page -> Charges -> General Info -> Subscription panel. |
| product_subscription.periodic_fees[].i_billing_period | integer | Billing period ID the fee applies to. Note: read-only, inherited from subscription. | "Periodic fee by usage period" (label) on Product Info page -> Charges -> General Info -> Subscription panel. |
| product_subscription.periodic_fees[].i_subscription | integer | Subscription identifier. Note: changing this updates all accounts with this product. | "Subscription" on Product Info page -> Charges -> General Info -> Subscription panel. |
| product_subscription.periodic_fees[].i_subscription_fee | integer | Internal identifier of the billing period subscription fee. Note: read-only, inherited from subscription. | |
| product_subscription.periodic_fees[].periods | integer | Number of billing periods the fee applies to. Note: read-only, inherited from subscription; 0 means default fee, other values specify exact periods. | |
| product_subscription.rounding | integer | Number of decimal places for rounding charged amounts in xDRs. Possible values: 1 - min, 5 - max. | "Round up the charged amount, decimal places" input field on Edit Subscription plan -> Fees panel. |
| realm | string | Custom string imposing a scope of uniqueness for account IDs. Note: cannot be changed for saved products. | "Realm" input field on Edit Product main panel. |
| service_features | array[object] | Service feature configuration options within the product. | "Service configuration" panel in Account -> Service section. |
| service_features[].attributes | array[object] | List of service feature attributes. Note: both cli_trust attributes (accept_caller and supply_caller) are mandatory. |
|
| service_features[].attributes[].effective_values | array[string] | List of service feature attribute values. Note: read-only, inherited from customer, customer site, or product; not applicable to products. | |
| service_features[].attributes[].name | string | Service feature attribute internal name. Note: read-only. | |
| service_features[].attributes[].values | array[string] | Values of the service attribute. Note: if single value, only first item checked/populated; for accounts, applicable only if overridden at account level. | |
| service_features[].defined | integer | Indicates if the service feature is defined on the object's service features level. Note: absence in response means always defined at this level. | |
| service_features[].effective_flag_value | string | Actual service feature flag value. Note: read-only, inherited from customer, customer site, or product. | |
| service_features[].flag_value | string | State of the corresponding service feature. Note: not mandatory for cli_trust and permitted_sip_proxies. |
|
| service_features[].locked | integer | Indicates if the feature is locked for editing for the current user. Note: absence in response means feature can't be locked. | |
| service_features[].locks | array[string] | List of user types who cannot change service features. Note: absence means locks not supported at this level. | |
| service_features[].name | string | Service feature name. | |
| service_flag_locks | string | Specifies whether service feature values can be changed by admin or end user. Note: not all features editable by end users. | "Can be edited by" checkbox on Product -> Services -> Choose Service -> Choose any service feature. |
| shared | string | Indicates whether the product can be shared with resellers. Note: can be disabled only if not used by resellers; applicable to admin-managed products. | "Share with resellers" input field on Edit Product main panel. |
| subscription_discount_list | array[object] | Encourages multi-month payments with discounts. | Item list on Edit Subscription plan -> Multi-months prepaid plans panel. |
| subscription_discount_list[].discount_fee | number | Fixed sum for the prepaid plan. Note: for subscriptions charged in advance. | "Discount fee, %YOUR_CURRENCY%" input field on Subscription plan -> Multi-months prepaid plans. |
| subscription_discount_list[].i_subscription | integer | Unique ID of the subscription plan record. | |
| atino | |||
| subscription_discount_list[].i_subscription_discount | integer | Unique ID of the subscription discount record. | |
| subscription_discount_list[].number_of_months | integer | Number of billing periods for the prepaid plan. Note: for subscriptions charged in advance. | "Months" input field on Subscription plan -> Multi-months prepaid plans. |
| subscription_discount_list[].percent | number | Percentage of the discount. Note: for percentage discount type. | |
| subscription_discount_list[].rate | number | Amount of the discount. Note: for fixed amount discount type. | |
| subscription_discount_list[].standard_fee | number | Standard fee for periods without discount. Note: read-only, for subscriptions charged in advance. | "Standard fee" input field on Subscription plan -> Multi-months prepaid plans. |
| topup_addon | string | Indicates if add-on product has a volume discount plan with discounts. Possible values: Y - with discounts; N - without discounts. | |
| volume_discount_plan_name | string | Name of the associated volume discount plan. Note: read-only, applied to every account with this product. | "Name" input field on Edit Discount plan main panel. |
| aux_fields | array[object] | Data for the account's additional fields. | |
| aux_fields[].name | string | Name of the additional data field. | |
| aux_fields[].value | string | Value of the additional data field. | |
| baddr1 | string | 1st line of the account owner's address. | "Address, line 1" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| batch_name | string | Batch name to which the account belongs. Used to group accounts. Note: cannot mix different customers' accounts in same batch. | "Batch" input field on Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| bcc | string | BCC email address for blind carbon copy. | "BCC" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| bill_status | string | Account status. Note: cannot be set via add/update methods; use terminate_account. Possible values: O - open; I - inactive; C - terminated. |
|
| billing_model | integer | Account type (debit, credit, beneficiary, voucher). Mandatory. Note: cannot be changed after creation. Possible values: -1 - debit; 0 - recharge voucher; 1 - credit; 2 - alias; 4 - beneficiary. | "Type" input field on Create Account main panel. |
| blocked | string | Indicates if calls and self-care access are blocked, and SIP Authorization status. Possible values: Y - blocked, auth disabled; N - not blocked, auth enabled. | "Change status to" input field on Toolbar -> Change status button. |
| call_processing_mode_info | object | Information about account's active call processing mode. | |
| call_processing_mode_info.effective_from | date-time | Date and time the mode became active. Note: read-only. | |
| call_processing_mode_info.effective_to | date-time | Date and time the mode becomes inactive. | "Effective until" field on Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.i_response_message | integer | ID of the voice response message. | "Temporary response message" input field on Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.name | string | Operation mode name. Note: read-only. | |
| call_processing_mode_info.response_message_name | string | Response message name. Note: read-only. | |
| call_processing_mode_info.short_code | integer | ID of the operation mode; used as DTMF code to activate. | "Effective mode" field on Edit Account -> Services -> Call screening -> Modes tab. |
| call_processing_mode_info.sticky | string | Indicates if mode preserved on bulk mode switch. Possible values: Y - preserved; N - changed. Note: read-only. | "Sticky" field on Edit Account -> Services -> Call screening -> Modes tab. |
| city | string | City of the account owner's address. | "City" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| companyname | string | Account owner's company name. | "Company name" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| cont1 | string | Main contact person for the account. | "Contact" input field on Edit Account -> Personal info -> General info panel. |
| cont2 | string | Alternative contact person for the account. | "Alt. contact" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| control_number | integer | Sequential number of the account in the batch. Assigned automatically. Note: cannot be changed after creation. | "Control number" input field on Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| country | string | Country code in ISO 3166-1 alpha-2 format. Possible values: 0 - min; 32 - max. | "Country" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| credit_limit | number | Account's credit limit value in account's currency. Note: only for Credit accounts. | "Credit limit, %YOUR_CURRENCY%" on Edit Account -> Finances -> General info panel. |
| ecommerce_enabled | string | Indicates if e-commerce is enabled for balance recharge. Possible values: Y - enabled; N - disabled. | "Change status to" input field on Account Edit -> Personal info -> General info -> Payment method panel. |
| string | Email address associated with the account for password reset. | "Email" input field on Edit Account -> Personal info -> General info panel. | |
| expiration_date | date | Date from which the account becomes unusable. | "Expiration date" input field on Edit Account -> Personal info -> Life cycle panel. |
| faxnum | string | Account owner's fax number. | "Fax" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| firstname | string | Account owner's first name. | "First name" input field on Edit Account -> Personal info -> General info panel. |
| h323_password | string | VoIP password for authenticating calls. | "Service password" input field on Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| i_account | integer | Unique ID of the account. Note: cannot be changed after creation. | |
| i_account_balance_control_type | integer | ID of account's balance control type. Possible values: 1 - undefined; 2 - individual credit limit; 3 - subordinate. | "Balance control" input field on Edit Account main panel. |
| i_account_role | integer | ID of the account role. Validates account ID. Possible values: 1 - Universal; 2 - Phone line; 3 - Auto attendant; 4 - Prepaid card; 5 - PINless; 6 - IPv4 address; 7 - User@domain; 8 - Mobile; 9 - Voucher. | "Account role" input field on Edit Account main panel. |
| i_acl | integer | ID for account's access level. Note: deprecated, use i_role. | |
| i_batch | integer | ID of the batch to which the account belongs. | |
| i_customer | integer | ID of the customer record to which the account belongs. Note: cannot be changed after creation. | "Customer" input field on Edit Account main panel. |
| i_customer_site | integer | ID of the customer site the account belongs to. | "Customer site" input field on Edit Account -> Personal info -> General info -> Additional info -> Account info panel. |
| i_distributor | integer | Unique ID of the distributor associated with the account. Note: applicable to debit accounts only. | |
| i_lang | string | Code for account's web language (e.g., en, ru, es). | "Web interface language" on Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_master_account | integer | ID of the beneficiary account for alias or sponsor account. Note: system-updated, applicable to alias/beneficiary accounts. | "Sponsor account" field on Edit Account main panel. |
| i_product | integer | ID for account's product. | "Main product" input field on Edit Account main panel. |
| i_role | integer | ID of account's access role. Contains permissions for components. | "Role" input field on Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_time_zone | integer | ID for account's time zone. | "Time zone" input field on Edit Account -> Personal info -> General info -> Web self-care panel. |
| i_vd_plan | integer | ID for account's discount plan. Note: obsolete, use add-on product functionality. | "Discount plan" on Edit Account -> Services -> Bundles panel. |
| id | string | Unique ID (PIN) of the account. Alphanumeric, max 64 characters. Format depends on account role. | "ID" input field on Edit Account main panel. |
| in_date_format | string | Input date format for self-care interface. | "Date" input field on Edit Account -> Personal info -> General info -> Web self-care panel -> Input format. |
| in_time_format | string | Input time format for self-care interface. | "Time" input field on Edit Account -> Personal info -> General info -> Web self-care panel -> Input format. |
| inactivity_expire_time | integer | Number of days account remains active after last use/recharge. | "Availability period after last usage, days" input field on Edit Account -> Personal info -> Life cycle panel. |
| included_services | array[object] | List of services available for account use. Note: read-only, inherited from product/add-ons, included if get_included_services flag = 1. |
|
| included_services[].default | string | Indicates if service belongs to default set. Possible values: Y - yes; N - no. | |
| included_services[].dest_group_set_name | string | Destination group set name. Note: read-only, for "service pool" services. | "Destination group set" input field on Add service panel. |
| included_services[].i_dest_group_set | integer | ID of destination group set. Note: for "service pool" services. | "Destination group set" input field on Add service panel. |
| included_services[].i_service | integer | Unique ID of the service record. | |
| included_services[].i_service_type | integer | Unique ID of related service type. Possible values: 0 - Internal; 2 - Session based; 3 - Voice calls; 5 - Data service; 6 - Internet access; 7 - Quantity based; 8 - Wi-Fi; 9 - Dial-up internet; 10 - Messaging service; 14 - Conferencing; 15 - DID; 16 - IPTV; 17 - Measured service; 18 - Service pool; 19 - Mobile network provisioning. | |
| included_services[].i_st_charge_unit | integer | ID of service type charge unit. | |
| included_services[].i_tax_transaction_code | integer | ID of tax transaction code for xDR tax calculations. | "Tax code" input field on Add service panel. |
| included_services[].internal | string | Indicates if service is for internal usage. Possible values: Y - yes; N - no. | |
| included_services[].is_used | integer | Indicates if service is used. Possible values: Y - yes; N - no. | |
| included_services[].name | string | Service name shown on administrator interface. | "Name" input field on Edit Service main panel. |
| included_services[].rate_unit | string | Customer-visible name for billing units. Max length: 16 characters. | "Billing unit" input field on Edit Service main panel. |
| included_services[].rating_base | string | Billing attribute based on service type. Note: read-only for saved services. | "Rating base" input field on Edit Service main panel. |
| included_services[].ratio | integer | Base ratio (e.g., 1024 bytes = 1 kilobyte). Affects xDR calculations. | "Base ratio" input field on Edit Service main panel. |
| included_services[].service_pool_combination_list | array[object] | List of service pool combinations. Used only for pool services. | |
| included_services[].service_pool_combination_list[].dg_name | string | Destination group name. Note: read-only. | "Destination group" input field on Add Service main panel. |
| included_services[].service_pool_combination_list[].i_dest_group | integer | ID of destination group. | "Destination group" input field on Add Service main panel. |
| included_services[].service_pool_combination_list[].i_service | integer | ID of the service. | "Service" input field on Add Service main panel. |
| included_services[].service_pool_combination_list[].pooled_ratio | integer | Ratio for pooled units. Note: read-only, inherited from service. | |
| included_services[].service_pool_combination_list[].pooled_unit | string | Pooled unit. Note: read-only, inherited from service. | |
| included_services[].service_pool_combination_list[].pooled_unit_ratio | string | Ratio for pooled units. | |
| included_services[].service_pool_combination_list[].service_name | string | Service name. Note: read-only, inherited from service. | "Service" input field on Add Service main panel. |
| included_services[].service_pool_combination_list[].unit_ratio | integer | Ratio for service pool units. | "Ratio" input field on Add Service main panel. |
| included_services[].unit | string | Base units for measuring service consumption. Note: preset and unchangeable based on rating base. | "Base unit" input field on Edit Service main panel. |
| included_services[].usage_rating | string | Indicates if service is charged per rating plan. Possible values: Y - yes; N - no. | "Usage charge" input field on Edit Service main panel. |
| lastname | string | Account owner's last name. | "Last name" input field on Edit Account -> Personal info -> General info panel. |
| life_time | integer | Number of days account remains active after first use/recharge. | "Availability period after first usage, days" field on Edit Account -> Personal info -> Life cycle panel. |
| login | string | User login for self-care web interface. Possible characters: digits, letters, @, -, _, .. Min length: 4, max: 64. | "Login" input field on Edit Account -> Personal info -> General info -> Web self-care panel. |
| midinit | string | Account owner's middle initial(s). Max length: 25 characters. | "Middle name" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| note | string | Short note about account's contact details. Max length: 100 characters. | "Description" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| notepad | string | Notes about the account owner. E-commerce payment details added automatically. | "Note" input field on Edit Account -> Personal info -> General info -> Notes panel. |
| opening_balance | number | Initial balance of the account. | "Opening balance" input field on Create Account main panel. |
| out_date_format | string | Output date format for self-care interface. | "Date" input field on Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| out_date_time_format | string | Output date and time format for self-care interface. | "Date & time" input field on Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| out_time_format | string | Output time format for self-care interface. | "Time" input field on Edit Account -> Personal info -> General info -> Web self-care panel -> Output format. |
| password | string | User password for self-care web interface. Min length: 6 characters, must include latin letters and digits. | "Password" input field on Edit Account -> Personal info -> General info -> Web self-care panel. |
| phone1 | string | Main phone number to contact end user. | "Phone" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| phone2 | string | Alternative phone number for contact. | "Alt. phone" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| redirect_number | string | Number sent back to IVR in authorization confirmation (e.g., redirect to technical support). | |
| salutation | string | Account owner's salutation. | "Salutation" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| service_features | array[object] | List of service features. | Item list on Edit Account -> Services -> Service configuration -> %YOUR_SERVICE% configuration panel. |
| service_features[].attributes | array[object] | List of service feature attributes. Note: both cli_trust attributes (accept_caller and supply_caller) are mandatory. |
|
| service_features[].attributes[].effective_values | array[string] | List of service feature attribute values. Note: read-only, inherited from customer, customer site, or product; not applicable to products. | |
| service_features[].attributes[].name | string | Service feature attribute internal name. Note: read-only. | |
| service_features[].attributes[].values | array[string] | Values of the service attribute. Note: if single value, only first item checked/populated; for accounts, applicable only if overridden at account level. | |
| service_features[].defined | integer | Indicates if service feature is defined on object's service features level. Note: absence means always defined at this level. | |
| service_features[].effective_flag_value | string | Actual service feature flag value. Note: read-only, inherited from customer, customer site, or product. | |
| service_features[].flag_value | string | State of the corresponding service feature. Note: not mandatory for cli_trust and permitted_sip_proxies. |
|
| service_features[].locked | integer | Indicates if feature is locked for editing for current user. Note: absence means feature can't be locked. | |
| service_features[].locks | array[string] | List of user types who cannot change service features. Note: absence means locks not supported at this level. | |
| service_features[].name | string | Service feature name. | |
| sim_card_info | object | Information about a SIM card. | |
| sim_card_info.amf | string | Authentication Management Field. Format: hexadecimal string of 4 symbols. | "AMF" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.auth_key | string | Authentication Key. Format: hexadecimal string of 32 symbols. | "Authentication key" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.description | string | SIM card description. | "Description" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.hlr | string | Name of Home Location Register database. Format: string. | "HLR" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.i_account | integer | Unique ID of the account record to which the SIM card belongs. | |
| sim_card_info.i_sim_card | integer | ID of the SIM card record. | |
| sim_card_info.iccid | string | Integrated Circuit Card ID. Format: unique 18 to 22 digit code. | "ICCID" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.imsi | string | International Mobile Subscriber Identity. Format: string of 6 to 15 digits. | "IMSI" input field on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.is_used | integer | Indicates if SIM card is in use. Possible values: 1 - in use; 0 - available. | SIM Cards list UI on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.managed_by | integer | ID of the reseller who owns/manages the SIM card. | SIM Cards list UI on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.msisdn | string | Mobile Subscriber Integrated Services Digital Number. Format: string of up to 15 digits. | SIM Cards list UI on Infrastructure -> Inventory -> SIM cards tab. |
| sim_card_info.notepad | string | Comments regarding the SIM card. | |
| sim_card_info.opc_key | string | Operator key stored on the SIM card. Format: hexadecimal string of 32 symbols. | "OPc Key" input field on Infrastructure -> Inventory -> SIM cards tab. |
| state | string | Province or state where account owner lives. | "State" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| subscriber_email | string | Subscriber's email address. | "Email for IPTV" input field on Edit Account -> Personal info -> General info panel. |
| ua_profile_id | integer | ID for UA profile. Indicates IP phone profile assigned to the account. | |
| voucher_info | object | Information about the voucher used to recharge the account. | |
| voucher_info.id | string | Unique ID of the voucher. | |
| zip | string | Postal (zip) code. Possible length: 2 to 10 characters; allows letters, digits, space, dash. | "Postal code" input field on Edit Account -> Personal info -> General info -> Address info panel. |
| generate_web_password | integer | Indicates whether to generate a password for self-care interface. Possible values: 1 - generate; 0 - do not generate. |
RESPONSE 200
Successful response of the API method
{
i_account: 1141766
}
RESPONSE 500
Failed response of the API method
{
faultcode: string The error code
faultstring: string Text description of the error
}