Device settings

From Kolmisoft Wiki
Jump to navigationJump to search

General

  • Accountcode – the unique ID of the device in the system.
  • Description – for informational purposes.
  • PIN – device PIN for authentication/authorization.
  • Device group – to which group the device belongs (not used most of the time).
  • Type – what type of device it is. Device type cannot be changed once it is created.
  • Extension – a short number by which this device can be reached; must be unique in the system.
  • DTMF Mode – in which protocol phone button presses are sent over network. The available options are: inband, info, RFC2833, and auto. Choose which one your provider uses (RFC2833 is used most often). This setting applies to SIP, H.323 and IAX2 protocols. For ZAP devices edit the configuration files in /etc/asterisk.
  • Location – the default is Global. Choose the appropriate location based on Localization needs.
  • Ringing Timeout – allows to limit the ringing duration in seconds. Minimal value is 10 seconds. Option is designed for incoming calls.
  • Call Timeout – allows to limit answered call billsec. Leave 0 for unlimited.
  • Trunk – No/ Yes/ Yes with ANI/ 3CX – Is this device Trunk with/without ANI, 3CX? The "3CX" option adds rinstance parameter to R-URI which is used on 3CX authentication. More details: https://www.3cx.com/docs/sip-trunk-registration-authentication/
  • Server – allows to choose server in multiple servers system. Choose All to assign all servers. Option All can be used and is shown only for IP Authenticated devices. (While Carrier Class Addon is active, all Virtual and Fax devices are auto-assigned to all present Asterisk servers and cannot be re-assigned. Disabling Carrier Class Addon all Virtual and Fax devices will be assigned to default Asterisk server chosen from Addons > Carrier Class > Settings dropdown).
  • Balance – a balance of the device. Disabled by default. Balance is decreasing when the User makes calls. Payments does not affect device balance.



Authentication

For dahdi devices:

  • Channel – which channel (or channel group) to use on PRI/BRI/PSTN card. Channels and groups should be configured in zapata.conf.



For SIP, H323 and IAX2 Devices:

IP Authentication:

  • Hostname – Device hostname. Use "IP Address" instead if you have problems with inbound calls.
  • IP Address – Device IP address in one of the following formats:
    • IP – understands simple IP address, IP address with it's Subnet Mask and IP address with it's Range. For example 192.168.0.1, 192.168.0.1/24 and 192.168.0.0-255.
  • Accept calls from any port – this option lets you receive calls from different Ports. This option is just on SIP (when SIP balancer in use) and H323.
  • Port – Device Port.

Dynamic:

  • Username – username you enter in your Device.
  • Password – password you enter in your Device.
  • IP Address – shows Device IP address.
  • Port – shows Device Port.
  • Registration Status - available only for SIP devices. If device is assigned to server A but registers to server B - status will not be shown (devices must register to the server they are assigned to). If no status is displayed - device has not tried to register or no one called to that device. Qualify must enabled if you want to monitor device status.
  • UNREGISTER - last registration information will be deleted (ipaddr, port, fullcontact).



CallerID



Device callerid.png

A CallerID consists of two parts: Name and Number. The "Number" part is transferred by default by all technologies (GSM, PSTN, SIP etc), but the "Name" part is transferred only by some. The number you see on your mobile phone when someone is calling you is the "Number" part.

  • Name – the "Name" part of the CallerID.
  • Number – the "Number" part of the CallerID. Only numerical values can be entered in this field.

NOTE: if you leave these fields empty, the user can set the CallerID name by himself. Usually it is not advisable to allow the user do it on his own. If CallerID number field is empty, system will take device username as CallerID number (if device is username/password authenticated).

  • Number from DID - use the DID as the CallerID (only available when the device has DIDs), this option just sets CallerID Number to be equal to DID. Next time you will edit Device's settings, first option - Number will be checked
  • Control by DIDs (CID from DIDs) – only available when the device has DIDs and "Number" field is empty.

