Skip to content

Accounts

An account is the SIP identity a call is authenticated to: a softphone or IP phone that registers with a login and password, a PBX or trunk identified by IP, or a calling card. Every call belongs to exactly one account, and the account carries the balance, the service plan and the routing group that price and route it. See Call flow.

Open My Customers → Accounts in the left sidebar. The URL is /accounts.php. The item is visible to admin and reseller users who may add accounts or already own one. Add, Save, Add Balance, Block and Delete follow the add, edit and delete rights of your access level.

Screenshot "admin-panel/accounts-list" has not been generated yet — see scripts/screenshots/screens.yml.

The header switches between Active and Deleted accounts.

Column Meaning
Status Icon: red ban Blocked; pause Tariff suspended (the service plan could not be charged); warning triangle Low balance or Expired; blue dot Registration Disabled; green check Online with the user agent and contact of a registration younger than a minute; grey dot when offline
Name The account name, linking to the form
Description Free text from the form
Balance Current balance in your base currency
Available Credit Balance plus credit limit. Calls stop at zero
Tariff The account’s service plan, linking to it
Routing Group The routing group, or — when the account inherits yours

The quick filters match Account Name (is like / is not like, any part of the name), Any Routing Group, Any Tariff (a service plan, despite the label) and the status Any Status, Not Blocked or Blocked. Filters opens more: Description, Batch Tag, Expiration Date (on, Expired before, Expired since, Expires by, Expires not earlier than), Available Credit / Balance / Credit Limit, First Use Date, Account Class, and an ID range with Start ID and End ID.

The money filter takes phrases: LESS THAN 5, GREATER THAN 0, NOT LESS THAN 0, IS ZERO or a plain number. Date filters take Any, NEVER or a date. Other text matches nothing.

Below the filters a totals row shows Total Accounts, Total Balance, Total Credit Limit and Total Available Credit; click it to calculate. Each row has a wallet icon for Add Balance and an Actions menu: Edit, Login as, Add Balance, Authentication Rules, CDRs, Block or Unblock, Services (Service Codes, Trunks, Incoming Routing, Follow Me), Billing (Generate Invoice, Auto Recharge / Notifications) and Delete.

  1. Click Add.
  2. Enter Account Name. For retail users a short number such as 1001 works best: users dial each other by it.
  3. Keep the generated Password or type your own. It is both the web and the SIP password unless you tick Separate VoIP Login and VoIP password.
  4. Select Service Plan and, as the root customer, Routing Group.
  5. Enter Balance for a prepaid account and Credit Limit for a postpaid one.
  6. Check Registration Allowed for devices that register; clear it for IP-authenticated trunks.
  7. Click Save & Close.

After saving, the Account Created dialog shows Account Name, VoIP Login, VoIP Password and Web Password with copy buttons and Download .txt. They are shown once; later the form only shows a mask.

Four tabs hold the fields; in edit mode the header adds link tabs Authentication, Trunks, Incoming Routing and, when the KYC module is on, KYC. The stats bar shows Balance, Credit Limit, Available Credit and Last Login. Password fields show @@@@@@; leave them untouched to keep the current passwords.

