Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

This script allows you to create a new account, update account information or remove an account. The VoipNow 3 accounts are: service providers, organizations, and users.

Usage

/usr/local/voipnow/bin/account.sh [options]
Where <command> is one of:

ArgumentParameterDescription
-h, --help Shows the help message.
-c, --createlogin_nameCreates a new account.
-u, --updatelogin_nameUpdates an account.
-r, --removelogin_nameRemoves an account.

and available [options] are:

ArgumentParameterDescription
--levelstringAccount level (required for creation). Accepted values: ServiceProvider , Organization, User.
--first_namestringContact's first name (required for creation).
--last_namestringContact's last name (required for creation).
--loginlogin_nameControl panel login name (required for creation).
--auto<empty>Automatic password generation.
--passwordpasswordControl panel password (required for creation).
  • On account creation: if --phonepassword option is not supplied, the phone password is set equal to this password.
  • On account update: if previously the phone password was the same with the control panel password and --phonepassword option is not supplied, the phone password is set equal to this password.
--phonepasswordphonepasswordPhone password (for level = User and phone terminal extensions only).
  • On account creation: if not supplied, the phone password is set equal to the control panel password.
  • On account update: if supplied, even if previously the phone password was the same with the control panel password, the phone password is updated.
--parent_loginlogin_nameLogin name of the account that creates this child account (required for creation of organizations and users).
--emailstringE-mail address (required for creation).
--companystringCompany Name.
--telephonenumberPhone number.
--faxnumberFax number.
--addressstringStreet.
--citystringCity.
--statestringUS state.
--pcodestringPostal code.
--countrystringCountry code (required for creation).
--timezonestringTimezone name (required for creation).
--languagestringInterface language as specified by the ISO 639–1 standard (required for creation).
--phone_languagestringPhone language as specified by the ISO 639–1 standard (required for extension creation).
--charging_planstringCharging plan name. The charging plan must already be created in the parent account.
--template_idnumberID of the permissions and limits template. You must provide the ID of a template for the account level you want to create.
--typestringExtension type (for level = User only). Allowed values: 'term', 'queue', 'ivr', 'conference', 'voicecenter', 'callback', 'callcard', 'intercom', 'queuecenter' (this is not required).
--numbernumberExtension number (for level = User only) (required for creation).
--labelstringExtension label (for level = User only) (this is not required and if it is not provided, label will default to extension number).
--extension_template_idnumberID of extension template (for level = User only) (this is not required).
--sendmail<empty value>Send an welcome email to the account owner.
Always sent on account creation. On update, sent only if this flag is set.
--rolestringRole of the user to be created (for level = User only). Allowed values: 'member', 'administrator' , 'owner' (required for creation).
When creating a User level account, it is also possible to create an associated extension using the --type, --number, --label, --extension_template_id parameters. Extension creation is optional.

Examples

Add New Service Provider

/usr/local/voipnow/bin/account.sh --create newserviceprovider --level ServiceProvider --first_name "Service" --last_name "Provider" --password "pass20G5Z" --email "newservice_provider@example.com" --company "Service Provider Company" --telephone "021.21.223.23" --fax "021.21.223.23" --address "This is the service provider address" --city "Some City" --state "Alsace" --pcode "111111" --country "Fr" --timezone "Europe/Paris" --language en --charging_plan "Default charging plan"

Add New Organization

/usr/local/voipnow/bin/account.sh --create neworganization --level Organization --first_name "Organization" --last_name "Name" --password "pass20G5Z" --parent_login newserviceprovider --email "neworganization@example.com" --company "Organization Company" --telephone "021.21.223.23" --fax "021.21.223.23" --address "This is the organization address" --city "Some City" --state "Alsace" --pcode "111111" --country "Fr" --timezone "Europe/Paris" --language en

Add New User

/usr/local/voipnow/bin/account.sh --create newuser --level User --first_name "User Name" --last_name "Test" --password "pass20G5Z" --parent_login neworganization --email "newuser@example.com" --company "User Company" --telephone "021.21.223.23" --fax "021.21.223.23" --address "This is the user address" --city "Some City" --state "Alsace" --pcode "111111" --country "Fr" --timezone "Europe/Paris" --language en --phone_language en --role administrator

Update Account Email

/usr/local/voipnow/bin/account.sh --update newaccount --email "newcl2@example.com"

Remove Account

/usr/local/voipnow/bin/account.sh --remove newaccount

Update Phone Terminal Password

/usr/local/voipnow/bin/account.sh --update newphoneterminal --phonepassword "21tryme68"

Resend Account Details

/usr/local/voipnow/bin/account.sh --update newaccount --company "Updated Organization" --password "pass20G5Z" --sendmail

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.