This setting lets you control what a CID user can enter in his devices. CID numbers should be from the set of the device's DIDs. They are mainly used when the user's PBX is connected over Trunk and many DIDs are routed to this Trunk. Calls coming out from this PBX must have a CallerID Number from the set of DIDs assigned to this Trunk (PBX). If "CID from DIDs" is checked, the system checks whether the device's CID number is from DIDs assigned to this device. If no DIDs are assigned, this value is ignored. In order for this setting to be active, CID Name/Number fields must be empty to allow the user to enter any CID number he wants. If "CID from DIDs" is checked and user enters any CID (not from his DIDs), the system will change his CID by his first available DID (selected from database by lowest ID). Original (non Localized) CallerID is used for DID matching.

  • Control by CIDs – system checks incoming CallerID (Device's CallerID which is set on the Device). If CallerID matches one of the Device's CIDs - then such CallerID will be allowed. If it does not match - it will be changed to the selected CID.
  • Control by Destination – This is advanced option which works by such algorithm:
  1. system checks Destination and checks DIDs assigned to calling Device. Then it finds 'nearest' DID to the Destination by subtracting DID from Destination in numerical form (Example, DID: 11111, Destination: 11112, |DID-Destination|=|1111-11112|=1) If Device has several DIDs - the lowest value is selected and this DID is set as CallerID.
  2. If Device has no DIDs - then User DIDs are used.
  3. If Device does not have DIDs and User has no DIDs, then CallerID set in Number field will be used.
  4. If nothing is set here - CallerID coming from Device will be used.

Note: behavior can be changed to search for best matching DID instead of nearest DID

  • Random Number from Number Pool – This functionality gives you an ability to send different caller number on each Call. Available from MOR X4. More information: Number Pool.
  1. Random - Send random CallerID.
  2. Pseudorandom with Deviation. Range can vary from 0 to 9999999. If 0 is chosen, then all numbers will be chosen same amount of times. If 9999999 is set, then numbers will be completely random.
  • Unknown - This option lets you set CallerID number to unknown and pass a custom CallerID in either RPID or PAI header:

Unknown cid rpid pai.png

  • Copy Leg A Name to Leg B Number – Leg A name will be used as Leg B number.



Network Related

For H323:

  • Fast start – option for faster H.245.
  • h245 Tunneling – use H.245 without opening a second TCP/IP channel.

More info you can find here.

For SIP and IAX2

  • Media control – can reinvite. Do you want your server to stay in media path between your clients and your provider? Please note that this option will work only if it is supported from both, device and provider, sides and it allows to handle SIP packets only. Moreover, no codec mismatch between device and provider is available. Default value is No. WARNING: This option can cause incorrect billing.
    • canreinvite = yes "allow RTP media direct"
    • canreinvite = no "deny re-invites"
    • canreinvite = nonat "allow reinvite when local, deny reinvite when NAT"
    • canreinvite = update "use UPDATE instead of INVITE"
    • canreinvite = update,nonat "use UPDATE when local, deny when NAT"
  • NAT – the available options are: yes, no, never, force_rport, comedia. For a detailed explanation of these settings, refer to here.
  • Qualify – how long to wait for a response to Qualify request. If you have lot of Devices in your system, set it to 9000ms or more. More details here for SIP devices and here for IAX2 devices.
  • IAX2 Trunking Mode – enable/disable trunking mode, which allows multiple voice streams to share a single "trunk" to another server, reducing overhead created by IP packets. Only on IAX2.



Groups



Voicemail

  • Email – where to send received Voicemail.
  • Password – the digital password the user enters when he calls the Voicemail number to hear his messages.

Voicemail login details are required when the user access Voicemail from outside over DID.

  • Enable MWI - In telephony, a Message Waiting Indicator (MWI) is a telephone calling feature that illuminates a LED on selected telephones to notify a user of waiting for voicemail messages. It works on most telephone networks and PBXs.
  • Subscribe MWI - If set to 'no', then Asterisk will send notifications to the phone about new voicemails. If set to 'yes', then the Phone should subscribe to Asterisk to get messages. If MWI does not work on your phone, try to switch this setting on/off.
  • Delete VoiceMail after sending it – If it is set to 'yes', the VoiceMail will be deleted after it is sent to email.


  • Language – (in Advanced settings) sets Voicemail language (and IVR language)



Codecs

Choose the codecs your provider uses.

NOTES:

  • When no fields are checked, all codecs are available – for example, settings in sip.conf or iax.conf are effective.
  • If the Provider and the Device do not have similar codecs, no call can be established.



Allowed Addresses

Described here



Limits

Here is possible to set various limits for a device.

Mor device call limits.png

  • Separate concurrent Call Limits
    • Outbound concurrent Call Limit - how many outbound simultaneous calls a Device can make?
    • Inbound concurrent Call Limit - how many inbound simultaneous calls a Device can get?
  • One concurrent Call Limit (Outbound + Inbound) - how many outbound simultaneous and inbound simultaneous together calls a Device can make?
  • Time limit per day - Total time available for device per day. When the limit is reached call fails with HGC "239 - Device used its daily call time limit" (total time is calculated after rounding rules and minimal time adjustment, so if the user's tariff has increment higher than 1 or minimal time set, then the total device time may be different than actual call time).
  • Time limit per month - Total time available for device per month. You can also set the day of the limit reset (the default is 1st day of a month). When the limit is reached, the call fails with HGC "286 - Device used its monthly call time limit" (total time is calculated after rounding rules and minimal time adjustment, so if the user's tariff has increment higher than 1 or minimal time set, then total device time may be different than actual call time).
  • (CPS) Limit up to - allows setting calls per second limit in some period.
  • Hangup Call if PDD is more than- set maximum PDD time (in seconds) before call hangup. Note that failover providers will not be used in this case. The call will be hung up completely and will not be passed to other providers in LCR.

Advanced

  • Fromuser/Fromdomain – used when calling TO this peer FROM Asterisk. If you're using _register=>_ with another SIP proxy, this setting can come in handy since some SIP networks only allow users in the right domain with the correct user name.
  • Trustrpid – defines whether or not Remote-Party-ID is trusted. It's defined in http://tools.ietf.org/id/draft-ietf-sip-privacy-04.txt.
  • Sendrpid – defines whether a Remote-Party-ID SIP header should be sent. The default setting is "no". This field is often used by wholesale VoIP providers to provide calling party identity regardless of the privacy settings (the From SIP header).
  • Insecure
    • port: ignore the port number where the request came from. WARNING: do NOT enable it on username/password authenticated devices.
    • invite: don't require authentication of incoming INVITEs. WARNING: do NOT enable it on username/password authenticated devices.
    • port, invite: don't require initial INVITE to authenticate and ignore the port where the request came from. WARNING: do NOT enable it on username/password authenticated devices.

Both of these settings are enabled by default for IP Authenticated devices, but they can be changed, unless you are using Carrier Class Addon, which forces the device to ignore the port number and the authentication from an incoming request.

Insecure Invite means that MOR will not challenge for a password, it means that anyone who knows extension can call without password, this is the reason why it is very insecure to use for username/password authenticated devices.

Insecure Port means that MOR will allow INVITES from a different port than the one REGISTER packets come from. This could be used with username/password authenticated devices too.

  • Disable global pass_privacy - if set to yes, this option disables global pass_privacy_header variable for this device. If global pass_privacy_header variable is not set to yes, this option has no effect.
  • Usereqphone - Yes or No. The default setting is "No". Option adds ;user=phone in From, To, Invite, and PAI headers. Only active for incoming calls. If the device is originator, please set Usereqphone in Provider settings.
  • Custom SIP Header - adds custom header to SIP request. Format is header: value (for example x-My-Custom-Header: my value)
  • Progressinband:
    • yes – when the "RING" event is requested, always send 180 Ringing (if it hasn't been sent yet) followed by 183 Session Progress and in-band audio.
    • no – send 180 Ringing if 183 has not yet been sent, establishing an audio path. If the audio path is established already (with 183), then send in-band ringing (this is the way Asterisk historically behaved because of buggy phones like Polycom's).
    • never – whenever ringing occurs, send "180 ringing" as long as "200 OK" has not yet been sent. This is the default behavior of Asterisk.

NOTE: if Progressinband does not work, add "prematuremedia=no" to sip.conf and reload Asterisk.

  • Video support – does your provider support Video over IP? More info here.
  • Allow duplicate calls – the default setting is "no".
  • Language – sets IVR language
  • Use ANI (if available) for CallerID: – When the call comes the information about who is calling is found in CallerID field. This field is used to determine who is calling. When the call comes through PRI/SS7 channels - then additional information is available who is calling in ANI field (in call's data channel) so sometimes CallerID might be empty or anonymous, but the caller can be found in ANI field. This option allows to use ANI field as CallerID to determine and recognize who is calling.
  • Incoming Call CallerID Presentation – sets CallerID Presentation. Please note that this setting applies only for incoming calls. More information can be found here and here
  • Change Failed Code To – if call fails change Hangup Cause Code to this value. This works only for outgoing calls from device. Not for Incoming
  • Forward DID – it allows to forward call to DID which is assigned to Authorization by PIN or Calling Cards dial plan. After user enters PIN of any device or card, call gets connected with destination.
  • Anti-resale (Auto-answer) – when option is set to YES, MOR answers the call before sending it to provider in order to generate FAS. This does not affect billing in MOR (User is not billed for extra time).
  • Anti-resale (Auto-answer) Sound file - this setting is visible when the Anti-resale (Auto-answer) is set to Yes only.
  • Transport – lets you choose protocol(s) for data transfer. Appears only if device is SIP and when Asterisk 1.8 is enabled. Default value: udp. If TCP is used, it has to be enabled in Asterisk.
  • T.38 Support – should T.38 pass-through be supported
  • SRTP Encryption – should SRTP protocol be used for calls
  • Block callerid if (number) simultaneous calls come from it – blocks CallerID if the entered number of simultaneous calls come from it
  • Outbound Proxy – send outbound signaling to this proxy, not directly to the peer (Internal Asterisk option).
  • SIP Session Timers - SIP Session Timers provide an end-to-end keep-alive mechanism for active SIP sessions. Possible values are "accept", "originate", "refuse":
    • originate - request and run session-timers always.
    • accept - run session-timers only when requested by other UA.
    • refuse - do not run session timers in any case.
  • SIP Session Refresher - The session refresher (uac|uas). Defaults to 'uas'.
    • uac - default to the caller initially refreshing when possible.
    • uas - default to the callee initially refreshing when possible.
  • SIP Session Expires - maximum session refresh interval in seconds. Defaults to 1800 secs.
  • SIP Min Session - minimum session refresh interval in seconds. Defaults to 90 secs.
  • Localize PAI - if set to 'yes' then MOR will localize originator's number from PAI (P-Asserted-Identity) by CallerID Localization Rules. Works only if pass_pai is set in mor.conf.
  • Pass PAI - available options are 'Global', 'Yes', 'No'. Global (default value) means use value from pass_pai in mor.conf file. More information available in table here.
  • Use random Number when CallerID is invalid - if set to Yes then when CallerID is NOT found in a Number Pool set in Number Pool with valid CallerIDs then CalleID in FROM is changed to "anonymous" and random CallerID taken from Random Number from a Number Pool is set in PAI/RPID headers.
  • Emergency CallerID - number from this field will be used as CallerID if Destination number matches any number from Emergency CallerID Number Pool (see below). Localization rules will be applied before checking Destination number in Number Pool. P-Asserted and/or Remote-party-ID will be overwritten with the same as CallerID. If Destination number (after localization applied) does not match any number in Emergency CallerID Number Pool, then CallerID is handled as usual.
  • Emergency CallerID Number Pool - Number Pool with numbers used for Emergency CallerID feature.
  • Music On Hold to Device - what to play when this Device is made On Hold by other party. Feature named "mohinterpret" on Asterisk.
  • Music On Hold from Device - what to play to other party, when this Device sets it On Hold. Feature named "mohsuggest" on Asterisk.
  • Announcement to the Called Party - plays specified announcement to callee in the beginning of conversation, right after call is answered. For example you can play message like "This conversation will be recorded" before every call from this Device.



Tell Options

  • Tell rate before call - should MOR tell announce minute price (rounded to cents) before every call. Default value is "no".
  • Tell balance before call – should MOR tell the user his balance every time he tries to dial? The default setting is "no".
  • Tell time - should MOR tell the user his remaining time every time he tries to dial? The default setting is "no".
    • Time is told in MINUTES only. Currently it is not possible to tell both in minutes and seconds.
  • Tell remaining time when left – when some time is left, MOR will tell the remaining time to talk (in seconds).
  • Repeat remaining time when left – repeats the remaining time when some time is left (in seconds).



Debug

NOTE: debug should be enabled only if you are experiencing any problems. It should be disable in any other cases, because it stores lot of information on database.

Recordings

This section is available when Recordings Addon is installed in the system.

Comment

Devices can have Comments, which gives information about the Device.

See also