Field Meaning
Account Name Web login and, while credentials are merged, the SIP login. Renaming renames the SIP login too. Required
Password / Web Password Web password; also the SIP password while merged. Generated on creation
VoIP Login, VoIP Password Separate SIP credentials, shown when Separate VoIP Login and VoIP password is ticked
Description Free text shown in the list
Registration Allowed Accept REGISTER from this account. On by default
Service Plan The service plan that prices the account’s calls and charges its subscription. Required. See Service plans
Routing Group Routing group for outgoing calls. Required for the root customer; resellers see Default unless they have extended routing
Balance Opening balance, creation only
Credit Limit How far below zero the balance may go. 0 for prepaid
CLI Translation Rule, CLD Translation Rule Rewrite rules applied to the calling and called numbers of this account’s calls
Account Class Class that groups accounts for KYC and reports. See Account classes
Media Relay Type Whether the account’s media goes through the relay
Max Sessions, Max Calls Per Second Caps on simultaneous calls and call attempts. Empty means unlimited
Caller Name [ Pass-Through ] keeps the caller’s display name; the name fields or the CLI can replace it, or type a fixed name
Max Credit Time (sec) Longest single call allowed, 3600 by default
Batch Tag Label for accounts created together, used in filters
Time Zone, Language For the account’s portal and CDRs
Blocked Block on save. The list’s Block action does the same immediately
Field Meaning
CPE Number, Preferred Codec, Use Preferred Codec Only Device identifier and codec preference. See Codecs management
P-Asserted-Id Translation Rule, Pass P-Asserted-Identity, Trust Caller Info, Hide CLI How the caller identity is passed on or hidden
Disallow Loops, Block Incoming Anonymous, Do Not Disturb, Generate Ringback Tone, Allow Free On-net Calls Call handling switches
Lifetime (days) Days the account stays usable after its first call. Empty means unlimited
Next Billing Date Date of the next service-plan charge. Has its own save icon and applies immediately; emptying it restarts the billing cycle today
Export Type, Payment Method, Payment Currency, Min Payment Amount Defaults for the account’s downloads and online payments
On Payment Action No Action, Extend Lifetime, Clear First Use or Restart Billing after a payment
Commission Agent, Commission Size (%) Reseller earning a share of this account’s traffic
Password Policy, Start Page, Provisioning ID Policy for the web password, landing page of the portal, identifier for auto-provisioning
Invoicing Enabled, Invoice Template Issue invoices for this account. See Invoicing
Privacy Schemas, Incoming Anonymous Action, Trust Privacy Headers, DNCL Lookup Privacy header handling and Do-Not-Call list checks

Block Incoming Anonymous rejects calls to the account that arrive without a caller ID. Incoming Anonymous Action chooses how: Reject Call answers 433 Anonymity Disallowed, Transfer To Voicemail sends the call straight to the account’s voicemail, Prompt And Reject Call plays a message first. The built-in Default password policy asks for at least 7 characters with letters and digits, expires the password after 90 days and forces a change at the first login; other policies are defined under System Management → Password Policies.

Address holds the company and contact fields used on invoices: Company Name, First Name, Last Name, Street Address, City, Province/State, Postal Code, Country, Phone, E-mail, Cc, Bcc and others. All optional.

Voicemail holds Voicemail Enabled, on by default for new accounts, with a random 4-digit PIN Code, VM Check Number *98 (dialled from the account’s phone to listen to messages) and VM Timeout (sec) 30 (how long the phone rings before the caller reaches voicemail). Dial-in Access allows reaching the mailbox through the check number. VM Notify Emails and VM Forward Emails send a notification or the recording by e-mail, and Delete After Forward removes forwarded messages from the mailbox. Welcome Call IVR selects the welcome call played after the first registration. Follow-Me Enabled turns on the Follow Me screen. See Follow Me.

Actions → Authentication Rules lists the rules that map incoming calls from IP trunks and DIDs to this account. Columns: Remote IP Address, Incoming CLD/DNIS, Incoming CLI/ANI, To Domain, From Domain, CLD Tr. Rule and CLI Tr. Rule.

  1. Click Add.
  2. Enter Remote IP Address for a trunk, Incoming CLD/DNIS for a DID, or both. Empty fields match anything.
  3. Under Advanced Parameters set a Tariff or Routing Group to override the account’s for calls matched by this rule, and Max Sessions or Max Calls Per Second to cap the source. Protocol is SIP unless the rule is a Calling Card PIN.
  4. Click Save & Close.

Rules can be loaded in bulk with Upload and exported with Download in the same columns. How the switch chooses between overlapping rules is explained in Authentication.

Click the wallet icon or Actions → Add Balance. Add Funds records a payment, Manual Charge debits, Manual Credit credits without a payment. Advanced actions adds Extend Lifetime and Clear First Use, which reset the lifetime counter of prepaid cards. Enter Amount, keep the account’s currency and add Notes for the payment history.

Actions → Block disconnects the account’s calls in progress and rejects new ones; Unblock restores service at once. A blocked account still registers and can be edited.

Download exports the accounts that match the current filters in your download format (CSV or Excel). Passwords are never exported. Upload… takes the same file back with an Action [A|D|U] column: A adds the row, U updates the account with the given Id, D deletes it, blank rows are ignored. Rows that fail come back as an Accounts errors file with an Error Message column. Upload does not expand name or password patterns; for those, see Generate accounts and vouchers with patterns.

Actions → Delete moves the account to the Deleted tab; its CDRs stay reachable there. Restore on that tab brings it back and lets you pick replacements for a service plan, routing group or account class that no longer exist. Deleting an authentication rule is permanent.