createAccount()

This application is used to create new account. Newly created account belongs to customer that authenticated a request.

Implementation details:

Any parameter can use Accounts Generator's patterns to generate its value. Exception is only ${C:xxx} pattern. Instead of number of column is used name of referenced parameter.

The application support trusted mode and i_customer parameter should be supplied in this case.

Parameters are listed as follows:

• username - username to login to self-care interface. String. Required
• web_password - password to login to self-care interface. String.
• authname - VoIP login. String.
• voip_password - VoIP password. String.
• i_routing_group - Routing group. Integer. Required
• i_billing_plan - Tariff plan. Integer. Required
• max_sessions - Max Sessions. Integer.
• max_credit_time - Max Session Time. Integer.
• translation_rule - CLD Translation Rule. String.
• cli_translation_rule - CLI Translation Rule. String.
• credit_limit - Credit Limit. Double.
• i_account_class - Class. Integer. Optional.
• i_time_zone - Time Zone. Refer to Timezones List. Integer.
• balance - Balance. Double.
• cpe_number - CPE#. String.
• vm_enabled - VM Enabled. Integer.
• vm_password - PIN Code. String. Should only contain digits 0-9
• vm_timeout - Timeout to redirect to VM. Integer. Optional
• vm_check_number - Access # to VM. String. Optional
• blocked - Blocked. Integer.
• i_lang - Two character language code ('en' for English, 'ru' for Russian. Refer to Languages List). String.
• payment_currency - Payment Currency. String.
• payment_method - Payments Preferred Method. Integer.
• i_export_type - Download Format. Refer to Download Formats List. Integer.
• lifetime - Lifetime. Integer.
• i_commission_agent - i_customer of commission agent. Integer. Optional
• commission_size - commission size in percents. Double. Optional
• preferred_codec - Preferred Codec. Integer. Possible values:

Null - Disabled

0 - G.711u

3 - GSM

4 - G.723

8 - G.711a

9 - G.722

15 - G.728

18 - G.729

• use_preferred_codec_only - Use Preferred Codec Only. Boolean.
• reg_allowed - Allow Registration. Integer.
• welcome_call_ivr - Welcome Call. Integer.
• on_payment_action - On Payment. Integer. Possible values:

Null - No Action

0 - Extend Lifetime

1 - Clear First Use

2 - Restart Billing

• min_payment_amount - Payments Minimum Amount. Double.
• trust_cli - Trust CLI. Boolean.
• disallow_loops - Disallow Loops. Boolean.
• vm_notify_emails - E-Mail Notification. String.
• vm_forward_emails - E-Mail Forwarding. String.
• vm_del_after_fwd - Delete after forwarding. Boolean.
• company_name - Company Name. String.
• salutation - Mr./Ms... String.
• first_name - First Name. String.
• last_name - Last Name. String.
• mid_init - M.I. String.
• street_addr - Address. String.
• state - Province/State. String.
• postal_code - Postal Code. String.
• city - City. String.
• country - Country/Region. String.
• contact - Contact. String.
• phone - Phone. String.
• fax - Fax. String.
• alt_phone - Alternative Phone. String.
• alt_contact - Alternative Contact. String.
• email - E-Mail. String.
• cc - CC. String.
• bcc - BCC. String.
• i_password_policy - Password Policy. Integer.
• vpn_enabled - VPN Enabled. Boolean. Optional.
• vpn_password - VPN Password. String. Optional.
• i_media_relay_type - Use Media Relay. Refer to Media Relay Types List. Integer.
• lan_access - LAN Access. Boolean. Optional.
• batch_tag - Batch Tag. String. Optional.
• i_provisioning - Auto-Provisioning type . Integer. Optional. Possible values are:

Null - Disabled

1 - Linksys

• invoicing_enabled - Is invoicing enabled. Boolean. Optional.
• i_invoice_template - Invoice template. Integer. Optional.
• i_caller_name_type - Caller name type . Integer. Optional. Possible values are:

1 - Pass-Through (do not touch caller name). Default.

2 - Use account's First-Name M.I. Last-Name

3 - Use custom value (parameter caller_name)

• caller_name - Custom caller name. String. Optional.
• followme_enabled - Enable followme. Boolean. Optional.
• vm_dialin_access - Enable external access to voicemail. Boolean. Optional.
• hide_own_cli - Enable anonymous outgoing calls. Boolean. Optional.
• block_incoming_anonymous - Block incoming anonymous calls. Boolean. Optional.
• i_incoming_anonymous_action - Action for incoming anonymous calls . Integer. Possible values are:

1 - Reject (Default)

2 - Play prompt and reject

3 - Send to voicemail

• dnd_enabled - Enable/Disable DND mode for account. Boolean. Optional.
• description - Description. String. Optional.
• pass_p_asserted_id - Pass P-Asserted-Id header received from this account. Boolean. Optional.
• p_assrt_id_translation_rule - Translation rule for incoming P-Asserted-Id header. String. Optional.
• dncl_lookup - Do lookup on DNC list for the account. Boolean. Optional.
• generate_ringbacktone - Generate ringbacktone on receiving 180/181 message after 183 one has been received. Boolean. Optional.
• max_calls_per_second - Max allowed CPS. Double. Optional.

Returns:

• result - OK means that account has been created. String.
• i_account - i_account of created account. Integer.
• username - username to login to self-care interface of created account. String.
• web_password - password to login to self-care interface of created account. String.
• authname - VoIP login of created account. String.
• voip_password - VoIP password of created account. String.
• vm_password - Voice Mail PIN Code of created account. String.
• vpn_password - VPN Password of created account. String.

XMLRPC fault in case of any error.

REST API example:

	https://demo.flysip.com/api.php?username=admin&apipassword=<api_password>&action=createAccount&JSONString={"username":"apitest","i_billing_plan":1,"i_routing_group":1}