Sub Accounts

{| class="wikitable"
|+
|-
! Article en Français !! Artículo en Español
|-
| [https://wiki.voip.ms/article/Sous_Comptes Français] || 
[https://wiki.voip.ms/article/Sub_Cuentas_(Sub_Accounts) Español]
|}


Having a Sub Account allows you to register more than one device to make or receive calls simultaneously, you can also use it as an internal extension for your office or even your house. Many of the features within voip.ms make use of sub accounts. With this guide we are going to learn how to create and use this feature properly.


__TOC__


== Blog Article ==

[https://wiki.voip.ms/article/How_to_use_IP_authentication_with_a_Sub_Account How to Use IP Authentication with a Sub Account]


== How to Create a Sub Account ==

You can create as many Sub Accounts as required and there's no extra charge for doing this. First you need to enter your Customer Portal and select "Create Sub Account" under the Sub Account Menu.

[[File:Newsubaccountsettings.jpg|800px]]

===Basic Options ===

These are the basic options you need to configure in order to properly create a Sub Account.

'''Protocol''': Here you can select either SIP or IAX2 protocol. This will depend on the device you want to use with this Sub Account. SIP is the recommended protocol. 

'''Authentication type''': This is an option that you don't have with your main account. You can choose between '''User/Password Authentication''' or '''IP Authentication'''. Again this setting will depend on the device you're using. 

-- '''User/Password Authentication''': This is the recommended setting and most devices only support this option.

-- '''IP Authentication''': Recommended for advanced users. Mostly this is used for PBX or Asterisk-based servers. When you select this option you can set the IP of your device/server.

 '''Note:''' When you use IP Authentication the registration status will not be displayed in your Customer Portal: Home Page.

'''Username''': This is the username of the sub-account. You can use alphanumeric characters for the username (make sure your device supports the use of alphanumeric characters in the user field). The format of the username will be as follow: '''{Main Account}_{username}'''.
 
For example, let say that your account is ''100000'' and you set the username as ''home'' the username that you're going to use in your device will be ''100000_home''.

'''Password/IP Address''': Here you can set the password to use for this sub account. The minimum is 6 characters, although it's strongly suggested that you use more characters and also use alphanumeric characters to create a strong password.

If you're using IP Authentication here you can set the IP address of your device/server. Format e.g. 201.202.203.204.

[[File:IP AUTH.jpg|thumb|none|700px]]

'''Trunk''': This option only becomes available if IAX2 is the chosen protocol. You can leave the default to send mini voice packets, or select "Send trunk packets" to group outgoing media frames into trunk packets, each with their own timestamps.

[[File:Trunk.jpg|thumb|none|700px]]


'''Device type''': Make sure to select the correct type of device you're going to use with this subaccount to properly receive incoming calls.

'''CallerID Number''': If you are using an analog telephone adapter (ATA), IP phone, or softphone, this is where you need to adjust the settings. It is important to ensure that you transmit a valid caller ID to ensure proper termination. Here you will have the option of having one of your incoming DID numbers displayed as an outgoing call identification number. You can also use a personalized number that does not appear in your lists of DID numbers. However ''you must respect the standards in force by the regulations to this effect. Always use a number that belongs to you or to that you have permission to use as the outgoing call display number.'' If you have a PBX that manages the outgoing call identification number, you will have an option for this. In order to be able to define a name in output display, generally this will have to be set from your ATA / PBX / Softphone device, etc. ''Nota: Using a Toll free outbound caller id is not recommended, especially when calling Toll-Free numbers.''

'''Canada Routing''': This defines the route the system will use when you place a call to Canada with your Sub Account.

'''International Route''': You can select the route that is going to be used for International Calls from this sub-account. 

'''Allow International Calls''': With this setting, you can enable or disable the International Calls from the sub-account. 

'''Allow *225 for Balance''': When Enabled, calls placed to *225 will provide the Current Balance of the VoIP.ms account. When Disabled calls placed to *225 will be rejected.

'''Music on Hold''': This setting allows you to select whether or not the person calling your DID number or extension will hear Music while the call is on hold.<br/>
The following options for music are available:<br/>

{| class="wikitable" border: none;"
! colspan="3" | Music on Hold
|-
! scope="col" | Test Code
! scope="col" | Name
! scope="col" | Description
|-
| '''***89'''  || Away in the Tropics ||  From Hawaii to the Caribbean, these tracks deliver sounds of ukulele, steel drums, and steel guitars.
|-
| '''***90'''  || Coffee and Sunrise ||  Uplifting without being perky, and positive without being too smiley.
|-
| '''***91'''  || Coffee Shop Acoustic ||  Soothing, acoustic guitar tracks makes for a relaxed feel and sets a great atmosphere.
|-
| '''***92'''  || Easy Listening || Smooth, casual tunes.
|-
| '''***93'''  || Guitar Alchemy ||  Clever harmonics and progressive chord sequences to create a joyful and warming musical experience.
|-
| '''***94'''  || Happy Endings ||  Uplifting, commercial style. Guitar, drums, ukulele, harmonica and bells.
|-
| '''***95'''  || Light and Casual ||  Soothing and peaceful songs with a light, positive feeling.
|-
| '''***96'''  || Orchestral Moods ||  Emotional and dramatic tales spun by violins, pianos and full orchestras.
|-
| '''***97'''  || Piano Mix ||  Smooth Piano
|-
| '''***98'''  || Rock me Easy ||  Feel-good music to create a relaxing atmosphere.
|-
| '''***99'''  || Spa Sounds ||  Soft, slow and serene instrumentals.
|-
| '''***100'''  || Aucune musique, bip intermittent ||  Silent, but with a subtle intermittent bleep sound to let your callers know that they are still on the line while they hold.
|}

'''Account name or description''': This setting can help you to easily identify each sub-account.

=== Advanced Options ===

These options allow you to set the allowed codecs, DTMF modes and NAT for each subaccount. These settings are recommended for advanced users only.

[[File:Advsettingssub.png|800px]]


*'''Allowed Codecs:''' This setting allows you to select the codecs that you're going to use, you can choose to allow one or more codecs at the time.
 

'''G.722 Codec'''

The '''codec G.722 or VoIP HD audio''' is a wideband audio codec that operates at a high data sampling rate. The higher sampling rate allows the G.722 codec to provide higher clarity of audio signals than G.711.<br>
Codec G.722 and HD voice is '''available''' and fully supported when performing SIP calls '''where both ends of the calls have codec G.722 configured''' and will also work for internal calls between customers within VoIP.ms '''as long as they are in the same POP server''', system recordings or messages.<br>

 Codec G.722 is currently not supported for communication between different POP/servers.

Due to the nature of its technology and the current limitations with the existing regular phone providers (not supporting G.722), '''HD voice is currently not available''' when calling external regular phone lines or mobiles.


*'''DTMF Mode:''' This allows you to select the DTMF mode that is going to be used with this sub account. If you set this to ''AUTO'' the ''RFC2833 (AVT)'' is going to be used and automatically switch to ''INBAND'' if the other end doesn't support ''RFC2833''.
 '''Note:''' Its recommended that you select the same DTMF mode in your device. 

*'''NAT (Network Address Translation):''' This setting should be set to ''Yes'' if you're behind a NAT, if not set to ''No''. If you're unsure what this setting means, is highly recommended that you leave it to ''Yes''.

*'''Encrypted SIP Traffic''': This setting allows you to encrypt the communication between your device and our server, by using the SIP-TLS ''(Transport Layer Security)'' and SRTP ''(Secure Real-Time Transport Protocol)'' protocol.

Before using this feature, please consult the article about the [[Call Encryption - TLS/SRTP]]

 '''Note:''' If enabled, all SIP traffic calls will be encrypted for this sub account.  
 '''     ''' Please note that if encrypted calls are enabled then you need to configure your device to make and receive encrypted calls.

*'''Max Expiry:''' Sets the '''maximum''' amount of time (in seconds) until a device or phone system registration expires. The default value is 3600 but the range can go from 60 to 3600 seconds. If your device or phone system requests a lower registration expiry time to the server, this will be respected. MaxExpiry also applies to subscriptions, Message-Waiting Indicators (MWI) as well as Presence (BLF).

*'''RTP Time Out:''' Sets the amount of time (in seconds) of '''no RTP activity (silence)''' before the call is terminated when the call is '''NOT''' on Hold. If the field is left empty the default value of 60 seconds will be used. RTP time out can range from 1 to 3600 seconds but it must always be equal or lower than RTP Hold Time Out.

*'''RTP Hold Time Out:''' Sets the amount of time (in seconds) of '''no RTP activity (silence)''' before terminating a call that is '''On-Hold'''. If the field is left empty the default value of 600 seconds will be used. RTP Hold Time Out can range from 1 to 3600 seconds but it must always be equal or greater than RTP Time Out.


 Note: '''Max Expiry, RTP Time Out, and RTP Hold Time Out''' settings are available for the main account and subaccounts independently.

=== Optional Settings ===

Although these are optional settings, you can use these settings to assign an internal extension number, voicemail and Ring Time for your sub account.

[[File:subaccountoptional2.png|800px]]


'''Internal Extension Number''': You set an internal extension number in order to call between Sub Accounts under the same Main Account. The extension number you enter in this field will have a leading 10, you can enter from 1 to 10 digits. For example if you set ''55'' the extension number will be ''1055''.
 Note: Make sure that the sub accounts are registered to the same server in order to make an internal call. The call to an internal extension is FREE.

'''Enable Internal CallerID / Internal CallerID Name:''' Allows you to set a specific callerID Name that will be seen only on internal calls between you and your sub account users. Additionally, your extension number will show on your internal calls instead of your 10digit callerID number.


==== Sub Account as an External SIP URI ====

To use a sub account as an external [[SIP URI]], you only need to enable it as an Internal Extension first. For example, let's say your Internal Extension is set to 2 (102 with the leading 10), you can be reached directly via SIP from another network with a URI that is going to look like this: ''1000002@server.voip.ms'' (Replace server.voip.ms by the server you are registered to, and the 2 by your internal extension).


'''Internal Extension VoiceMail''': Here you can select which [[voicemail]] is going to be associated with this sub account. Please set this to be able to access a particular Voice Mailbox using *97 from the device registered with this sub account's credentials, even if you are not using Extensions.

 '''Note:''' If you associate a [[voicemail]] with this subaccount, you are going to receive a '''Message Waiting Indicator''' when you have new messages in your mailbox. 
       This will lead to different results depending on your type of adapter, soft phone or IP phone. 
       For example, when using a Linksys ATA adapter, it's usually a stutter tone with periodic ring, IP phones usually use a stutter dial tone 
       when you pick up the line and are equipped with a blinking light, soft phones usually show a Voicemail Icon in the dial display.

'''Internal Extension Ringing Time''': This is the amount of time the phone will stay ringing when you call this internal extension directly. 5 sec = 1 ring.

=== Security ===

We provide some additional settings to further enhance the security of your systems with our service.

[[File:IP_Restrict_En.jpg|thumb|none|700px]]

'''IP Restriction''': Enabling this option will provide you with an extra security layer where outgoing calls will be authorized only from the IP address or IP range specified.

'''POP Restriction''': Enabling this option will provide you with an extra security layer where outgoing calls will be authorized only from the Points of Presence (POPs) selected.

=== Reseller Configuration ===

Also if you're using the [[Reseller Basic Guide|Reseller Interface]], you can associate each sub account with one of your customers. 

[[File:Subaccreseller.jpg|800px]]

'''Reseller Client''': Here you can select the customer that you want to associate with this subaccount. You need first to create the account of your customer using the [[Reseller Basic Guide|Reseller section]] in your Customer Portal.

'''Reseller client package''': Here you can select the package that you want to assign to your customer. You need first to create a package in the [[Reseller Basic Guide|Reseller section]]. 

'''next billing date''': Here you can set the next billing date. Usually the system sets this automatically, but if you manually change the package associated to this subaccount, you can change the next billing date manually.

'''Charge setup fees now''': Once you check this option, the monthly fee for the package is going to be charged. You can use this option when you have applied a change in the package of the customer.

== Sub Account Registration ==

You can check your sub accounts registration at the Main Page of the Customer Portal. Your sub accounts will appear listed under '''Sub Account Registration Status''' and you will be able to search or filter them using the '''Sub-Account Filter''' searchbox.

[[File:SubaccountRegistration.png|800px]]

== Sub Account Reports ==

You can see the amount of minutes, number of calls and even the amount spent for each sub account. This information is useful even if you're not using the [[Reseller Basic Guide|Reseller Interface]]. You can access this from your Customer Portal>>Sub Accounts>>Sub Accounts Reports menu.

[[File:Subacc report.jpg|800px]]


'''Report Range''': You can display a report with a range of 92 days only (3 months). 

'''Minutes''': The number of minutes used by this sub account in the given range. Expressed using decimal time. 

'''Calls''': The number of calls made for this sub account in the given range.

'''Amount Spent''': This is the amount spent for this sub account in the given range.

== Use of the subaccount ==

Once you have created one subaccount, you can use it with most of the features available within your Customer Portal, for example with the [[Digital Receptionist (IVR)]], as an agent to receive calls from [[Calling Queues]], Routed directly to your DID numbers, as an external [[SIP URI]] to receive incoming calls from another networks, etc.

[[category:guides]]