Kolmisoft Wiki - User contributions [en]

MOR API payments get

2017-12-04T08:14:11Z

Zilvinas: /* Parametres */

=Description=

[[MOR API]] Payments list
 
=Usage=

* From '''MOR X4''' call: '''/api/payments_get'''
* For Backwards-compatibility old name 'payments_list' is also usable. Call: '''/api/payments_list'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

* u - username for authentication. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
*s_user_id - payments user id.
*s_from - Unix timestamp of calls period starting date. (Default: Today at 00:00). '''Note:''' only works when ''s_till'' is provided.
*s_till - Unix timestamp of calls period end date. (Default: Today at 23:59). '''Note:''' only works when ''s_from'' is provided.
* s_transaction - transaction id.
*s_completed - payment status. Possible values[ 1 - completed, 0 - not completed, if not sent - default: All]
*s_username - users username.
*s_first_name - users first name.
*s_last_name - users last name
*s_paymenttype - payment type. Possible values['Card', 'paypal','webmoney','ouroboros','manual','gateways_paypal','gateways_authorize_net','integrations_moneybooker','integrations_two_checkout', if not sent - default: All]
*s_amount_min - amount starting from.
*s_amount_max - amount ending with.
*s_currency - payment currency. Example: USD
*s_number - card number.
*s_pin - card pin.
 

===Request===

We have s_user_id = 123, API Secret Key = 456789

We send:

HTML POST: http://<SERVER_IP>/billing/api/payments_get?u=username&s_user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

'''NOTE that username are not included in hash'''
 

===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<pagename> Payments_list </pagename>
<payments>
<payment>
<user> ''payment user'' </user>
<payer> ''email or payer ''</payer>
<transaction_id> ''transaction id'' </transaction_id>
<date> ''date added'' </date>
<confirm_date> ''confirm date'' </confirm_date>
<type> ''payment type'' </type>
<amount> ''payment amount'' </amount>
<fee> ''payment fee'' </fee>
<amount_with_tax> ''payment amount with tax'' </amount_with_tax>
<currency> ''payment currency'' </currency>
<completed> ''payment status'' </completed>
<confirmed_by_admin> ''confirmed by admin?'' </confirmed_by_admin>
<comments_for_user> ''commented by admin'' </comments_for_user>
</payment>
</payments>
</page>
 
----

'''Errors'''

* <error>Bad login</error> - User was not found by username. Use correct username. Make sure that username (u) are specified.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.

 

=See also=

* [[MOR API]]

MOR API payments get

2017-12-04T08:14:00Z

Zilvinas: /* Parametres */

=Description=

[[MOR API]] Payments list
 
=Usage=

* From '''MOR X4''' call: '''/api/payments_get'''
* For Backwards-compatibility old name 'payments_list' is also usable. Call: '''/api/payments_list'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parametres===

* u - username for authentication. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
*s_user_id - payments user id.
*s_from - Unix timestamp of calls period starting date. (Default: Today at 00:00). '''Note:''' only works when ''s_till'' is provided.
*s_till - Unix timestamp of calls period end date. (Default: Today at 23:59). '''Note:''' only works when ''s_from'' is provided.
* s_transaction - transaction id.
*s_completed - payment status. Possible values[ 1 - completed, 0 - not completed, if not sent - default: All]
*s_username - users username.
*s_first_name - users first name.
*s_last_name - users last name
*s_paymenttype - payment type. Possible values['Card', 'paypal','webmoney','ouroboros','manual','gateways_paypal','gateways_authorize_net','integrations_moneybooker','integrations_two_checkout', if not sent - default: All]
*s_amount_min - amount starting from.
*s_amount_max - amount ending with.
*s_currency - payment currency. Example: USD
*s_number - card number.
*s_pin - card pin.
 

===Request===

We have s_user_id = 123, API Secret Key = 456789

We send:

HTML POST: http://<SERVER_IP>/billing/api/payments_get?u=username&s_user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

'''NOTE that username are not included in hash'''
 

===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<pagename> Payments_list </pagename>
<payments>
<payment>
<user> ''payment user'' </user>
<payer> ''email or payer ''</payer>
<transaction_id> ''transaction id'' </transaction_id>
<date> ''date added'' </date>
<confirm_date> ''confirm date'' </confirm_date>
<type> ''payment type'' </type>
<amount> ''payment amount'' </amount>
<fee> ''payment fee'' </fee>
<amount_with_tax> ''payment amount with tax'' </amount_with_tax>
<currency> ''payment currency'' </currency>
<completed> ''payment status'' </completed>
<confirmed_by_admin> ''confirmed by admin?'' </confirmed_by_admin>
<comments_for_user> ''commented by admin'' </comments_for_user>
</payment>
</payments>
</page>
 
----

'''Errors'''

* <error>Bad login</error> - User was not found by username. Use correct username. Make sure that username (u) are specified.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.

 

=See also=

* [[MOR API]]

Hangupcause Codes

2017-10-26T06:26:43Z

Zilvinas:

<mkmeta>Disconnect Codes for MOR Class 5 Softswitch</mkmeta>
MOR application saves hangupcause codes (HGC in MOR terminology) to the database, so it is easy to check what the error was and why the call failed.

These codes can be seen in the Calls window (Hangup Cause column) when selected to show 'All', 'Busy', 'No Answer', 'Failed' or 'Missed' calls.

* Standard hangup codes can be found [http://www.voip-info.org/wiki/index.php?page=Asterisk+variable+hangupcause here].
* [http://networking.ringofsaturn.com/RemoteAccess/isdncausecodes.php ITU-T Q.850 Codes ]
* [http://en.wikipedia.org/wiki/List_of_SIP_response_codes SIP Response Codes]

 
= Standard codes =

<table>
<tr>
<td> Code </td>
<td> Cause </td>
</tr>
<tr>
<td> 34 </td>
<td> [[34 no circuit/channel available | no circuit/channel available]]</td>
</tr>
</table>
 

= MOR specific codes =

<table>
<tr>
<td> Code </td>
<td> Cause </td>
</tr>
<tr>
<td> 200 </td>
<td> [[200 MOR can't determine who is calling | MOR can't determine who is calling]]</td>
</tr>
<tr>
<td> 201 </td>
<td> [[201 User is blocked | User is blocked]]</td>
</tr>
<tr>
<td> 202 </td>
<td> [[202 Reseller is blocked | Reseller is blocked]]</td>
</tr>
<tr>
<td> 203 </td>
<td> [[203 No rates for user|No rates for User]] </td>
</tr>
<tr>
<td> 204 </td>
<td> [[204 No suitable providers found | No suitable providers found]] </td>
</tr>
<tr>
<td> 205 </td>
<td> [[205 MOR PRO not authorized to work on this computer | MOR PRO not authorized to work on this computer]]</td>
</tr>
<tr>
<td> 206 </td>
<td> [[206 server_id is not set in mor.conf file | server_id is not set in mor.conf file]] - ''this error code is not used anymore''</td>
</tr>
<tr>
<td> 207 </td>
<td> [[207 Not clear who should receive call | Not clear who should receive call]]</td>
</tr>
<tr>
<td> 208 </td>
<td> [[208 MOR can not make more calls | MOR can not make more calls]] </td>
</tr>
<tr>
<td> 209 </td>
<td> [[209 Test time exceeded | Test time exceeded]] </td>
</tr>
<tr>
<td> 210 </td>
<td> [[210 Balance more then 0, but not enough to make call 1s in length | Balance more than 0, but not enough to make call 1s in length]] </td>
</tr>
<tr>
<td> 211 </td>
<td> [[211 Low balance for user | Low balance for user]]</td>
</tr>
<tr>
<td> 212 </td>
<td> [[mor_authorize: Too low balance for more simultaneus calls!!!| Balance too low for more simultaneous calls]] </td>
</tr>
<tr>
<td> 213 </td>
<td> [[213 Low balance for DID owner | Low balance for DID owner]]</td>
</tr>
<tr>
<td> 214 </td>
<td> [[214 Too low balance for DID owner for more simultaneous calls | DID owner's balance is too low to make more simultaneous calls]]</td>
</tr>
<tr>
<td> 215 </td>
<td> [[215 Low balance for reseller | Low balance for reseller]]</td>
</tr>
<tr>
<td> 216 </td>
<td> [[216 Too low balance for reseller for more simultaneous calls | Reseller's balance is too low to make more simultaneous calls]]</td>
</tr>

<tr>
<td> 217 </td>
<td> [[217 Callback not initiated because device not found by ANI | Callback not initiated because device not found by ANI]]</td>
</tr>
<tr>
<td> 218 </td>
<td> [[218 Reseller does now allow loss calls | Reseller does not allow loss calls]]</td>
</tr>
<tr>
<td> 219 </td>
<td> [[219 DID has reached call limit. No more calls allowed to this DID | DID has reached call limit. No more calls allowed to this DID]]</td>
</tr>
<tr>
<td> 220 </td>
<td> [[220 User call limit reached | User call limit reached]]</td>
</tr>
<tr>
<td> 221 </td>
<td> [[221 Device call limit reached | Device call limit reached]]</td>
</tr>
<tr>
<td> 222 </td>
<td> [[222 Resellers call limit reached | Resellers call limit reached]]</td>
</tr>
<tr>
<td> 223 </td>
<td> [[223 Providers call limit reached | Providers call limit reached]] </td>
</tr>
<tr>
<td> 224 </td>
<td> [[224 Provider skipped because his rate is higher then users rate | Provider skipped because his rate is higher than user's rate]] </td>
</tr>
<tr>
<td> 225 </td>
<td> [[225 CallerID is banned | CallerID is banned]] </td>
</tr>
<tr>
<td> 226 </td>
<td> [[226 DID is free | DID is free]] </td>
</tr>
<tr>
<td> 227 </td>
<td> [[227 Calling Card PIN is not entered | Calling Card PIN is not entered]] </td>
</tr>
<tr>
<td> 228 </td>
<td> [[228 Calling Card Destination is not entered | Calling Card Destination is not entered]] </td>
</tr>
<tr>
<td> 229 </td>
<td> [[229 DID is reserved | DID is reserved]] </td>
</tr>
<tr>
<td> 230 </td>
<td> [[230 Connection returned error code 0 instead of real code | Connection returned error code 0 instead of real code]]</td>
</tr>
<tr>
<td> 231 </td>
<td> [[231 Provider unreachable | Provider unreachable]] - ''this error code is not used anymore'' </td>
</tr>
<tr>
<td> 232 </td>
<td> [[232 Callback DID not available | Callback DID not available]] </td>
</tr>
<tr>
<td> 233 </td>
<td> [[233 Skype Addon Disabled | Skype Addon Disabled]] </td>
</tr>
<tr>
<td> 234 </td>
<td> [[234 Internal Loop | Internal Loop]] </td>
</tr>
<tr>
<td> 235 </td>
<td> [[235 Providers rate higher by percent | Providers rate higher by percent]] </td>
</tr>
<tr>
<td> 236 </td>
<td> [[236 Callback initiation too early| Callback initiation too early]] </td>
</tr>
<tr>
<td> 237 </td>
<td> [[237 DID User is blocked| DID User is blocked]] </td>
</tr>
<tr>
<td> 238 </td>
<td> [[238 Provider used its daily call time limit| Provider used its daily call time limit]] </td>
</tr>
<tr>
<td> 239 </td>
<td> [[239 Device used its daily call time limit| Device used its daily call time limit]] </td>
</tr>
<tr>
<td> 240 </td>
<td> [[240 Provider belongs to the User which makes call| Provider belongs to the User which makes call (loop)]] </td>
</tr>
<tr>
<td> 241 </td>
<td> [[241 Local Caller canceled the call before call was answered|Local Caller canceled the call before call was answered]] </td>
</tr>
<tr>
<td> 242 </td>
<td> [[242 No Rates for Reseller|No Rates for Reseller]] </td>
</tr>
<tr>
<td> 243 </td>
<td> [[243 Provider skipped because of CPS limitation|Provider skipped because of CPS limitation]] </td>
</tr>
<tr>
<td> 244 </td>
<td> [[244 Device call aborted because of CPS limitation|Device call aborted because of CPS limitation]] </td>
</tr>
<tr>
<td> 245 </td>
<td> [[245 Provider skipped because of balance limitation|Provider skipped because of balance limitation]] </td>
</tr>
<tr>
<td> 246 </td>
<td> [[246 Duplicate call hangup|Duplicate call hangup]] </td>
</tr>
<tr>
<td> 247 </td>
<td> [[247 Dead Provider skipped|Dead Provider skipped]] </td>
</tr>
<tr>
<td> 248 </td>
<td> [[248 Call was terminated because FAS(False Answer Supervision) control detected an issue. | Call was terminated because FAS(False Answer Supervision) control detected an issue]] </td>
</tr>
<tr>
<td> 249 </td>
<td> [[249 Partner's call limit reached | Partner's call limit reached]] </td>
</tr>
<tr>
<td> 250 </td>
<td> [[250 Partner is blocked | Partner is blocked]] </td>
</tr>
<tr>
<td> 251 </td>
<td> [[251 Low balance for Partner | Low balance for Partner]] </td>
</tr>
<tr>
<td> 252 </td>
<td> [[252 Partner's balance is too low to make more simultaneous calls | Partner's balance is too low to make more simultaneous calls]] </td>
</tr>
<tr>
<td> 253 </td>
<td> [[253 Partner does not allow loss calls | Partner does not allow loss calls]] </td>
</tr>
<tr>
<td> 254 </td>
<td> [[254 No Rates for Partner | No Rates for Partner]] </td>
</tr>
<tr>
<td> 255 </td>
<td> [[255 Destination is in blacklist | Destination is in blacklist]] </td>
</tr>
<tr>
<td> 256 </td>
<td> [[256 Destination is not in whitelist | Destination is not in whitelist]] </td>
</tr>
<tr>
<td> 257 </td>
<td> [[257 Calling Card expired | Calling Card expired]] </td>
</tr>
<tr>
<td> 258 </td>
<td> [[258 Calling Card is not sold yet | Calling Card is not sold yet]] </td>
</tr>
<tr>
<td> 259 </td>
<td> [[259 Calling Card is empty | Calling Card is empty]] </td>
</tr>
<tr>
<td> 260 </td>
<td> [[260 Destination is blocked in User Tariff | Destination is blocked in User's Tariff]] </td>
</tr>
<tr>
<td> 261 </td>
<td> [[261 Destination is blocked in Provider Tariff | Destination is blocked in Provider's Tariff]] </td>
</tr>
<tr>
<td> 262 </td>
<td> [[262 Source number is in blacklist | Source number is in blacklist]] </td>
</tr>
<tr>
<td> 263 </td>
<td> [[263 Source number is not in whitelist | Source number is not in whitelist]] </td>
</tr>
<tr>
<td> 264 </td>
<td> [[264 No Rates for DID Owner | No Rates for DID Owner]] </td>
</tr>
<tr>
<td> 265 </td>
<td> [[265 Provider skipped because rate margin is lower than allowed | Provider skipped because rate margin is lower than allowed]] </td>
</tr>
<tr>
<td> 266 </td>
<td> [[266 Provider skipped because AGI script returned timeout error | Provider skipped because AGI script returned timeout error]] </td>
</tr>
<tr>
<td> 267 </td>
<td> [[267 Provider skipped because AGI script rejected this provider (AGI script status 0) | Provider skipped because AGI script rejected this provider (AGI script status 0)]] </td>
</tr>
<tr>
<td> 268 </td>
<td> [[268 PDD limit reached | PDD limit reached]] </td>
</tr>
<tr>
<td> 269 </td>
<td> [[269 User call rate is higher than allowed | User's call rate is higher than allowed]] </td>
</tr>
<tr>
<td> 270 </td>
<td> [[270 Reseller call rate is higher than allowed | Reseller's call rate is higher than allowed]] </td>
</tr>
<tr>
<td> 271 </td>
<td> [[271 Partner call rate is higher than allowed | Partner's call rate is higher than allowed]] </td>
</tr>
<tr>
<td> 272 </td>
<td> [[272 Provider skipped because the CallerID is in a Blacklist | Provider skipped because the CallerID is in a Blacklist]] </td>
</tr>
<tr>
<td> 273 </td>
<td> [[273 Provider skipped because the CallerID is not in a Whitelist | Provider skipped because the CallerID is not in a Whitelist]] </td>
</tr>
<tr>
<td> 274 </td>
<td> [[274 No rates for Provider | No rates for Provider]] </td>
</tr>
<tr>
<td> 275 </td>
<td> [[275 Incorrect DID PIN | Incorrect DID PIN]] </td>
</tr>
<tr>
<td> 276 </td>
<td> [[276 No Rates for DID Provider | No Rates for DID Provider]] </td>
</tr>
</table>

 

= Relation between MOR hangupcause codes and Standard codes =

This table describes which standard ISDN code is MOR giving when one or another hangupcause is given.

{| border="1" cellpadding="5" cellspacing="0"
| '''MOR code''' || '''ISDN code''' || '''SIP code'''

|-
| [[208 MOR can not make more calls | 208]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[210_Balance_more_then_0,_but_not_enough_to_make_call_1s_in_length | 210]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[211_Low_balance_for_user | 211]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[Mor_authorize:_Too_low_balance_for_more_simultaneus_calls!!! | 212]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[213_Low_balance_for_DID_owner | 213]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[214 Too low balance for DID owner for more simultaneous calls | 214]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[215_Low_balance_for_reseller | 215]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[216 Too low balance for reseller for more simultaneous calls | 216]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[219 DID has reached call limit. No more calls allowed to this DID | 219]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[220 User call limit reached | 220]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[221 Device call limit reached | 221]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[222 Resellers call limit reached | 222]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[223 Providers call limit reached | 223]] || [[34 no circuit/channel available | 34]] || 503 Service unavailable
|-
| [[226 DID is free | 226]] || 1 || 404 Not found
|-
| [[229 DID is reserved | 229]] || 1 || 404 Not found
|-
| [[233 Skype Addon Disabled | 233]] || 66 || 500 Internal server error
|-
| All others not listed above and greater than 199 ( >=200 ) || 21 || 403 Forbidden
|}
 
Starting from [[MOR 12]], it is possible to change relation between MOR code and ISDN code. Relation can be defined in [[Mor.conf|mor.conf]].
 

= See also =
* [[Hangupcause Sounds]]
* [[H323 hangupcause codes]]
* [[SIP Error Codes]]
* [[Change HGC for a User]]
* [[M2 Hangupcause Codes]]

File:Invoice generation.png

2017-10-20T10:45:06Z

Zilvinas: uploaded a new version of "File:Invoice generation.png"

M4 Customer Invoices

2017-10-20T10:42:51Z

Zilvinas: /* XLSX invoice files without Currency names */

= Description =

M2 '''Customer Invoice''' is dedicated for final User of M2, who have to pay for made Calls. Admin can see and manage them in '''ACCOUNTING –> Customer Invoices''', User can reach list of his Invoices and check them from main menu. Despite your settings all values in Invoices are rounded into two digits after comma. 
Invoices are generated automatically according to User's Billing Period (weekly, bi-weekly or monthly).
==Invoices List==

Invoices can be viewed, created (WIP) or exported to either XLSX or PDF file in '''ACCOUNTING –> Customer Invoices'''. In the main window, you can see list of all the Invoices.

All Prices are displayed in particular Invoice Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for invoice A exchange rate will be from that day when invoice was generated (0.5). 

Same calculations with other currencies 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for invoice B exchange rate will be from that day when invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for invoice C exchange rate will be from that day when invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 
==Invoice Edit==

Invoice edit is accessed from invoices list.

Here you are able to see some information of the user and Invoice displayed and also some details of the Invoice can be edited.

'''Price''' and '''Price with TAX''' are displayed in a currency the invoice was generated with. It will not be changed according to system settings. 
The '''Exchange rate''' at the invoice generation moment is also saved in the database and displayed in Invoice Edit page. 
'''Period Start''' and '''Period End''' dates are not affected by time zones: only '''Issue Date''', '''Date Due''' and '''Status changed at''' changes according to the [[GUI_time_zone | time zone]] of the system. 
 
Also you are able to refresh Client Details and regenerate xlsx file by pressing '''RECALCULATE''' in particular Invoice edit.
 

==Invoice Details==

You can find this page by clicking '''Invoice details''' link in the Invoice Edit page.

In the Invoice Lines page there is information about destinations, rates assigned to those destinations, calls made to the destinations, total time per destination and price for all the calls made to the specific destination.

This page can be accessed from Invoice edit page. 

In this page you can search by destination prefix. For example: enter ''35567'' and ''Albania mobile'' destination will be displayed.

Search can also be made with wildcard %. If you enter ''35%'', ''%67'', ''3%7'' or ''%56%'', ''Albania mobile'' will also be displayed.
 

==Billing Period==

User can have 3 different Billing Periods: 

* Weekly - every week for Monday - Sunday
* Bi-weekly - twice a month for 1 - 15 and 16 - end of month
* Monthly - every month for 1 - end of month

If you change User's Billing Period, old Invoices will be generated automatically. To disable this feature, you may set variable ''skip_missing_invoices = 1'' in ''/etc/m2/system.conf''. This way only new Invoices will be generated and missing/deleted Invoices will not be re-generated automatically.

==Invoice recalculate==

Invoices can be recalculated in Invoice list by selecting check boxes for each Invoice individually and then pressing "Recalculate selected" button or by pressing "Recalculate" button in specific Invoice edit page.

==Send selected==

Invoices can be sent to User manually by selecting check boxes in Invoice list for each Invoice individually and then pressing "Send selected" button. Invoices are being sent once in 10 minutes. By default Invoices are will be sent in XLSX format. If '''Send XLSX Invoices converted to PDF:''' option is enabled in '''Maintenance->Settings''', Invoices will be converted to PDF and sent as PDF files.

=User Invoices=
Invoices can be viewed by Users and exported in XLSX or PDF format
 
[[File:Fine results.png]]
 
By pressing on DETAILS User will be redirected to Invoice Details page
 
[[File:M2_invoice_edit_2.png]]
 

= Manual Invoices generation =
Invoices can be generated manually in Invoices list.
 
[[File:Invoice generation.png]]

=Invoice cannot be generated error=

Invoices will be generated only if Elasticsearch data is up to date and consistent with MySQL data. This is usually seen in MOR main page ES Sync Status:

 [[Image:ES_SYNC_100%.png]] 

If there are data inconsistencies between Elasticsearch and MySQL, you will see a notification '''Invoice cannot be generated due to data inconsistencies, please contact support''' and Invoice will not be generated. This is done to prevent generating incorrect Invoices. Please contact support if you get this message or you may solve it manually by following this [http://wiki.kolmisoft.com/index.php/No_data_in_Statistics_pages guide].

= XLSX Invoices =

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
 
===Default XLSX template===

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in MAINTENANCE -> Settings''', INVOICES setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
 
===Configuration for Dynamic information===

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''MAINTENANCE -> Settings''' page. Just need to define cell address in correct format.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 
'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.
 
===XLSX invoice files without Currency names ===

In some cases when you want to add additional mathematical formulas in XLSX file, you will need invoice prices without Currency names. In this case you should use setting '''Do not show currencies in XLSX Invoices''' in
'''MAINTENANCE -> Settings'''.

 
[[File:Invoice setting.png]]
 

'''Converting to PDF format'''

It is possible to convert XLSX invoice to PDF format using the following methods:

* By clicking on DOWNLOAD PDF in Invpoice Details page.
* If '''Send XLSX Invoices converted to PDF''' option is enabled, sending invoices over email will convert XLSX files to PDF.
 
[[File:M2_Send_XLSX_as_PDF.png]]

M4 Customer Invoices

2017-10-20T10:42:27Z

Zilvinas: /* XLSX Invoices */

File:M2 Send XLSX as PDF.png

2017-10-20T10:42:12Z

Zilvinas:

File:Fine results.png

2017-10-20T10:35:34Z

Zilvinas: uploaded a new version of "File:Fine results.png"

M4 Customer Invoices

2017-10-16T10:36:43Z

Zilvinas: /* Interconnection between invoice generation and Elastic Search Sync Status (ES) */

= Description =

M2 '''Customer Invoice''' is dedicated for final User of M2, who have to pay for made Calls. Admin can see and manage them in '''ACCOUNTING –> Customer Invoices''', User can reach list of his Invoices and check them from main menu. Despite your settings all values in Invoices are rounded into two digits after comma. 
Invoices are generated automatically according to User's Billing Period (weekly, bi-weekly or monthly).
==Invoices List==

Invoices can be viewed, created (WIP) or exported to XLSX file in '''ACCOUNTING –> Customer Invoices'''. In the main window, you can see list of all the Invoices.

All Prices are displayed in particular Invoice Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for invoice A exchange rate will be from that day when invoice was generated (0.5). 

Same calculations with other currencies 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for invoice B exchange rate will be from that day when invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for invoice C exchange rate will be from that day when invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 
==Invoice Edit==

Invoice edit is accessed from invoices list.

Here you are able to see some information of the user and Invoice displayed and also some details of the Invoice can be edited.

'''Price''' and '''Price with TAX''' are displayed in a currency the invoice was generated with. It will not be changed according to system settings. 
The '''Exchange rate''' at the invoice generation moment is also saved in the database and displayed in Invoice Edit page. 
'''Period Start''' and '''Period End''' dates are not affected by time zones: only '''Issue Date''', '''Date Due''' and '''Status changed at''' changes according to the [[GUI_time_zone | time zone]] of the system. 
 
Also you are able to refresh Client Details and regenerate xlsx file by pressing '''RECALCULATE''' in particular Invoice edit.
 

==Invoice Details==

You can find this page by clicking '''Invoice details''' link in the Invoice Edit page.

In the Invoice Lines page there is information about destinations, rates assigned to those destinations, calls made to the destinations, total time per destination and price for all the calls made to the specific destination.

This page can be accessed from Invoice edit page. 

In this page you can search by destination prefix. For example: enter ''35567'' and ''Albania mobile'' destination will be displayed.

Search can also be made with wildcard %. If you enter ''35%'', ''%67'', ''3%7'' or ''%56%'', ''Albania mobile'' will also be displayed.
 

==Billing Period==

User can have 3 different Billing Periods: 

* Weekly - every week for Monday - Sunday
* Bi-weekly - twice a month for 1 - 15 and 16 - end of month
* Monthly - every month for 1 - end of month

If you change User's Billing Period, old Invoices will be generated automatically. To disable this feature, you may set variable ''skip_missing_invoices = 1'' in ''/etc/m2/system.conf''. This way only new Invoices will be generated and missing/deleted Invoices will not be re-generated automatically.

==Invoice recalculate==

Invoices can be recalculated in Invoice list by selecting check boxes for each Invoice individually and then pressing "Recalculate selected" button or by pressing "Recalculate" button in specific Invoice edit page.

==Send selected==

Invoices can be sent to User manually by selecting check boxes in Invoice list for each Invoice individually and then pressing "Send selected" button. Invoices are being sent once in 10 minutes.

=User Invoices=
Invoices can be viewed by Users and exported in XLSX format
 
[[File:Fine results.png]]
 
By pressing on DETAILS User will be redirected to Invoice Details page
 
[[File:M2_invoice_edit_2.png]]
 

= Manual Invoices generation =
Invoices can be generated manually in Invoices list.
 
[[File:Invoice generation.png]]

=Interconnection between Invoice generation and ElasticSearch Sync Status (ES)=

Invoices will be generated if ES Sync Status is 100%.

 
[[Image:ES_SYNC_100%.png]]
 

In other cases, you will see notification: '''"Invoice cannot be generated due to data inconsistencies, please contact support"'''.

While Invoice is being generated, system will check if ES Call quantity is the same as in MySQL. Because of Timezone differenece, system will consider the period for which Invoices are generated +2 days from start time and end time.
 
For example:

* User is generating invoice at 2017-10-12 '''10:00:00''';
* User is generating invoice for 2017-10-11 00:00:00 - 2017-10-11 23:59:59;
* System will check call quantity from 2017-10-09 00:00:00 - 2017-10-12 '''09:00:00'''.

= XLSX Invoices =

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
 
===Default XLSX template===

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in MAINTENANCE -> Settings''', INVOICES setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
 
===Configuration for Dynamic information===

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''MAINTENANCE -> Settings''' page. Just need to define cell address in correct format.

For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 
'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.
 
===XLSX invoice files without Currency names ===

In some cases when you want to add additional mathematical formulas in XLSX file, you will need invoice prices without Currency names. In this case you should use setting '''Do not show currencies in XLSX Invoices''' in
'''MAINTENANCE -> Settings'''.

 
[[File:Invoice setting.png]]

Invoices

2017-10-16T10:35:25Z

Zilvinas: /* Interconnection between invoice generation and Elastic Search Sync Status (ES) */

= Description =

An invoice, bill or tab is a commercial document issued by a seller to a buyer, relating to a sale transaction and indicating the products, quantities, and agreed prices for products or services the seller had provided the buyer.
 
= Configuration =

You can manage Invoices settings, details, Address information and functionality in the Invoices section of the [[Configuration_from_GUI#Invoices | SETTINGS -> Setup -> Settings]] window. 
If you want show user_billsec instead of billsec in Users invoices and last calls, go to [[Configuration_from_GUI#Visual | Settings –> Various]] and check ''Show user_billsec for Users instead of billsec''
 

Go to User's edit page to enable or disable types of invoices he can see in his invoices details. And also these selected types will be the ones that are sent to user via email.

[[File:Invoice types.png]]

=Invoices list=

Invoices can be viewed, generated, recalculated, sent, also  list of Invoices can be exported to CSV file (Invoice number and TAX Registration Number are included in the output CSV file) in '''SETTINGS –> Accounting –> Invoices'''. In the main window, you can see list of all Invoices:
 
[[Image:Invoice list small.png]]
 
The icons [[Image:icon_check.png]] and [[Image:icon_cross.png]] show whether this invoice is Paid or Unpaid, Sent or Not Sent.
 
'''NOTE''' Each Invoice generated in particular Time Zone and on particular Currency. That means that in each line of Invoice Price and Price with TAX will be shown in currency which is written in Currency column. The Currency column tells which currency Invoice was generated with. Also the exchange rate at the invoice generation moment is saved in the database so it may differ from the up to date exchange rate.
 
Total Price and Price with TAX are calculated into viewing Currency, which you can choose in upper corner of page. In Total price calculation there are used saved exchange Rate of each Invoice.
 
'''Example'''
 
Default system Currency is USD
 
Invoice A is generated on price = 100 in currency EUR with exchange rate 0.5 
Invoice B is generated on price = 100 in currency DZD with exchange rate 0.25 
Invoice C is generated on price = 100 in currency ALL with exchange rate 0.75 
 
But now exchange rate are different: EUR - 0.75, DZD - 0.5 and ALL - 1.0. 
 
If you want to see Total price(sum of these 3 Invoices) in EUR. For Invoice B and C will be set exchange rate of today, but for Invoice A exchange rate will be from that day when Invoice was generated (0.5). 

Same calculations with other currencies: 
If you want to see Total price in USD. For Invoice A, B and C the exchange rates will be set from the day when invoice was generated (EUR - 0.5, DZD - 0.25 and ALL - 0.75). 
If you want to see Total price in DZD. For Invoice A and C will be set exchange rate of today, but for Invoice B exchange rate will be from the day when Invoice was generated (0.25). 
If you want to see Total price in ALL. For Invoice A and B will be set exchange rate of today, but for Invoice C exchange rate will be from the day when Invoice was generated (0.75). 
 
Total price will be 733.3333 USD, or 500 EUR, or 266.6667 DZD, or 700 ALL 
 

=Invoice details=

Click on the [[Image:icon_details.png]] icon to get details of the Invoice:
 
[[Image:invoice_details_x6.png]]
 
Invoice details are shown in Currency which was used to generate Invoice.
 
==General Details==

'''Payment date''' - An option which will set the period of payment on current month. By default ''Years'' and ''Month'' is current, it is only possible to change ''Day of Month'' which is indicating the last date of ''Invoice'' issue. 
'''Currecy of Invoice''' -  Invoices are exported in Invoice currency.

'''Language of Invoice'''
 
Default language in MOR is English. However, you can send invoices in different languages (click on the flag icon on the top of the page).
 

==User Details==

User Details which will be used in xlsx file of invoice. These Details are taken form [[User Details]] and it can be changed manually, but after recalculate it will be reset to same information as it is in [[User Details]].
 
==Files to send or download==

Here you can view the details of all invoices and click on the [[Image:icon_pdf.png]] or [[Image:icon_csv.png]] icons to generate invoice files in PDF or CSV formats accordingly. First icon [[Image:icon_csv.png]] will download a xlsx file.

*'''Invoice XLSX''' xlsx file shows information which are set by you. Check [[Invoices#XLSX_Invoices | XLSX Invoice]]
*'''Simplified Invoice''' PDF shows separate services Prices and Total Invoice Prices, CSV shows just Total Invoice Prices.
*'''Detailed Invoice''' shows same information like simple Invoice and includes Calls list grouped by Destination.
*'''Invoice by CallerID''' shows Calls list grouped by CallerID.
*'''Invoice Destinations''' shows Calls list grouped by Destination.

You can manage what kind of Invoice should be showed for User and/or sent to User as email attachment in [[User_Details#Invoices |User Details]]. Here you can check ''Show zero Calls'' option if you need to calculate 0 price Calls into Invoices.
 
=== XLSX Invoices ===

XLSX file to export an Invoice is made from your own XLSX format template and information from Invoices main window.
Example of template can be downloaded [http://www.kolmisoft.com/packets/x6_invoice_template.xlsx here].
 
Example of XLSX Invoice can be downloaded [http://wiki.kolmisoft.com/images/9/93/Invoice_example_for_wiki.xls here].
 
'''Default XLSX template'''

Create a xlsx file. Template you can prepare as you wish, you can fill it with information of company, draw tables with column names, describe information taken from Invoice main window and so on. Template '''have to be uploaded in SETTINGS -> Setup -> Settings''', Invoices - XLSX tab setting '''XSLX Template'''
* Check '''New XLSX template apply for old Invoices''' if you want to change XLSX template for Invoices which is already generated.
* Check '''Group regular Calls by Destinations''' if you want XLSX file use as detailed Invoice.
 
'''Balance Line settings'''

''Outstanding balance (Debt)'', ''Outstanding balance (Debt) with TAX'', ''Total amount due'' options are present when ''Show balance line'' ('''SETTINGS -> Setup -> Settings''', Invoices - Postpaid - Settings) setting is enabled.
 
'''Configuration for Dynamic information'''

When you already have a template for example with all data of your company, with drawn tables and so on, you need to define where should be shown the dynamic information of invoice. How and what information is displayed can be set same '''SETTINGS -> Setup -> Settings''', Invoices - XLSX tab. Just need to define cell address in correct format.
 
[[File:Setttings xlsx.png]]
 
For example "A2", "B15", "AA9"
 
[[File:callc.png]]
 

'''NOTE''': If you do not want to use particular dynamic value just leave empty input for it.

=== PDF invoices ===

The layout of PDF invoices is not customizable.

Logos are not supported in PDF invoices.

You can print your invoices on paper with a pre-printed logo if you want to send paper invoices.

Example of PDF invoice can be downloaded by clicking [http://wiki.kolmisoft.com/images/a/a0/Example-Invoice-for-wiki.pdf here] and for detailed invoice click [http://wiki.kolmisoft.com/images/e/e1/Example-Detailed-Invoice-for-wiki.pdf here].
 

=== CSV invoices ===

Detailed CSV invoice does not include list of all calls. Please use [[How_to_export_CDRs|CDR export]] if you need list of calls in CSV format.
 

==Comment==
 

Sometimes it is useful to add a comment to the invoice. It can be used in xlsx file also.
 
==Invoice Details==
Click on the Invoice Details icon in the Invoice details page
 
[[Image:Service_details.png]]
 
to get Services Details of the Invoice:
 
[[Image:invoice_services_x6.png]]
 
'''Services:'''
 
* '''SMS''' – quantity and price of SMS sent in selected period. Invoice for Reseller counts all SMS that was sent by his users using price for Reseller. Note, that SMS are included to Invoice only when [[SMS Addon]] is used
* '''DID Owner Cost''' – price for having and using own DID(s)
* '''Subscriptions''' – price of subscription applied to selected period. Period considered as month is from first till last day of month and from concrete day of month till next month one day before selected last month. Eg. from 2013-02-26 till 2013-03-25
* '''Calls''' – quantity and price of outgoing calls
* '''Calls from Users''' – quantity and price of resellers users calls
* '''Calls to DIDs''' – price for calling to DID(s)
 

= Invoice generation =

In the main Invoices window, click [[Image:icon_generate_invoices.png]] '''Generate Invoices''' to generate additional invoices:
 
[[Image:generate_invoices_x6.png]]
 
Select for which users to generate invoices. Prepaid and Postpaid users can have separate details. Also, you can check to generate an invoice for only one particular user. Invoice will be generated if selected User existed at least one day of all Invoice period. When Invoice Generation Task is created, admin can check the progress in [[Background Tasks]].

'''NOTE:''' For Prepaid User after every executed Manual Payment will be generated Invoice automatically. 

'''NOTE:''' If Currency of User is different than default System Currency. All his Invoices will be generated with [[Currencies| Currency]] Exchange Rate of current day. 
'''NOTE:''' When generating invoice, current user details will be used. 
 

=Interconnection between Invoice generation and ElasticSearch Sync Status (ES)=

Invoices will be generated if ES Sync Status is 100%.

 
[[Image:ES_SYNC_100%.png]]
 

In other cases, you will see a notification: '''"Invoice cannot be generated due to data inconsistencies, please contact support"'''.

While Invoice is being generated, system will check if ES Call quantity is the same as in MySQL. Because of Timezone differenece, system will consider the period for which Invoices are generated +2 days from start time and end time.
 
For example:
* User is generating Invoice at 2017-10-12 '''10:00:00''';
* User is generating Invoice for 2017-10-11 00:00:00 - 2017-10-11 23:59:59;
* System will check Call quantity from 2017-10-09 00:00:00 till 2017-10-12 '''09:00:00'''.

= Invoice recalculation =

An invoice cannot be modified after being sent. But if you want to allow recalculations after sending invoices, go to: '''Settings -> Setup -> Settings'''. Then click on the tabs: '''Invoices -> Functionality'''. Select ''Invoice allow recalculate after send'':
 
[[Image:ivoicesnewnew.png]]
 
===Recalculate a group of Invoices===

To recalculate invoices in the main Invoices window click [[Image:icon_generate_invoices.png]] '''Recalculate invoices''':
 
[[Image:recalc.png]]
 
Select which type of Invoices or whose Invoices to recalculate.
 
=== Recalculate a single Invoice ===

If an invoice is not marked as paid - it can be recalculated for the same user, same period. To achieve this - press the marked icon:
 
[[File:Recalculate_single_invoice_x6.png]]
 

= Pay unpaid Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Pay unpaid Invoices''' will appear.
 
[[File:Pay_unpaid_invocies.png]]
 
Click '''Pay unpaid Invoices''' and '''All''' unpaid Invoices will be marked as paid. For each marked Invoice Payment will be created.
 

= Delete all Invoices =

In list of Invoices click [[Image:icon_edit.png]]'''Bulk management''' and button '''Delete all invoices''' will appear.
 
[[File:Delete_all_invoices.png]]
 
Click '''Delete all invoices''' and '''all listed Invoices in all pages''' will be deleted (with respect to search filter).
 
'''Note:''' Invoices, which were already sent, are possible to delete only with option enabled in: Invoices->Functionality-> Invoice allow recalculate after send.
 

= Send invoices by email (manual) =

Click '''Send Invoices over Email to Users''' to send invoices to their Users in this period:
 
[[Image:Invoce email.png]]
 
You can use these settings to choose which users should get an email with the invoice. Using these settings you can send emails in parts.
 
* '''Email sending''' option must be enabled in Email Settings to use this feature
* Tip: you can '''send invoices in parts''' by using text fields to send invoices for users which '''Username, First name, Last name''' or '''Number''' begins with some letters. For example: you have users with usernames john, albert and alex. You want to send invoices only for users whose usernames begins with '''"a"''' so you just have to enter '''"a"''' in a '''Username text field''' to send invoices only to albert and alex.

 

= Generate and send invoices by email (automatically) =

Use [http://wiki.kolmisoft.com/index.php/Cron_actions#Generate_Invoices_and_send_by_Email Cron Actions] to Generate and send Emails automatically.

 

= Export all to XLSX =

In Invoices list you can click on '''Export all to XLSX''' link to download all Invoices' XLSX files in a single ZIP. It includes all Invoices matching your search.

 

=See also=

* [[Accounting]]
* [[Invoice configuration]]
* [[Pay Invoice with balance deduction]]
* [[Outstanding balance(Debt)]]
* [[Invoice by CallerID]]
* [[MOR API invoices_get]]
* [[Cannot generate Invoice]]
* [[Duplicate value in Cell Address field]]

Auto-Dialer Addon

2017-10-10T10:17:25Z

Zilvinas: /* Limitations */

=Description=

Auto-Dialer addon lets you call an array of [[Auto-Dialer_Addon#Numbers | numbers]] automatically. When call is answered, receiver hears the audio message or he is in standby mode, it depends on what is set in Auto Dialer [[Auto-Dialer_Addon#Actions | actions]] (PLAY / IVR / WAIT).
This functionality can be used in telemarketing.
 
=Usage=

When Auto-Dialer (AD) is installed, every user can use it and '''only users can create Campaigns. Admin cannot create Campaings.'''

==From User==

The user can find the AD menu under '''PERSONAL MENU -> Various -> Auto Dialer'''.

The main window shows the user's campaigns:
 
[[Image:ad1.png]]
 
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.

A Campaign can only be '''Activated''' if it has free (not-called) numbers AND some Actions.

So please, before activating a Campaign, import some Numbers and create Actions.

'''NOTE:''' Auto Dialer starts in 5 minutes, so when you are starting this add-on, you need to wait 5 minutes before it starts.
 
===Campaigns===

Auto-Dialer can be found under '''PERSONAL MENU -> Various -> Auto Dialer'''.

[[Image:icon_add.png]] '''Add new campaign''' allows you to add a new campaign:
 
[[Image:autodialer1.png]]
 
The important fields here are:

* '''Start/Stop Times''' – when calls will be made.
* '''Max Retries''' – how many times to retry an unsuccessful call.
* '''Retry Time''' – how many seconds the system should wait to retry the call.
* '''Wait Time''' – how long to wait till the call is answered. This field by default is 10 and cannot be made less. This is done in order to
prevent annoying multiple calls from Auto Dialer to the end user if for example "Wait Time" is configured as 5 seconds.
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.
* '''CallerID''' - what CallerID to put on calls.
* '''Allow duplicate numbers''' - when checked allows duplicate number import into the Auto-Dialer Campaign.
 

=== Numbers ===

Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:
 
[[Image:autodialer2.png]]
 
The user can import phone numbers from a TXT file. Numbers should be in correct dialing format.

Example of numbers file:

442012345678
442087654321
442054987123

In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:
 
[[Image:autodialer3.png]]
 
After uploading the file, you will see status of imported numbers:
 
[[Image:autodialer4.png]]
 
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''

If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.
 

=== Actions ===

Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:
 
[[Image:autodialer5.png]]
 
In this window, the user programs the Actions for the Campaign:

Types of Actions:

* '''WAIT''' – how many seconds to wait.
* '''PLAY''' – play a file.
* '''IVR''' - send call to IVR. It can be used to connect to a real person and give the callee a greater choice. For example, it is possible to play an advertisement and tell the user to press '1' to talk with a real person about this advertisement or similar.
** NOTE: admin or [[Reseller_Pro_Addon|Reseller PRO]] must check option "All users can use it" on IVR to allow users to set that IVR on AD campaign.
 

===Redial all failed Calls===

You can redial all failed calls:
 
[[File:Autodialer_redial_all_failed_calls.png]]
 

===Autodialer Campaign statistics===
To view the Autodialer Campaign statistics, click on the bar chart icon in the '''Stats''' column.
 
[[File:Autodialer_Stats_icon.png]]
 
On the newly opened page you will be able to see the desired Autodialer Campaign statistics with a search filter and a visual representation of data.
 
[[File:Autodialer_Stats_User.png]]
 

==From Admin==

When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:
 
[[Image:autodialer6.png]]
 
The important information for each Campaign is:

* Status – is the Campaign Active or Stopped?
* Run time – tells when calls will be made.

All other fields are self-explanatory.

It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign.
 

=Workflow=

Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.

If there are some active campaigns, the script creates call files for the future.

It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.

For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.

Variables in '''/etc/mor/system.conf''':

'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).

'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.

'''ad_disabled''' - when set to 1, disables Auto-Dialer functionality on a Server. '''Note:''' in multi-Asterisk systems all Asterisks but one must have this setting set to 1. This neeeds to be done in order to prevent duplicate calls.

Example #1:

calls_one_time = 10
cron_interval = 1

That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:

1st call: 0s
2nd call: 6s
3rd call: 12s
....
9th call: 54s
10th call: 60s

Example #2:

calls_one_time = 5
cron_interval = 2

That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:

1st call: 0s
2nd call: 12s
3rd call: 24s
4rd call: 36s
5th call: 48s
6th call: 60s
7th call: 72s
8th call: 84s
9th call: 96s
10th call: 108s
 

=Limitations=

Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk

server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign in all servers. If you want it to

run only on one server you need to disable the Auto-Dialer functionality with the setting in '''/etc/mor/system.conf''':
ad_disabled = 1
 

=Logs=

Autodialer log can be found here:
/var/log/mor/mor_ad_cron.log
 
= Problems =

* [[MOR Server Speedup]] (to get more calls by AD)
* [[I have a problem with Auto Dialer]]
 
=See also=

* [[Autodialer poll example]]
* [[Convert WAV file to Asterisk playable format]] 
* [[Sound files]]

Auto-Dialer Addon

2017-10-10T10:12:42Z

Zilvinas: /* Workflow */

=Description=

Auto-Dialer addon lets you call an array of [[Auto-Dialer_Addon#Numbers | numbers]] automatically. When call is answered, receiver hears the audio message or he is in standby mode, it depends on what is set in Auto Dialer [[Auto-Dialer_Addon#Actions | actions]] (PLAY / IVR / WAIT).
This functionality can be used in telemarketing.
 
=Usage=

When Auto-Dialer (AD) is installed, every user can use it and '''only users can create Campaigns. Admin cannot create Campaings.'''

==From User==

The user can find the AD menu under '''PERSONAL MENU -> Various -> Auto Dialer'''.

The main window shows the user's campaigns:
 
[[Image:ad1.png]]
 
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.

A Campaign can only be '''Activated''' if it has free (not-called) numbers AND some Actions.

So please, before activating a Campaign, import some Numbers and create Actions.

'''NOTE:''' Auto Dialer starts in 5 minutes, so when you are starting this add-on, you need to wait 5 minutes before it starts.
 
===Campaigns===

Auto-Dialer can be found under '''PERSONAL MENU -> Various -> Auto Dialer'''.

[[Image:icon_add.png]] '''Add new campaign''' allows you to add a new campaign:
 
[[Image:autodialer1.png]]
 
The important fields here are:

* '''Start/Stop Times''' – when calls will be made.
* '''Max Retries''' – how many times to retry an unsuccessful call.
* '''Retry Time''' – how many seconds the system should wait to retry the call.
* '''Wait Time''' – how long to wait till the call is answered. This field by default is 10 and cannot be made less. This is done in order to
prevent annoying multiple calls from Auto Dialer to the end user if for example "Wait Time" is configured as 5 seconds.
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.
* '''CallerID''' - what CallerID to put on calls.
* '''Allow duplicate numbers''' - when checked allows duplicate number import into the Auto-Dialer Campaign.
 

=== Numbers ===

Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:
 
[[Image:autodialer2.png]]
 
The user can import phone numbers from a TXT file. Numbers should be in correct dialing format.

Example of numbers file:

442012345678
442087654321
442054987123

In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:
 
[[Image:autodialer3.png]]
 
After uploading the file, you will see status of imported numbers:
 
[[Image:autodialer4.png]]
 
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''

If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.
 

=== Actions ===

Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:
 
[[Image:autodialer5.png]]
 
In this window, the user programs the Actions for the Campaign:

Types of Actions:

* '''WAIT''' – how many seconds to wait.
* '''PLAY''' – play a file.
* '''IVR''' - send call to IVR. It can be used to connect to a real person and give the callee a greater choice. For example, it is possible to play an advertisement and tell the user to press '1' to talk with a real person about this advertisement or similar.
** NOTE: admin or [[Reseller_Pro_Addon|Reseller PRO]] must check option "All users can use it" on IVR to allow users to set that IVR on AD campaign.
 

===Redial all failed Calls===

You can redial all failed calls:
 
[[File:Autodialer_redial_all_failed_calls.png]]
 

===Autodialer Campaign statistics===
To view the Autodialer Campaign statistics, click on the bar chart icon in the '''Stats''' column.
 
[[File:Autodialer_Stats_icon.png]]
 
On the newly opened page you will be able to see the desired Autodialer Campaign statistics with a search filter and a visual representation of data.
 
[[File:Autodialer_Stats_User.png]]
 

==From Admin==

When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:
 
[[Image:autodialer6.png]]
 
The important information for each Campaign is:

* Status – is the Campaign Active or Stopped?
* Run time – tells when calls will be made.

All other fields are self-explanatory.

It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign.
 

=Workflow=

Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.

If there are some active campaigns, the script creates call files for the future.

It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.

For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.

Variables in '''/etc/mor/system.conf''':

'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).

'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.

'''ad_disabled''' - when set to 1, disables Auto-Dialer functionality on a Server. '''Note:''' in multi-Asterisk systems all Asterisks but one must have this setting set to 1. This neeeds to be done in order to prevent duplicate calls.

Example #1:

calls_one_time = 10
cron_interval = 1

That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:

1st call: 0s
2nd call: 6s
3rd call: 12s
....
9th call: 54s
10th call: 60s

Example #2:

calls_one_time = 5
cron_interval = 2

That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:

1st call: 0s
2nd call: 12s
3rd call: 24s
4rd call: 36s
5th call: 48s
6th call: 60s
7th call: 72s
8th call: 84s
9th call: 96s
10th call: 108s
 

=Limitations=

Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk

server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign on both servers, if you want it to

run only on one server you need to just disable the cron job on one of the servers.
Cron can be found in
/etc/cron.d/mor_ad
 
=Logs=

Autodialer log can be found here:
/var/log/mor/mor_ad_cron.log
 
= Problems =

* [[MOR Server Speedup]] (to get more calls by AD)
* [[I have a problem with Auto Dialer]]
 
=See also=

* [[Autodialer poll example]]
* [[Convert WAV file to Asterisk playable format]] 
* [[Sound files]]

Auto-Dialer Addon

2017-10-10T08:26:29Z

Zilvinas: /* Workflow */

=Description=

Auto-Dialer addon lets you call an array of [[Auto-Dialer_Addon#Numbers | numbers]] automatically. When call is answered, receiver hears the audio message or he is in standby mode, it depends on what is set in Auto Dialer [[Auto-Dialer_Addon#Actions | actions]] (PLAY / IVR / WAIT).
This functionality can be used in telemarketing.
 
=Usage=

When Auto-Dialer (AD) is installed, every user can use it and '''only users can create Campaigns. Admin cannot create Campaings.'''

==From User==

The user can find the AD menu under '''PERSONAL MENU -> Various -> Auto Dialer'''.

The main window shows the user's campaigns:
 
[[Image:ad1.png]]
 
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.

A Campaign can only be '''Activated''' if it has free (not-called) numbers AND some Actions.

So please, before activating a Campaign, import some Numbers and create Actions.

'''NOTE:''' Auto Dialer starts in 5 minutes, so when you are starting this add-on, you need to wait 5 minutes before it starts.
 
===Campaigns===

Auto-Dialer can be found under '''PERSONAL MENU -> Various -> Auto Dialer'''.

[[Image:icon_add.png]] '''Add new campaign''' allows you to add a new campaign:
 
[[Image:autodialer1.png]]
 
The important fields here are:

* '''Start/Stop Times''' – when calls will be made.
* '''Max Retries''' – how many times to retry an unsuccessful call.
* '''Retry Time''' – how many seconds the system should wait to retry the call.
* '''Wait Time''' – how long to wait till the call is answered. This field by default is 10 and cannot be made less. This is done in order to
prevent annoying multiple calls from Auto Dialer to the end user if for example "Wait Time" is configured as 5 seconds.
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.
* '''CallerID''' - what CallerID to put on calls.
* '''Allow duplicate numbers''' - when checked allows duplicate number import into the Auto-Dialer Campaign.
 

=== Numbers ===

Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:
 
[[Image:autodialer2.png]]
 
The user can import phone numbers from a TXT file. Numbers should be in correct dialing format.

Example of numbers file:

442012345678
442087654321
442054987123

In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:
 
[[Image:autodialer3.png]]
 
After uploading the file, you will see status of imported numbers:
 
[[Image:autodialer4.png]]
 
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''

If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.
 

=== Actions ===

Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:
 
[[Image:autodialer5.png]]
 
In this window, the user programs the Actions for the Campaign:

Types of Actions:

* '''WAIT''' – how many seconds to wait.
* '''PLAY''' – play a file.
* '''IVR''' - send call to IVR. It can be used to connect to a real person and give the callee a greater choice. For example, it is possible to play an advertisement and tell the user to press '1' to talk with a real person about this advertisement or similar.
** NOTE: admin or [[Reseller_Pro_Addon|Reseller PRO]] must check option "All users can use it" on IVR to allow users to set that IVR on AD campaign.
 

===Redial all failed Calls===

You can redial all failed calls:
 
[[File:Autodialer_redial_all_failed_calls.png]]
 

===Autodialer Campaign statistics===
To view the Autodialer Campaign statistics, click on the bar chart icon in the '''Stats''' column.
 
[[File:Autodialer_Stats_icon.png]]
 
On the newly opened page you will be able to see the desired Autodialer Campaign statistics with a search filter and a visual representation of data.
 
[[File:Autodialer_Stats_User.png]]
 

==From Admin==

When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:
 
[[Image:autodialer6.png]]
 
The important information for each Campaign is:

* Status – is the Campaign Active or Stopped?
* Run time – tells when calls will be made.

All other fields are self-explanatory.

It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign.
 

=Workflow=

Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.

If there are some active campaigns, the script creates call files for the future.

It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.

For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.

Variables in '''/etc/mor/system.conf''':

'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).

'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.

'''ad_disabled''' - when set to 1, disables Auto-Dialer functionality on a Server.

Example #1:

calls_one_time = 10
cron_interval = 1

That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:

1st call: 0s
2nd call: 6s
3rd call: 12s
....
9th call: 54s
10th call: 60s

Example #2:

calls_one_time = 5
cron_interval = 2

That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:

1st call: 0s
2nd call: 12s
3rd call: 24s
4rd call: 36s
5th call: 48s
6th call: 60s
7th call: 72s
8th call: 84s
9th call: 96s
10th call: 108s
 

=Limitations=

Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk

server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign on both servers, if you want it to

run only on one server you need to just disable the cron job on one of the servers.
Cron can be found in
/etc/cron.d/mor_ad
 
=Logs=

Autodialer log can be found here:
/var/log/mor/mor_ad_cron.log
 
= Problems =

* [[MOR Server Speedup]] (to get more calls by AD)
* [[I have a problem with Auto Dialer]]
 
=See also=

* [[Autodialer poll example]]
* [[Convert WAV file to Asterisk playable format]] 
* [[Sound files]]

MySQL Replication

2017-10-03T05:42:18Z

Zilvinas: /* Troubleshooting */

<big><big>MySQL Replication works only on servers where MySQL 5.x is installed</big></big>
[[Image:mysql_logo.png|right]]
 

'''THIS TUTORIAL WILL GUIDE YOU THROUGH HOW TO IMPLEMENT MASTER<->MASTER REPLICATION'''

'''Before you start, make a backup of your database.'''

 
==Create user on Server 1==

* Username: rep2
* Password: rep2
* Host: 222.222.222.222
* Grant all privileges to this user (on database mor)

Login as root and issue such commands:

CREATE USER 'rep2'@''''222.222.222.222'''' IDENTIFIED BY 'rep2';

GRANT REPLICATION SLAVE , REPLICATION CLIENT ON *.* TO 'rep2'@''''222.222.222.222'''' IDENTIFIED BY 'rep2' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;

GRANT ALL PRIVILEGES ON *.* TO 'rep2'@''''222.222.222.222'''' WITH GRANT OPTION ;

Go to Server 2 and test the connection:

mysql -h 111.111.111.111 -u rep2 -prep2

 

==Create user on Server 2==

* Username: rep1
* Password: rep1
* Host: 111.111.111.111
* Grant all privileges to this user (on database mor)

Login as root and issue such commands:

CREATE USER 'rep1'@''''111.111.111.111'''' IDENTIFIED BY 'rep1';

GRANT REPLICATION SLAVE , REPLICATION CLIENT ON *.* TO 'rep1'@''''111.111.111.111'''' IDENTIFIED BY 'rep1' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;

GRANT ALL PRIVILEGES ON *.* TO 'rep1'@''''111.111.111.111'''' WITH GRANT OPTION ;

Go to Server 1 and test the connection:

mysql -h 222.222.222.222 -u rep1 -prep1

''' Note: Make sure you have applied REPLICATION CLIENT and REPLICATION SLAVE on both users. '''

 

==Server 1 my.cnf==

[mysqld]
innodb_file_per_table=1
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
#old_passwords=1

bind-address = 0.0.0.0

binlog-do-db = mor
# binlog-do-db = mor_mnp #uncomment if there is mor_mnp database
# binlog-do-db = opensips #uncomment if there is opensips database
server-id = 10
auto_increment_increment = 10
auto_increment_offset = 1
replicate-do-db = mor
# replicate-do-db = mor_mnp #uncomment if there is mon_mnp database
# replicate-do-db = opensips #uncomment if there is opensips database
binlog_format=MIXED
log-bin = /var/lib/mysql/mysql-bin.log
log-bin-index = /var/lib/mysql/master-log-bin.index
# sync_binlog = 1 #increases reliability, but decreases performance
relay-log = /var/lib/mysql/slave-relay.log
relay-log-index = /var/lib/mysql/slave-relay-log.index

slave-skip-errors=1061,1062,1213,1060
slave_transaction_retries=3600

expire_logs_days = 3
# '''innodb_flush_log_at_trx_commit = 1'''
# '''innodb_support_xa'''
max_allowed_packet = 256M
key_buffer_size=256M
key_buffer=258M

innodb_buffer_pool_size = 100M

query_cache_type=1
query_cache_limit=64M
query_cache_size=64M

join_buffer_size = 2M
tmp_table_size = 512M
max_heap_table_size = 512M
thread_cache_size = 4
table_cache = 128

max_connections = 300
slave_transaction_retries = 3600

;log-slow-queries = /var/lib/mysql/slow_query.log

log-error=/var/lib/mysql/mysqld.log

[mysql.server]
user=mysql
basedir=/var/lib

[mysqld_safe]
log-error=/var/lib/mysql/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid

 
Stop services:

service elasticsearch stop
service httpd stop
service asterisk stop
service mor_server_loadstats stop
service crond stop
service mor_alerts stop
service mor_aggregates stop

==Server 2 my.cnf==

[mysqld]
innodb_file_per_table=1
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
#old_passwords=1

bind-address = 0.0.0.0

binlog-do-db = mor
# binlog-do-db = mor_mnp #uncomment if there is mon_mnp database
# binlog-do-db = opensips #uncomment if there is opensips database
server-id = 20
auto_increment_increment = 10
auto_increment_offset = 2
replicate-do-db = mor
# replicate-do-db = mor_mnp #uncomment if there is mon_mnp database
# replicate-do-db = opensips #uncomment if there is opensips database
binlog_format=MIXED
log-bin = /var/lib/mysql/mysql-bin.log
log-bin-index = /var/lib/mysql/master-log-bin.index
# sync_binlog = 1 #increases reliability, but decreases performance
relay-log = /var/lib/mysql/slave-relay.log
relay-log-index = /var/lib/mysql/slave-relay-log.index

slave-skip-errors=1061,1062,1213,1060
slave_transaction_retries=3600

expire_logs_days = 3
# '''innodb_flush_log_at_trx_commit = 1'''
# '''innodb_support_xa'''
max_allowed_packet = 256M
key_buffer_size=256M
key_buffer=258M
innodb_buffer_pool_size = 100M
query_cache_type=1
query_cache_limit=64M
query_cache_size=64M
join_buffer_size = 2M
tmp_table_size = 512M
max_heap_table_size = 512M
thread_cache_size = 4
table_cache = 128

max_connections = 300
slave_transaction_retries = 3600
;log-slow-queries = /var/lib/mysql/slow_query.log

log-error=/var/lib/mysql/mysqld.log

[mysql.server]
user=mysql
basedir=/var/lib

[mysqld_safe]
log-error=/var/lib/mysql/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid

 
Stop services:

service elasticsearch stop
service httpd stop
service asterisk stop
service mor_server_loadstats stop
service crond stop
service mor_alerts stop
service mor_aggregates stop

==Server 2==

Make sure data on Server 2 = data on Server 1. E.g. MySQL table structure and data are identical on both machines.

 
==Server 1==

/usr/src/mor/sh_scripts/configure_mycnf.sh
/etc/init.d/mysqld restart

mysql -u root -p

USE mor;
FLUSH TABLES WITH READ LOCK;
SHOW MASTER STATUS;

Remember '''File''' and '''Position'''.

UNLOCK TABLES;
quit;

 

==Server2==

Check if you can connect to first server:

mysql -h 111.111.111.111 -u rep2 -p

Proceed if okay:

/usr/src/mor/sh_scripts/configure_mycnf.sh
/etc/init.d/mysqld restart

mysql -u root -p

SLAVE STOP;

CHANGE MASTER TO MASTER_HOST='111.111.111.111', MASTER_USER='rep2', MASTER_PASSWORD='rep2', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=205;

'''NOTE: Change MASTER_HOST, MASTER_LOG_FILE and MASTER_LOG_POS accordingly.'''

START SLAVE;

USE mor;
FLUSH TABLES WITH READ LOCK;
SHOW MASTER STATUS;

Remember '''File''' and '''Position'''.

UNLOCK TABLES;
quit;

 

==Server 1==

Check if you can connect to first server:

mysql -h 222.222.222.222 -u rep1 -p

Proceed if okay:

mysql -u root -p

SLAVE STOP;

CHANGE MASTER TO MASTER_HOST='222.222.222.222', MASTER_USER='rep1', MASTER_PASSWORD='rep1', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=205;

'''NOTE: Change MASTER_HOST, MASTER_LOG_FILE and MASTER_LOG_POS accordingly.'''

START SLAVE;
quit;

 
Start services on both servers '''Server 1''' and '''Server 2''':

service elasticsearch start
service httpd start
service asterisk start
service mor_server_loadstats start
service crond start
service mor_alerts start
service mor_aggregates start

==Log files==

In order for MySQL Replication to function properly, you need to check log files in /var/lib/mysql

Open ''master-log-bin.index''. It should contain names of the files which really exist in same folder. If there's some mismatch, edit this file: enter missing names for files or delete file names which do not represent real files in this folder.

Do the same with the file ''slave-relay-log.index''.

 
==Testing==

Login to MySQL console on both servers:

mysql -u root -p

Then:

SHOW SLAVE STATUS\G

If everything is okay, you should see lines between others on both servers:

Slave_IO_State: Waiting for master to send event
Slave_IO_Running: Yes
Slave_SQL_Running: Yes

If Replication is off, you will see:

Slave_IO_State:
Slave_IO_Running: No

The quick way to do this is:

mysql -u root -e 'SHOW SLAVE STATUS\G' | grep 'Slave'

If root has psw:

mysql -u root -pPASSWORD -e 'SHOW SLAVE STATUS\G' | grep 'Slave'

 

'''Never use phpmyadmin to check if data is same on both servers. Use mysql console and a command like count. For example: SELECT COUNT(*) FROM destinations;'''

 
==Troubleshooting==

Check file: /var/lib/mysql/mysqld.log 
Check GUI production logs and look for error messages beginning with: "Replication exception:".

 
==='Could not find first log file name in binary log index file' from master when reading data from binary log===

We go to the master and check ''/var/lib/mysql/master-log-bin.index'' file.

For example, it can show:

/var/lib/mysql/mysql-bin.000001
/var/lib/mysql/mysql-bin.000002
/var/lib/mysql/mysql-bin.000003
/var/lib/mysql/mysql-bin.000005

In ''/var/lib/mysql/'' we also have file ''mysql-bin.000004'', so its' name is missing in index file, lets add it, so ''master-log-bin.index'' looks like:

/var/lib/mysql/mysql-bin.000001
/var/lib/mysql/mysql-bin.000002
/var/lib/mysql/mysql-bin.000003
/var/lib/mysql/mysql-bin.000004
/var/lib/mysql/mysql-bin.000005

Restart mysql on this server and try with the slave again.

This is just an example - some other file's records can be missing. Make sure the file has all related files' records, which are in same folder.

 
=== Failed to open the relay log ===

* stop mysql on the slave server
* find the directory that contains the relay logs (usually /var/lib/mysql)
* delete all relay logs called hostname-relay-bin.XXX, hostname-relay-bin.index and relay-log.info
* restart mysql

Your mysql will start with fresh relay logs and is getting the missing data directly from the master server, as there will probably still be binlogs!

 
=== Couldn't find MySQL manager or server ===

Comment out basedir in my.cnf

 
----
 

* [[Default mysql.cnf]] - can be useful to go back if something goes wrong and no backup is done.
* If server is rebooted - it takes ~45s for the database to start synchronizing after MySQL is up.

 
===Could not initialize master info structure, more error messages can be found in the MySQL error log===
Please check this link: http://forums.mysql.com/read.php?26,163227,163241#msg-163241

 
=== Broken replication fix ===

http://rackerhacker.com/2008/01/09/mysql-replication-breakdown/

 
=== What to do if you have errors with binlogs ===
Delete all binlog files from both servers (but leave database structures and data!), then reapply replication.
'''You have to test GUI on both servers after you apply MySQL replication.'''

 
=== No more MySQL Crash Safe Replication in 5.0? ===
http://www.mysqlperformanceblog.com/2008/01/29/no-more-mysql-crash-safe-replication-in-50/

 
=== Can't connect to MySQL server on 'xxx.xxx.xxx.xxx' ===
Error looks like this:

# mysql -h 222.222.222.222 -u rep1 -prep1
ERROR 2003 (HY000): Can't connect to MySQL server on '222.222.222.222' (113)

Please check firewalls and make sure that port TCP 3306 is not blocked.

 
=== TRUNCATE usage ===

Do not use TRUNCATE statement because it can ruin Replication.

* http://bugs.mysql.com/bug.php?id=36763
* http://dev.mysql.com/doc/refman/5.1/en/replication-features-truncate.html

 

= See also =
* [http://www.ducea.com/2008/02/13/mysql-skip-duplicate-replication-errors/ slave-skip-errors=1062] more details
* [http://mysqldatabaseadministration.blogspot.com/2006/12/mysql-replication-stopped-lock-wait.html Replication stopped: Lock wait timeout exceeded]

MySQL Replication

2017-10-03T05:42:09Z

Zilvinas: /* Troubleshooting */

<big><big>MySQL Replication works only on servers where MySQL 5.x is installed</big></big>
[[Image:mysql_logo.png|right]]
 

'''THIS TUTORIAL WILL GUIDE YOU THROUGH HOW TO IMPLEMENT MASTER<->MASTER REPLICATION'''

'''Before you start, make a backup of your database.'''

 
==Create user on Server 1==

* Username: rep2
* Password: rep2
* Host: 222.222.222.222
* Grant all privileges to this user (on database mor)

Login as root and issue such commands:

CREATE USER 'rep2'@''''222.222.222.222'''' IDENTIFIED BY 'rep2';

GRANT REPLICATION SLAVE , REPLICATION CLIENT ON *.* TO 'rep2'@''''222.222.222.222'''' IDENTIFIED BY 'rep2' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;

GRANT ALL PRIVILEGES ON *.* TO 'rep2'@''''222.222.222.222'''' WITH GRANT OPTION ;

Go to Server 2 and test the connection:

mysql -h 111.111.111.111 -u rep2 -prep2

 

==Create user on Server 2==

* Username: rep1
* Password: rep1
* Host: 111.111.111.111
* Grant all privileges to this user (on database mor)

Login as root and issue such commands:

CREATE USER 'rep1'@''''111.111.111.111'''' IDENTIFIED BY 'rep1';

GRANT REPLICATION SLAVE , REPLICATION CLIENT ON *.* TO 'rep1'@''''111.111.111.111'''' IDENTIFIED BY 'rep1' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_USER_CONNECTIONS 0 ;

GRANT ALL PRIVILEGES ON *.* TO 'rep1'@''''111.111.111.111'''' WITH GRANT OPTION ;

Go to Server 1 and test the connection:

mysql -h 222.222.222.222 -u rep1 -prep1

''' Note: Make sure you have applied REPLICATION CLIENT and REPLICATION SLAVE on both users. '''

 

==Server 1 my.cnf==

[mysqld]
innodb_file_per_table=1
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
#old_passwords=1

bind-address = 0.0.0.0

binlog-do-db = mor
# binlog-do-db = mor_mnp #uncomment if there is mor_mnp database
# binlog-do-db = opensips #uncomment if there is opensips database
server-id = 10
auto_increment_increment = 10
auto_increment_offset = 1
replicate-do-db = mor
# replicate-do-db = mor_mnp #uncomment if there is mon_mnp database
# replicate-do-db = opensips #uncomment if there is opensips database
binlog_format=MIXED
log-bin = /var/lib/mysql/mysql-bin.log
log-bin-index = /var/lib/mysql/master-log-bin.index
# sync_binlog = 1 #increases reliability, but decreases performance
relay-log = /var/lib/mysql/slave-relay.log
relay-log-index = /var/lib/mysql/slave-relay-log.index

slave-skip-errors=1061,1062,1213,1060
slave_transaction_retries=3600

expire_logs_days = 3
# '''innodb_flush_log_at_trx_commit = 1'''
# '''innodb_support_xa'''
max_allowed_packet = 256M
key_buffer_size=256M
key_buffer=258M

innodb_buffer_pool_size = 100M

query_cache_type=1
query_cache_limit=64M
query_cache_size=64M

join_buffer_size = 2M
tmp_table_size = 512M
max_heap_table_size = 512M
thread_cache_size = 4
table_cache = 128

max_connections = 300
slave_transaction_retries = 3600

;log-slow-queries = /var/lib/mysql/slow_query.log

log-error=/var/lib/mysql/mysqld.log

[mysql.server]
user=mysql
basedir=/var/lib

[mysqld_safe]
log-error=/var/lib/mysql/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid

 
Stop services:

service elasticsearch stop
service httpd stop
service asterisk stop
service mor_server_loadstats stop
service crond stop
service mor_alerts stop
service mor_aggregates stop

==Server 2 my.cnf==

[mysqld]
innodb_file_per_table=1
datadir=/var/lib/mysql
socket=/var/lib/mysql/mysql.sock
# Default to using old password format for compatibility with mysql 3.x
# clients (those using the mysqlclient10 compatibility package).
#old_passwords=1

bind-address = 0.0.0.0

binlog-do-db = mor
# binlog-do-db = mor_mnp #uncomment if there is mon_mnp database
# binlog-do-db = opensips #uncomment if there is opensips database
server-id = 20
auto_increment_increment = 10
auto_increment_offset = 2
replicate-do-db = mor
# replicate-do-db = mor_mnp #uncomment if there is mon_mnp database
# replicate-do-db = opensips #uncomment if there is opensips database
binlog_format=MIXED
log-bin = /var/lib/mysql/mysql-bin.log
log-bin-index = /var/lib/mysql/master-log-bin.index
# sync_binlog = 1 #increases reliability, but decreases performance
relay-log = /var/lib/mysql/slave-relay.log
relay-log-index = /var/lib/mysql/slave-relay-log.index

slave-skip-errors=1061,1062,1213,1060
slave_transaction_retries=3600

expire_logs_days = 3
# '''innodb_flush_log_at_trx_commit = 1'''
# '''innodb_support_xa'''
max_allowed_packet = 256M
key_buffer_size=256M
key_buffer=258M
innodb_buffer_pool_size = 100M
query_cache_type=1
query_cache_limit=64M
query_cache_size=64M
join_buffer_size = 2M
tmp_table_size = 512M
max_heap_table_size = 512M
thread_cache_size = 4
table_cache = 128

max_connections = 300
slave_transaction_retries = 3600
;log-slow-queries = /var/lib/mysql/slow_query.log

log-error=/var/lib/mysql/mysqld.log

[mysql.server]
user=mysql
basedir=/var/lib

[mysqld_safe]
log-error=/var/lib/mysql/mysqld.log
pid-file=/var/run/mysqld/mysqld.pid

 
Stop services:

service elasticsearch stop
service httpd stop
service asterisk stop
service mor_server_loadstats stop
service crond stop
service mor_alerts stop
service mor_aggregates stop

==Server 2==

Make sure data on Server 2 = data on Server 1. E.g. MySQL table structure and data are identical on both machines.

 
==Server 1==

/usr/src/mor/sh_scripts/configure_mycnf.sh
/etc/init.d/mysqld restart

mysql -u root -p

USE mor;
FLUSH TABLES WITH READ LOCK;
SHOW MASTER STATUS;

Remember '''File''' and '''Position'''.

UNLOCK TABLES;
quit;

 

==Server2==

Check if you can connect to first server:

mysql -h 111.111.111.111 -u rep2 -p

Proceed if okay:

/usr/src/mor/sh_scripts/configure_mycnf.sh
/etc/init.d/mysqld restart

mysql -u root -p

SLAVE STOP;

CHANGE MASTER TO MASTER_HOST='111.111.111.111', MASTER_USER='rep2', MASTER_PASSWORD='rep2', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=205;

'''NOTE: Change MASTER_HOST, MASTER_LOG_FILE and MASTER_LOG_POS accordingly.'''

START SLAVE;

USE mor;
FLUSH TABLES WITH READ LOCK;
SHOW MASTER STATUS;

Remember '''File''' and '''Position'''.

UNLOCK TABLES;
quit;

 

==Server 1==

Check if you can connect to first server:

mysql -h 222.222.222.222 -u rep1 -p

Proceed if okay:

mysql -u root -p

SLAVE STOP;

CHANGE MASTER TO MASTER_HOST='222.222.222.222', MASTER_USER='rep1', MASTER_PASSWORD='rep1', MASTER_LOG_FILE='mysql-bin.000001', MASTER_LOG_POS=205;

'''NOTE: Change MASTER_HOST, MASTER_LOG_FILE and MASTER_LOG_POS accordingly.'''

START SLAVE;
quit;

 
Start services on both servers '''Server 1''' and '''Server 2''':

service elasticsearch start
service httpd start
service asterisk start
service mor_server_loadstats start
service crond start
service mor_alerts start
service mor_aggregates start

==Log files==

In order for MySQL Replication to function properly, you need to check log files in /var/lib/mysql

Open ''master-log-bin.index''. It should contain names of the files which really exist in same folder. If there's some mismatch, edit this file: enter missing names for files or delete file names which do not represent real files in this folder.

Do the same with the file ''slave-relay-log.index''.

 
==Testing==

Login to MySQL console on both servers:

mysql -u root -p

Then:

SHOW SLAVE STATUS\G

If everything is okay, you should see lines between others on both servers:

Slave_IO_State: Waiting for master to send event
Slave_IO_Running: Yes
Slave_SQL_Running: Yes

If Replication is off, you will see:

Slave_IO_State:
Slave_IO_Running: No

The quick way to do this is:

mysql -u root -e 'SHOW SLAVE STATUS\G' | grep 'Slave'

If root has psw:

mysql -u root -pPASSWORD -e 'SHOW SLAVE STATUS\G' | grep 'Slave'

 

'''Never use phpmyadmin to check if data is same on both servers. Use mysql console and a command like count. For example: SELECT COUNT(*) FROM destinations;'''

 
==Troubleshooting==

Check file: /var/lib/mysql/mysqld.log
Check GUI production logs and look for error messages beginning with: "Replication exception:".

 
==='Could not find first log file name in binary log index file' from master when reading data from binary log===

We go to the master and check ''/var/lib/mysql/master-log-bin.index'' file.

For example, it can show:

/var/lib/mysql/mysql-bin.000001
/var/lib/mysql/mysql-bin.000002
/var/lib/mysql/mysql-bin.000003
/var/lib/mysql/mysql-bin.000005

In ''/var/lib/mysql/'' we also have file ''mysql-bin.000004'', so its' name is missing in index file, lets add it, so ''master-log-bin.index'' looks like:

/var/lib/mysql/mysql-bin.000001
/var/lib/mysql/mysql-bin.000002
/var/lib/mysql/mysql-bin.000003
/var/lib/mysql/mysql-bin.000004
/var/lib/mysql/mysql-bin.000005

Restart mysql on this server and try with the slave again.

This is just an example - some other file's records can be missing. Make sure the file has all related files' records, which are in same folder.

 
=== Failed to open the relay log ===

* stop mysql on the slave server
* find the directory that contains the relay logs (usually /var/lib/mysql)
* delete all relay logs called hostname-relay-bin.XXX, hostname-relay-bin.index and relay-log.info
* restart mysql

Your mysql will start with fresh relay logs and is getting the missing data directly from the master server, as there will probably still be binlogs!

 
=== Couldn't find MySQL manager or server ===

Comment out basedir in my.cnf

 
----
 

* [[Default mysql.cnf]] - can be useful to go back if something goes wrong and no backup is done.
* If server is rebooted - it takes ~45s for the database to start synchronizing after MySQL is up.

 
===Could not initialize master info structure, more error messages can be found in the MySQL error log===
Please check this link: http://forums.mysql.com/read.php?26,163227,163241#msg-163241

 
=== Broken replication fix ===

http://rackerhacker.com/2008/01/09/mysql-replication-breakdown/

 
=== What to do if you have errors with binlogs ===
Delete all binlog files from both servers (but leave database structures and data!), then reapply replication.
'''You have to test GUI on both servers after you apply MySQL replication.'''

 
=== No more MySQL Crash Safe Replication in 5.0? ===
http://www.mysqlperformanceblog.com/2008/01/29/no-more-mysql-crash-safe-replication-in-50/

 
=== Can't connect to MySQL server on 'xxx.xxx.xxx.xxx' ===
Error looks like this:

# mysql -h 222.222.222.222 -u rep1 -prep1
ERROR 2003 (HY000): Can't connect to MySQL server on '222.222.222.222' (113)

Please check firewalls and make sure that port TCP 3306 is not blocked.

 
=== TRUNCATE usage ===

Do not use TRUNCATE statement because it can ruin Replication.

* http://bugs.mysql.com/bug.php?id=36763
* http://dev.mysql.com/doc/refman/5.1/en/replication-features-truncate.html

 

= See also =
* [http://www.ducea.com/2008/02/13/mysql-skip-duplicate-replication-errors/ slave-skip-errors=1062] more details
* [http://mysqldatabaseadministration.blogspot.com/2006/12/mysql-replication-stopped-lock-wait.html Replication stopped: Lock wait timeout exceeded]

File:Cc example2.png

2017-09-05T08:27:55Z

Zilvinas: uploaded a new version of "File:Cc example2.png"

File:Cc example1.png

2017-09-05T08:26:20Z

Zilvinas: uploaded a new version of "File:Cc example1.png"

MOR API Card Group update

2017-09-05T08:09:40Z

Zilvinas: /* Parameters */

=Description=
[[MOR API]] Card Group update
 
=Usage=

* From '''MOR X7''' Calling Card: '''/api/cc_group_update'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* cc_Group_id - id of a Card Group '''Required'''.

 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* '''name''' - name of Card Group.
* '''description''' - description of Card Group.
* '''price_with_vat''' - price with TAX of Card Group.
* '''setup_fee''' - setup fee of Card Group.
* '''use_external_function''' - use of external script [0-no, 1-yes].
* '''ghost_min_perc''' - ghost min percent of Card Group.
* '''ghost_balance_perc''' - ghost balance percent of Card Group.
* '''daily_charge''' - daily charge of Card Group.
* '''tell_cents''' - usage of tell cents [0-no, 1-yes].
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency.
* '''tariff_id''' - tariff if of Card Group
* '''lcr_id''' - LCR id of Card Group
* '''location_id''' - Card Group location id.
* '''date_from''' - Card Group valid from date (timestamp).
* '''date_till''' - Card Group valid till date (timestamp).
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.
* '''allow_loss_calls''' - Allow Loss Calls for Card Group [0-off, 1-on].
* '''solo_pinless''' - Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID [0-no, 1-yes].
* '''disable_topup_from_cards_with_cid''' - Disable credit transfers from Cards with a CallerID assigned [0-no, 1-yes].
* '''disable_voucher''' - disable Voucher with same Number as Card if Card is used [0-off, 1-on].
* '''callerid_leave''' - Leave CallerID assigned to Card when balance is empty [0-no, 1-yes].
* '''tax2_enabled''' - [0-no, 1-yes].
* '''tax3_enabled''' - [0-no, 1-yes].
* '''tax4_enabled''' - [0-no, 1-yes].
* '''compound_tax''' - [0-no, 1-yes].
* '''tax1_name''' - name of the first tax.
* '''tax2_name''' - name of the second tax.
* '''tax3_name''' - name of the third tax.
* '''tax4_name''' - name of the fourth tax.
* '''total_tax_name''' - name of total taxes.
* '''tax1_value''' - value of the first tax.
* '''tax2_value''' - value of the second tax.
* '''tax3_value''' - value of the third tax.
* '''tax4_value''' - value of the fourth tax.
* '''currency''' - Card Group Currency name (must be one of active Currencies e.g. EUR).

 

===Request===

We have u = admin, API Secret Key = secret
We send:

HTML POST: http://<SERVER_IP>/billing/api/cc_group_update?u=admin&cc_Group_id=1&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 1 updated Card Group.''' 
'''* Note that a Username and a Password are not included into hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Card Group was successfully updated</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Card Group was not found</error> - There is no such Card Group id or user is not authorized to manage this Card Group.
* <error>Use external function is incorrect format</error> - Use external script parameter can only be: 1 - enabled, 0 - disabled.
* <error>Tell cents is incorrect format</error> - Tell cents parameter can only be: 1 - enabled, 0 - disabled.
* <error>Currency was not found</error> - Currency id is not correct. There is no such Currency.
* <error>Tariff was not found</error> - There is no such Tariff.
* <error>LCR was not found</error> - LCR id is not correct. There is no such LCR.
* <error>Location was not found</error> - Location id is not correct. There is no such Location.
* <error>Date from is incorrect format</error> - Valid from is incorrect format.
* <error>Time till is incorrect format</error> - Valid till is incorrect format.
* <error>Date from is greater than date till</error> - Valid from is greater than valid till.
* <error>Valid after is incorrect format</error> - Valid after maximum value can be 9999.
* <error>Allow loss calls is incorrect format</error> - Allow loss calls parameter can only be: 1 - enabled, 0 - disabled.
* <error>Solo pinless is incorrect format</error> - Solo pinless parameter can only be: 1 - enabled, 0 - disabled.
* <error>Disable voucher is incorrect format</error> - Voucher parameter can only be: 1 - enabled, 0 - disabled.
* <error>CallerID leave is incorrect format</error> - Caller id leave parameter can only be: 1 - enabled, 0 - disabled.
* <error>Compound TAX enabling value is incorrect format</error> - Compound parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 2 enabling value is incorrect format</error> - TAX 2 enabling value parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 3 enabling value is incorrect format</error> - TAX 3 enabling value parameter can only be: 1 - enabled, 0 - disabled.
* <error>TAX 4 enabling value is incorrect format</error> - TAX 4 enabling value parameter can only be: 1 - enabled, 0 - disabled.
Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Invalid Price with TAX</error>
</status>
</page>
 

=See also=

* [[MOR API]]

MOR API Card Group create

2017-09-05T08:09:15Z

Zilvinas: /* Parameters */

=Description=
[[MOR API]] Card Group create
 
=Usage=

* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* name - name of a Card Group '''Required'''.

 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* '''description''' - description for Card Group.
* '''price_with_vat''' - price with TAX for Card Group.
* '''setup_fee''' - setup fee for Card Group.
* '''ghost_min_perc''' - ghost min percent for Card Group.
* '''daily_charge''' - daily charge for Card Group.
* '''tariff_id''' - Card Group Tariff ID.
* '''lcr_id''' - Card Group LCR id.
* '''date_from''' - Card Group valid from date (timestamp).
* '''date_till''' - Card Group valid till date (timestamp).
* '''number_length''' - Card Group number length.
* '''pin_length''' - Card Group PIN length.
* '''location_id''' - Card Group Location ID.
* '''tax_id''' - Card Group TAX ID.
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.
* '''ghost_balance_perc''' - Card Group ghost balance percent.
* '''use_external_function''' - enable or disable use of external script [0-no, 1-yes].
* '''allow_loss_calls''' - Allow Loss Calls for Card Group [0-off, 1-on].
* '''tell_cents''' - tell cents for Card Group [0-off, 1-on].
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency [0-off, 1-on].
* '''solo_pinless''' - Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID [0-no, 1-yes].
* '''disable_topup_from_cards_with_cid''' - Disable credit transfers from Cards with a CallerID assigned [0-no, 1-yes].
* '''disable_voucher''' - enable or disable voucher [0-off, 1-on].
* '''callerid_leave''' - Leave CallerID assigned to Card when balance is empty [0-no, 1-yes].
* '''currency''' - Card Group Currency name (must be one of active Currencies e.g. EUR).
 

===Request===

We have u = admin, API Secret Key = secret
We send:

HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 1 newly created Card Group.''' 
'''* Note that if not passing optional parameters, default values will be used.''' 
'''* Note that a Username and a Password are not included into hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Card Group was successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Card Group must have name</error> - Card Group name is not given. Name is required parameter.
* <error>Use external function is incorrect format</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.
* <error>Allow loss calls is incorrect format</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.
* <error>Tell cents is incorrect format</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.
* <error>Solo pinless is incorrect format</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.
* <error>Disable voucher is incorrect format</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.
* <error>CallerID leave is incorrect format</error> - Caller ID leave parameter can only be: 1 - enabled, 0 - disabled.
* <error>Invalid date from</error> - UNIX time stamp date not correct.
* <error>Invalid date till</error> - UNIX time stamp date not correct.
* <error>Date from is greater than date till</error> - valid from is greater than valid till.
* <error>Tariff was not found</error> - Tariff id is not correct. There is no such Tariff.
* <error>LCR was not found</error> - LCR ID is not correct. There is no such LCR.
* <error>Location was not found</error> - Location ID is not correct. There is no such Location.
* <error>Currency was not found</error> - Currency ID is not correct. There is no such Currency.
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Invalid solo pinless parameter, should be: 0 or 1</error>
</status>
</page>
 

=See also=

* [[MOR API]]

MOR API Card Group create

2017-09-05T08:08:38Z

Zilvinas: /* Parameters */

=Description=
[[MOR API]] Card Group create
 
=Usage=

* From '''MOR X7''' Calling Card: '''/api/cc_group_create'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* name - name of a Card Group '''Required'''.

 
Parameters which are '''not included''' into hash:

* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using the '''parameters''' which are listed above. Note that the parameters are shown in the same order as they need to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''. 
* '''u''' - username for authentication. '''Required'''.
* '''description''' - description for Card Group.
* '''price_with_vat''' - price with TAX for Card Group.
* '''setup_fee''' - setup fee for Card Group.
* '''ghost_min_perc''' - ghost min percent for Card Group.
* '''daily_charge''' - daily charge for Card Group.
* '''tariff_id''' - Card Group Tariff ID.
* '''lcr_id''' - Card Group LCR id.
* '''date_from''' - Card Group valid from date (timestamp).
* '''date_till''' - Card Group valid till date (timestamp).
* '''number_length''' - Card Group number length.
* '''pin_length''' - Card Group PIN length.
* '''location_id''' - Card Group Location ID.
* '''tax_id''' - Card Group TAX ID.
* '''valid_after_first_use''' - number of days, after which Card Group gets valid.
* '''ghost_balance_perc''' - Card Group ghost balance percent.
* '''use_external_function''' - enable or disable use of external script [0-no, 1-yes].
* '''allow_loss_calls''' - Allow Loss Calls for Card Group [0-off, 1-on].
* '''tell_cents''' - tell cents for Card Group [0-off, 1-on].
* '''tell_balance_in_currency''' - Card Group Balance/Rate Currency [0-off, 1-on].
* '''solo_pinless''' - Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID [0-no, 1-yes].
* '''disable_topup_from_cards_with_cid''' - Disable a Card Top Up and other kinds if Credit transfers from Cards which already have a CallerID assigned to them, [0-no, 1-yes].
* '''disable_voucher''' - enable or disable voucher [0-off, 1-on].
* '''callerid_leave''' - Leave CallerID assigned to Card when balance is empty [0-no, 1-yes].
* '''currency''' - Card Group Currency name (must be one of active Currencies e.g. EUR).
 

===Request===

We have u = admin, API Secret Key = secret
We send:

HTML POST: http://<SERVER_IP>/billing/api/cc_group_create?u=admin&name=card_group_test&hash=7e112ededcfee097cce21b6201c6d2a00dda1f4c

* Now we can find 1 newly created Card Group.''' 
'''* Note that if not passing optional parameters, default values will be used.''' 
'''* Note that a Username and a Password are not included into hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<success>Card Group was successfully created</success>
</status>
</page>
 
----

'''Errors'''

* <error>Access Denied</error> - User is not authorized or is a Simple User. Only Admin, Reseller or Accounant can use this API method.
* <error>Incorrect hash</error> - hash is not correct. Check API_Secret_Key and order or parameters while concatenating a hash_string.
* <error>You are not authorized to use this functionality</error> - User has no permissions to manage Calling Cards.
* <error>Card Group must have name</error> - Card Group name is not given. Name is required parameter.
* <error>Use external function is incorrect format</error> - use external script parameter can only be: 1 - enabled, 0 - disabled.
* <error>Allow loss calls is incorrect format</error> - allow loss calls parameter can only be: 1 - enabled, 0 - disabled.
* <error>Tell cents is incorrect format</error> - tell cents parameter can only be: 1 - enabled, 0 - disabled.
* <error>Solo pinless is incorrect format</error> - solo pinless parameter can only be: 1 - enabled, 0 - disabled.
* <error>Disable voucher is incorrect format</error> - voucher parameter can only be: 1 - enabled, 0 - disabled.
* <error>CallerID leave is incorrect format</error> - Caller ID leave parameter can only be: 1 - enabled, 0 - disabled.
* <error>Invalid date from</error> - UNIX time stamp date not correct.
* <error>Invalid date till</error> - UNIX time stamp date not correct.
* <error>Date from is greater than date till</error> - valid from is greater than valid till.
* <error>Tariff was not found</error> - Tariff id is not correct. There is no such Tariff.
* <error>LCR was not found</error> - LCR ID is not correct. There is no such LCR.
* <error>Location was not found</error> - Location ID is not correct. There is no such Location.
* <error>Currency was not found</error> - Currency ID is not correct. There is no such Currency.
* <error>Invalid Price with TAX</error> - price is not correct, can not be negative.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
<status>
<error>Invalid solo pinless parameter, should be: 0 or 1</error>
</status>
</page>
 

=See also=

* [[MOR API]]

Calling Card Groups

2017-09-05T08:05:51Z

Zilvinas: /* Properties */

=Description=
A Card Group is a set (array) of [[Calling Card management|Calling Cards]].
 
=Usage=

Card Groups, like many other entities in MOR, can be created/edited/deleted/viewed.

If a Calling Card module is enabled, you can find it in: '''ADDONS –> Card Groups'''.
 
[[Image:card_group_path.png]]
 
Here you can review your active Calling Card Groups:
 
[[Image:Caling_cards.png]]
 
[[Image:icon_details.png]] (..) - shows the Cards window, where you can manage the Group's Cards. 
[[Image:icon_details.png]] - all the details of the Calling Card Group. 
[[Image:icon_excel.png]] - exports Cards into CSV format. 
[[Image:icon_edit.png]] - edits the Group's details. 
[[Image:icon_delete.png]] - deletes the Group with all Cards, used Cards will be hidden. 
 

= Properties =
 
[[File:Card_group_properties.png]]
 
* '''Card Image''' – just for informational purposes and eye pleasure to view on the GUI. Can be (and should be) the same as the real printed card for consistency. But that's not the rule.
* '''Description''' – a short memo for admin to view some more info for the cards. It is useful when there are a lot of Card Groups and the Card Group name is not enough.
* '''Price with TAX''' – the price which all Cards in this Group will have before first use. TAX is not included into Card balance. It's in the default currency.
* '''Setup Fee''' – the fee which will be charged when a call is connected the FIRST time when the card is used.
* '''Ghost minute percent''' – a value to trick the user into thinking he has more minutes when he really has less.

Example:

A user has enough balance in his card to call for 50 minutes. Ghost minute percent = 120. So when the user enters his number/PIN, the system tells: "You have 60 minutes remaining" (50/100 * 120). Note: this is not an increase in percent; it is the value by which the actual minutes should be multiplied to tell them to the user.
** Custom [[Ghost Minute Percent per Destination for Calling Card Group]] (''This option is available starting from [[MOR_9_documentation | MOR9]]'').
* '''Ghost balance percent''' - same as Ghost Minute Percent, but this value only applies to the Balance which is told to the user (''This option is available starting from [[MOR_9_documentation | MOR9]]'').
* '''Daily Charge''' – the amount which will be deducted EACH day from the card starting from the date when the card is used for the first time. This means, if the user makes his first call on Monday and his second call on Friday, his card will be deducted for 5 days using this value (Mo, Tu, We, Th, Fr). Daily Charge is applied for all cards in group: for those cards which were activated before Daily Charge was set, and for cards which will be activated in future.
* '''Currency''' - Currency used for all cards (''Before [[MOR_X10 | MOR X10]] Default Currency is used'').
* '''Tell cents''' - enable or disable telling cents when announcing card balance (''This option is available starting from [[MOR_10_documentation | MOR 10]]'').
* '''Tell balance in currency''' - choose in which currency to tell balance when announcing it. (''This option is available starting from [[MOR_10_documentation | MOR10]]'').
* '''TAX percent''' – the actual value which will be used when presenting the Card's price to the User, i.e. when telling the user his remaining balance on the Card or showing the same information on the screen.
* '''Least Cost Routing (LCR)''' – which LCR will be used for all Cards in this Card Group.
* '''Tariff''' – the price list which will be used for this Card Group.
* '''Location''' – this is useful when Cards will be sold in a region with specific dialing rules. Rules for location can vary for different Calling Card Groups.
* '''Number Length''' – the length of the Card's number. You can select any value here. It is recommended to select different values for different Card Groups to minimize the risk of anyone guessing another card's number and using it unauthorized. Card numbers are generated in sequence order.
* '''PIN Length''' – the number of the Card's PIN. The same recommendation applies as for the Card's Number. PINs are generated randomly.
* '''Valid from''' - from which date Cards are valid.
* '''Valid till''' - till which date Cards are valid.
* '''Valid after first use''' - how many days a Card is valid after first use. Default 0 means that card is valid forever.
* '''[[Allow loss calls]]''' - enable this feature on calling card group if you want to let card users to make calls when there might be loss.
* '''Deny to double-use a Card with Pinless dialing, when Card is assigned to some CallerID'''
* '''Disable credit transfers from Cards with a CallerID assigned ''' - this option disallows a Card Top Up and other kinds if Credit transfers from Cards which already have a CallerID assigned to them.
* '''Disable Voucher with same Number as Card if Card is used?''' - this option allows you to print cards which can be used both for vouchers and for Calling Cards. If one is used - the other one is deactivated.
* '''Leave CallerID assigned to Card when balance is empty:''' - to leave or not to leave a card with CallerID when its balance equals 0. Note: Card balance is checked before call to destination, right after card is recognized.

 

= VIDEO: How to create Calling Cards Group =
<html>
<iframe width="640" height="360" src="http://www.youtube.com/embed/lxzhAdvOW2Q" frameborder="0"></iframe>
</html>

 

=See also=

* [[Calling Cards Addon]]

File:Card group properties.png

2017-09-05T08:03:39Z

Zilvinas: uploaded a new version of "File:Card group properties.png"

CDR Export Templates

2017-09-05T07:41:53Z

Zilvinas: /* Available columns */

Funcionality can be used '''only''' by system Administrator.
 
CDR Export Templates allow to create templates with specific columns for CSV files. These templates can be used to export CDRs from Last Calls.

 
==How to download CDR by template==

Go to '''SETTINGS -> Billing -> CDR -> Export -> Templates''' and create new template with columns that you want to export.

[[File:Cdr_export_templates.png]]

Now if you go to Last Calls, you should be able to see '''Export to Template''' button:

[[File:Last calls cdr export template.png]]

By pressing '''Export''', all CDRs by specified filters will be exported to CSV file and only columns from CDR Template will be included. 
'''CDR CSV archive will be sent via email to System administrator. Make sure that emails are configured correctly!''' 
'''NOTE:''' archive size is limited to 10MB! If CDR archive is larger, then archive will not be sent back.

===Available columns===

* '''Accountcode''' - ID of Originator (Device ID);
* '''Billsec''' - billable duration (from answer to hangup) excluding minimal time and increment;
* '''Call ID''' - call id in MOR system;
* '''Called From''' - Originator's number (CallerID), for example "John Smith" <123456789>;
* '''Called To''' - localized destination number;
* '''Card ID''' - Card ID;
* '''DID Billsec''' - DID billable duration;
* '''DID Device ID''' - ID of Device which received call;
* '''DID Incoming Price''' - DID price which is paid by the user who is dialing to that DID;
* '''DID Number''' - DID Number;
* '''DID Price''' - DID price which is paid by the user who owns dialed DID;
* '''DID Provider ID''' - DID Provider ID;
* '''DID Provider Price''' - DID Provider Price;
* '''DID User ID''' - ID of User who received DID call;
* '''Date''' - date and time when call was started (first INVITE packet);
* '''Destination''' - Direction and Destination name of dialed destination;
* '''Destination Name''' - only Destination name (without Direction name);
* '''Destination Number''' - original destination number (including technical prefixes);
* '''Direction Name''' - only Direction name (without Destination name);
* '''Disposition''' - call disposition (ANSWERED, BUSY, NO ANSWER or FAILED);
* '''Duration''' - call duration from first INVITE to BYE;
* '''Hangup Cause''' - reason why call ended (Disposition + Hangup Cause Code, for example ANSWERED(16));
* '''Hangup Cause Code''' - reason why call ended (only numeric value, for example 16);
* '''Originator Codec''' - Codec used by Originator;
* '''Originator IP''' - Originator's IP address;
* '''Partner Billsec''' - billable duration (from answer to hangup) including Partner's increment and minimal time;
* '''Partner ID''' - ID of Partner in MOR system;
* '''Partner Price''' - call price by Partner's Tariff;
* '''Partner Rate''' - call rate by Partner's Tariff;
* '''Prefix''' - prefix used to find rate;
* '''Profit''' - Admin's Profit;
* '''Provider''' - name of Provider;
* '''Provider Billsec''' - billable duration (from answer to hangup) including Provider's increment and minimal time;
* '''Provider ID''' - ID of Provider in MOR system;
* '''Provider Price''' - call price by Provider's Tariff;
* '''Provider Rate''' - call rate by Provider's Tariff;
* '''Real Billsec''' - same as Billsec but in decimal (more precise);
* '''Real Duration''' - same as Duration but in decimal (more precise);
* '''Reseller''' - name of Reseller;
* '''Reseller Billsec''' - ID of Reseller in MOR system;
* '''Reseller ID''' - billable duration (from answer to hangup) including Reseller's increment and minimal time;
* '''Reseller Price''' - call price by Reseller's Tariff;
* '''Reseller Rate''' - call rate by Reseller's Tariff;
* '''Server ID''' - ID of server which was used to make call;
* '''Source Number''' - Originator's number part of CalleID;
* '''Terminator Codec''' - Codec used by Terminator;
* '''Terminator IP''' - Terminator's IP address;
* '''Unique ID''' - uniqueid of call in MOR system;
* '''User''' - name of User;
* '''User Billsec''' - billable duration (from answer to hangup) including User's increment and minimal time;
* '''User ID''' - ID of User in MOR system;
* '''User Price''' - call price by User's Tariff;
* '''User Rate''' - call rate by User's Tariff.

==Email Templates==

If archive is sent successfully, System administrator should receive success email which can be customised in [[Emails]] settings. CDR archive will be attached.

 
= See also =
* [[How to export CDRs]]
* [[Automatic CDR Export]]

CDR Export Templates

2017-09-05T07:40:24Z

Zilvinas: /* Available columns */

Funcionality can be used '''only''' by system Administrator.
 
CDR Export Templates allow to create templates with specific columns for CSV files. These templates can be used to export CDRs from Last Calls.

 
==How to download CDR by template==

Go to '''SETTINGS -> Billing -> CDR -> Export -> Templates''' and create new template with columns that you want to export.

[[File:Cdr_export_templates.png]]

Now if you go to Last Calls, you should be able to see '''Export to Template''' button:

[[File:Last calls cdr export template.png]]

By pressing '''Export''', all CDRs by specified filters will be exported to CSV file and only columns from CDR Template will be included. 
'''CDR CSV archive will be sent via email to System administrator. Make sure that emails are configured correctly!''' 
'''NOTE:''' archive size is limited to 10MB! If CDR archive is larger, then archive will not be sent back.

===Available columns===

* '''Accountcode''' - ID of Originator (Device ID);
* '''Billsec''' - billable duration (from answer to hangup) excluding minimal time and increment;
* '''Call ID''' - call id in MOR system;
* '''Called From''' - Originator's number (CallerID), for example "John Smith" <123456789>;
* '''Called To''' - localized destination number;
* '''Card ID''' - Card ID;
* '''DID Billsec''' - DID billable duration;
* '''DID Device ID''' - ID of Device which received call;
* '''DID Incoming Price''' - DID price which is paid by the user who is dialing to that DID;
* '''DID Number''' - DID Number;
* '''DID Price''' - DID price which is paid by the user who owns dialed DID;
* '''DID Provider ID''' - DID Provider ID;
* '''DID Provider Price''' - DID Provider Price;
* '''DID User ID''' - ID of User who received DID call;
* '''Date''' - date and time when call was started (first INVITE packet);
* '''Destination''' - Direction and Destination name of dialed destination;
* '''Destination Name''' - only Destination name (without Direction name);
* '''Destination Number''' - original destination number (including technical prefixes);
* '''Direction Name''' - only Direction name (without Destination name);
* '''Disposition''' - call disposition (ANSWERED, BUSY, NO ANSWER or FAILED);
* '''Duration''' - call duration from first INVITE to BYE;
* '''Hangup Cause''' - reason why call ended (Disposition + Hangup Cause Code, for example ANSWERED(16));
* '''Hangup Cause Code''' - reason why call ended (only numeric value, for example 16);
* '''Originator IP''' - Originator's IP address;
* '''Partner Billsec''' - billable duration (from answer to hangup) including Partner's increment and minimal time;
* '''Partner ID''' - ID of Partner in MOR system;
* '''Partner Price''' - call price by Partner's Tariff;
* '''Partner Rate''' - call rate by Partner's Tariff;
* '''Prefix''' - prefix used to find rate;
* '''Profit''' - Admin's Profit;
* '''Provider''' - name of Provider;
* '''Provider Billsec''' - billable duration (from answer to hangup) including Provider's increment and minimal time;
* '''Provider ID''' - ID of Provider in MOR system;
* '''Provider Price''' - call price by Provider's Tariff;
* '''Provider Rate''' - call rate by Provider's Tariff;
* '''Real Billsec''' - same as Billsec but in decimal (more precise);
* '''Real Duration''' - same as Duration but in decimal (more precise);
* '''Reseller''' - name of Reseller;
* '''Reseller Billsec''' - ID of Reseller in MOR system;
* '''Reseller ID''' - billable duration (from answer to hangup) including Reseller's increment and minimal time;
* '''Reseller Price''' - call price by Reseller's Tariff;
* '''Reseller Rate''' - call rate by Reseller's Tariff;
* '''Server ID''' - ID of server which was used to make call;
* '''Source Number''' - Originator's number part of CalleID;
* '''Terminator IP''' - Terminator's IP address;
* '''Unique ID''' - uniqueid of call in MOR system;
* '''User''' - name of User;
* '''User Billsec''' - billable duration (from answer to hangup) including User's increment and minimal time;
* '''User ID''' - ID of User in MOR system;
* '''User Price''' - call price by User's Tariff;
* '''User Rate''' - call rate by User's Tariff;
* '''Originator Codec''' - Codec used by Originator;
* '''Terminator Codec''' - Codec used by Terminator.

==Email Templates==

If archive is sent successfully, System administrator should receive success email which can be customised in [[Emails]] settings. CDR archive will be attached.

 
= See also =
* [[How to export CDRs]]
* [[Automatic CDR Export]]

File:Call info details 4.png

2017-09-05T07:38:36Z

Zilvinas: uploaded a new version of "File:Call info details 4.png"

Multi Server support

2017-09-05T07:18:42Z

Zilvinas: /* Graphs */

<center><big><big><big>'''VERY IMPORTANT! IF YOU HAVE ONLY ONE ASTERISK SERVER OR DO NOT UNDERSTAND WHAT THESE SETTINGS ARE FOR - DO NOT CHANGE THEM AT ALL!'''</big></big></big></center>
 
'''SETTINGS - Billing - Servers'''
=What is Multi Server support?=

With this system, it is possible to manage several Asterisk servers from GUI.

These servers are Asterisk servers which work with calls and BILL them.

=How to add a new Asterisk server?=
Go to Asterisk Servers: '''Billing -> Servers'''
 

* '''Gateway''' - determines whether the server acts as a Gateway for SIP Proxy. This option is available only when you have [[SIP balancer]]. It means that the SIP Proxy will use this server to send calls through.

* '''Active''' - determines whether the server is active, e.g. whether MOR should 'talk' to this server in order to update provider/device information. Disabling the server does not disable its use, only the updating of changes from GUI.

* '''ID''' - a unique identifier of a server that should be same as the server_id in '''mor.conf'''.

* '''Test''' - click to test the connection to the server over AMI.

* '''Hostname for SIP''' most times is equal to '''Server IP for SIP''' and '''Server IP for AMI'''

* '''URL''' - a special URL for some third-party software, or sometimes for server stats.

* '''Type''' and '''Comment''' - just for informational purposes.

* '''Max Call Limit''' - not used for now.

* '''AMI Username/AMI Secret''' - settings to connect to a server over AMI. These are the most important settings in this window! They should match the values in the server'' /etc/asterisk/manager.conf

* '''SIP Port''' - the port Asterisk uses to listen to SIP; used in [[SIP balancer]].

Fill in the required fields and press the marked icon:
 
[[File:server_1.png]]

 
'''NOTE! If you want to connect another Asterisk server which will not bill calls, then configure it as Device/Trunk.'''

 
<center><big><big><big>'''VERY IMPORTANT! IF YOU HAVE ONLY ONE ASTERISK SERVER OR DO NOT UNDERSTAND WHAT THESE SETTINGS ARE FOR - DO NOT CHANGE THEM AT ALL!'''</big></big></big></center>

 
----
 

== How to make calls from devices on different Asterisk server ==

1. Create 2 devices, device A and device B.

2. Mark the correct Asterisk server in [[Device_settings | settings]] for those devices.

3. Create 2 DID numbers (any number format you need/want) DID1 and DID2

4. Forward DID to device (Assign DID to user and forward it to device) DID1 to device A, DID2 to device B

5. Register devices to the Asterisk servers that they belong

6. Call from Device A to DID2 to reach Device B, and vice versa.

 

= [[Providers]] =

==Where to find [[Providers | providers]] of a specific Asterisk server?==

1. Go to Severs

2. To get to [[Providers | providers]] list of a specific Asterisk server press the marked icon:

[[File:Asterisk_servers_providers_list_new.png]]

This window shows which [[Providers]] are accessible from '''this Server'''.
 
[[File:Asterisk_servers_providers_list.png]]

 

=Call Flows=

Lets say we have:

Provider provA and Device devA configured on Asterisk server ast1;

Provider provB and Device devB configured on Asterisk server ast2;

Provider provC configured on both Asterisk servers (ast1 and ast2).

Possible call flows are:

devA makes call through provA (user > ast1 > provA);

devB makes call through provB (user > ast2 > provider);

devA makes call through provB (user > ast1 > ast2 > provB);

devB makes call through provA (user > ast2 > ast1 > provA);

devA makes call through provC (user > ast1 > provC);

devB makes call through provC (user > ast2 > provC).

 
= Server Version/Uptime =

Available from MOR 12 - These values are updated automatically by MOR. Not possible to change them manually.
 

=Stats=

Available from MOR x4:

==Where to find server statistics==

1. Go to Severs

Column "Free space" indicates how much free space is left on server's hard drive.

2. To get to stats of a specific server press the marked icon:

[[File:server_3.png]]

==Graphs==

*HDD Utilization - shows current hard drive utilization.

*CPU General Load - the general load of CPU.

*CPU Loadstats - CPU load statistics.

*Service Load - load caused by MySQL, Ruby and Asterisk.

 

[[File:servers_stats_view.png]]

 

=Additional Notes=

* Every Provider can belong to every Server.

* It is important to map the correct Providers to the correct servers.

* Database and GUI servers are not described here.

* Free space value is not related with other stats values.

 

= See also =

* [[Intelligent Internal Routing]]
* [[Server is overloaded]]

File:Servers stats view.png

2017-09-05T07:17:49Z

Zilvinas: uploaded a new version of "File:Servers stats view.png"

Call Tracing

2017-09-05T07:07:12Z

Zilvinas: /* Device testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make Calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make Calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the Call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some Payment method to increase his Balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to Postpaid and then we should adjust his Credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no Devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have Rates. Currently none of them has. You need to add some Rates to the existing Tariff or assign a non-empty Tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Calltracing3.png]]
 
This data means that we are testing a virtual Call from an IP authenticated SIP Device to a number 37061111111 on 2017 September 5th 09:30.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New_mor_call_tracing.png]]
 
Call Tracing Log will show self explanatory warnings, errors (in red colored text), other messages, and an informative summary.
 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T07:04:11Z

Zilvinas: /* User testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make Calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make Calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the Call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some Payment method to increase his Balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to Postpaid and then we should adjust his Credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no Devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have Rates. Currently none of them has. You need to add some Rates to the existing Tariff or assign a non-empty Tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Calltracing3.png]]
 
This data means that we are testing a virtual Call from an IP authenticated SIP Device to a number 37061111111 on 2017 September 5th 09:30.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New_mor_call_tracing.png]]
 
The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T07:01:21Z

Zilvinas: /* Device testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make Calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make Calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the Call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no Devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 
= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Calltracing3.png]]
 
This data means that we are testing a virtual Call from an IP authenticated SIP Device to a number 37061111111 on 2017 September 5th 09:30.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New_mor_call_tracing.png]]
 
The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T07:00:18Z

Zilvinas: /* Device testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make Calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make Calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the Call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no Devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 
= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Calltracing3.png]]
 
This data means that we are testing a virtual Call from an IP authenticated Device to a number 37061111111 on 2017 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New_mor_call_tracing.png]]
 
The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:59:03Z

Zilvinas:

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make Calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make Calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the Call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no Devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 
= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Device Call tracing.png]]
 
This data means that we are testing a virtual Call from an IP authenticated Device to a number 37061111111 on 2017 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New mor Call tracing.png]]
 
The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:56:54Z

Zilvinas:

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a User will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that Users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a User.

In the first window, we have to select which User we want to check:
 
[[Image:calltracing1.png]]
 
= User testing =

The next window shows us whether we have configured everything properly for the selected User. Let's look at each section separately.

The first section shows information special to the User:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the User from operating. Let's say we want to allow a User to make calls. We will go through each of the errors and fix them.

1. This error tells us that the User is Blocked and so unable to make calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this User are empty, and the User type is Prepaid. That means he has no funds to cover the call fees. There are several ways to go about fixing this:

* If the User is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the User type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the User to dial out.

3. The User has no devices. A Device is necessary in order to dial out. Just create one for this User.

'''Note:''' We also see that the User has an empty Tariff assigned. That is the reason why the User will not be able to dial out. In addition, the User can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this User.

After solving all these issues, we should see:
 
[[Image:calltracing3.png]]
 
= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:
 
[[Image:Device call tracing.png]]
 
This data means that we are testing a virtual call from device IAX1/101 to number 863042438 on 2016 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:
 
[[Image:New mor call tracing.png]]
 
The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:52:52Z

Zilvinas:

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a user will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a user.

In the first window, we have to select which user we want to check:

[[Image:calltracing1.png]]

= User testing =

The next window shows us whether we have configured everything properly for the selected user. Let's look at each section separately.

The first section shows information special to the user:
 
[[Image:calltracing2.png]]
 

Here we see three errors [[Image:icon_cross.png]] that prevent the user from operating. Let's say we want to allow a user to make calls. We will go through each of the errors and fix them.

1. This error tells us that the user is Blocked and so unable to make calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this user are empty, and the user type is Prepaid. That means he has no funds to cover the call fees. There are several ways to go about fixing this:

* If the user is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the user type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the user to dial out.

3. The user has no devices. A Device is necessary in order to dial out. Just create one for this user.

'''Note:''' We also see that the user has an empty Tariff assigned. That is the reason why the user will not be able to dial out. In addition, the user can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this user.

After solving all these issues, we should see:

 
[[Image:calltracing3.png]]
 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:

[[Image:Device call tracing.png]]

This data means that we are testing a virtual call from device IAX1/101 to number 863042438 on 2016 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:

 
[[Image:New mor call tracing.png]]
 

The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:52:01Z

Zilvinas: /* User testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a user will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a user.

In the first window, we have to select which user we want to check:

[[Image:calltracing1.png]]

= User testing =

The next window shows us whether we have configured everything properly for the selected user. Let's look at each section separately.

The first section shows information special to the user:

[[Image:calltracing2.png]]

Here we see three errors [[Image:icon_cross.png]] that prevent the user from operating. Let's say we want to allow a user to make calls. We will go through each of the errors and fix them.

1. This error tells us that the user is Blocked and so unable to make calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this user are empty, and the user type is Prepaid. That means he has no funds to cover the call fees. There are several ways to go about fixing this:

* If the user is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the user type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the user to dial out.

3. The user has no devices. A Device is necessary in order to dial out. Just create one for this user.

'''Note:''' We also see that the user has an empty Tariff assigned. That is the reason why the user will not be able to dial out. In addition, the user can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this user.

After solving all these issues, we should see:

[[Image:calltracing3.png]]
 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:

[[Image:Device call tracing.png]]

This data means that we are testing a virtual call from device IAX1/101 to number 863042438 on 2016 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:

[[Image:New mor call tracing.png]]

The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:51:34Z

Zilvinas: /* User testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a user will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a user.

In the first window, we have to select which user we want to check:

[[Image:calltracing1.png]]

= User testing =

The next window shows us whether we have configured everything properly for the selected user. Let's look at each section separately.

The first section shows information special to the user:

[[Image:calltracing2.png]]

Here we see three errors [[Image:icon_cross.png]] that prevent the user from operating. Let's say we want to allow a user to make calls. We will go through each of the errors and fix them.

1. This error tells us that the user is Blocked and so unable to make calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this user are empty, and the user type is Prepaid. That means he has no funds to cover the call fees. There are several ways to go about fixing this:

* If the user is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the user type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the user to dial out.

3. The user has no devices. A Device is necessary in order to dial out. Just create one for this user.

'''Note:''' We also see that the user has an empty Tariff assigned. That is the reason why the user will not be able to dial out. In addition, the user can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this user.

After solving all these issues, we should see:

[[Image:calltracing3.png]]

 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:

[[Image:Device call tracing.png]]

This data means that we are testing a virtual call from device IAX1/101 to number 863042438 on 2016 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:

[[Image:New mor call tracing.png]]

The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

Call Tracing

2017-09-05T06:43:48Z

Zilvinas: /* User testing */

<mkmeta>How to trace MOR Call</mkmeta>
= MOR Call Tracing Overview =

This function is for checking the setup of MOR in order to be sure a user will be able to dial out. To set MOR up isn't simple, but we are trying to make it easier with this manual and with improvements to GUI. It often happens that users miss some important detail while trying to make everything work. Call Tracing will save a lot of head-scratching, and we hope it will be helpful for beginners.

This function can be found in '''SETTINGS –> Billing –> Function –> Call Tracing'''. It can be quickly accessed in the Users menu (SETTINGS –> Users) as well. Just click on the [[Image:icon_call_tracing.png]] icon for a user.

In the first window, we have to select which user we want to check:

[[Image:calltracing1.png]]

= User testing =

The next window shows us whether we have configured everything properly for the selected user. Let's look at each section separately.

The first section shows information special to the user:

[[Image:calltracing2.png]]

Here we see three errors [[Image:icon_cross.png]] that prevent the user from operating. Let's say we want to allow a user to make calls. We will go through each of the errors and fix them.

1. This error tells us that the user is Blocked and so unable to make calls. We should go to [[User Details]] and unblock him.

2. Balance and Credit for this user are empty, and the user type is Prepaid. That means he has no funds to cover the call fees. There are several ways to go about fixing this:

* If the user is postpaid, he should use some payment method to increase his balance. [[PayPal]] and [[Payments | Manual Payment]], among others, are good ways to do this.
* We can change the user type to postpaid and then we should adjust his credit. Maybe it is unlimited, maybe some limit exists. But this will allow the user to dial out.

3. We see that the user has assigned a tariff and a type of tariff. The type of tariff is just for informational purposes. Here 'Explanation' tells us that Tariff is empty. That is the reason why the user is not able to dial out. In addition, the user can dial out only to those destinations which have rates. Currently none of them has. You need to add some rates to the existing tariff or assign a non-empty tariff to this user.

4. The user has no devices. A Device is necessary in order to dial out. Just create one for this user.

After solving all these issues, we should see:

[[Image:calltracing3.png]]

 

= Device testing =

The following section lets us choose a Device, Source, Server, Destination and a Call Time we want to test. For example:

[[Image:Device call tracing.png]]

This data means that we are testing a virtual call from device IAX1/101 to number 863042438 on 2016 September 28th 12:59.

When we click '''Trace Call''', we will go to the next page and we will see something like:

[[Image:New mor call tracing.png]]

The '''Details''' section shows us just routine information. We already knew this information, so it is not important.

Call Tracing Log will show self explanatory warnings, errors (in red colored text) and other messages.

 

=From Accountant=

Accountant must have '''Call tracing usage''' permission in [[Accountant_permissions | Accountant permissions group]] to use this functionality.

File:Calltracing2.png

2017-09-05T06:41:44Z

Zilvinas: uploaded a new version of "File:Calltracing2.png"

File:Calltracing3.png

2017-09-05T06:34:37Z

Zilvinas: uploaded a new version of "File:Calltracing3.png"

File:Calltracing1.png

2017-09-05T06:33:00Z

Zilvinas: uploaded a new version of "File:Calltracing1.png"

File:New mor call tracing.png

2017-09-05T06:27:57Z

Zilvinas: uploaded a new version of "File:New mor call tracing.png"

MOR API user details update

2017-09-05T05:36:27Z

Zilvinas: /* Parameters */

=Description=

[[MOR API]] Update user from params.
 
If Admin has checked Allow Resellers to use Admin Tariffs in [[API Configuration]] then using this API Reseller can set for his Users Wholesale or Retail Tariffs which belongs to Admin.
 
'''Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.'''
 

=Usage=

* From '''MOR X4''' call: '''/api/user_details_update'''
* For Backwards-compatibility old name 'user_update_api' is also usable. Call: '''/api/user_update_api'''
* Methods: POST, GET(if allowed, not recomended)
 

===Parameters===

Parameters which are '''included''' into hash (if it is used):

* user_id - Users ID in MOR database, whose details we want to change. '''REQUIRED'''.
* u0 - vat number
* u1 - lcr id
* u2 - warning email hour
* u3 - hide destination end
* u4 - currency id
* u5 - tariff id
* u6 - warning email balance
* u7 - spy device id
* u8 - language
* u9 - username
* u10 - warning balance call
* u11 - acc group id
* u12 - generate invoice
* u13 - usertype
* u14 - taxation country ([[Directions_and_Destinations#Directions|Direction]] id)
* u15 - blocked
* u16 - quickforwards rule id
* u17 - last name
* u18 - call limit
* u19 - clientid
* u20 - recording hdd quota
* u21 - cyberplat active
* u22 - recordings email
* u23 - first name
* u24 - warning balance sound file id
* u25 - postpaid
* u26 - accounting number
* u27 - agreement number
* u28 - hidden
* u29 - pbx pool id
* u30 - hide non answered calls
* u31 - responsible accountant id
* ay - agr_date year
* am - agr_date month
* ad - agr_date day
* by - block at date year2011
* bm - block at date month
* bd - block at date day
* pswd - password
* user_warning_email_hour
* pgui - privacy gui [0-off, 1-on]
* pcsv - privacy csv [0-off, 1-on]
* ppdf - privacy pdf [0-off, 1-on]
* recording_forced_enabled - [0-off, 1-on]
* i4 - invoice detailed csv [0-off, 16-on]
* tax4_enabled - [0-off, 1-on]
* tax2_enabled - [0-off, 1-on]
* accountant_type_invalid
* block_at_conditional - 15
* tax3_enabled - [0-off, 1-on]
* accountant_type
* tax1_value - float
* show_zero_calls - [0-off, 1-on]
* warning_email_active - [0-off, 1-on]
* compound_tax - [0-off, 1-on]
* tax4_name -
* allow_loss_calls - [0-off, 1-on]
* tax3_name -
* tax2_name -
* credit - float
* tax1_name -
* total_tax_name -
* tax2_value - float
* tax4_value - float
* ignore_global_monitorings - [0-off, 1-on]
* i1 - invoice pdf [0-off, 2-on]
* tax3_value - float
* cyberplat_active - [0-off, 1-on]
* i2 - invoice csv [0-off, 4-on]
* i3 - invoice detailed pdf [0-off, 8-on]
* recording_enabled - [0-off, 1-on]
* email_warning_sent_test - [0-off, 1-on]
* own_providers - [0-off, 1-on]
* a0 - address
* a1 - city
* a2 - postcode
* a3 - county
* a4 - mob_phone
* a5 - fax
* a6 - direction id ([[Directions_and_Destinations#Directions|Direction]] id)
* a7 - phone
* a8 - email
* a9 - state

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''REQUIRED'''.
* u - username of user which can modify details (admin, reseller or accountant). '''REQUIRED'''.
* time_zone - time zone (all available references are listed on Time Zone list at the time zone name column. See more: http://wiki.kolmisoft.com/index.php/Time_Zone_list)

 
'''Additional feature'''
 
If API setting '''Allow Resellers to use Admin Quick Forward Rules''' is enabled: Reseller is able to set Quick Forward Rules inherited from Admin. '''u16''' should be used as a parameter for Quick Forward Rules. 
If API setting '''Allow Resellers to use Admin Tariffs''' is enabled: Reseller is able to set Tariff inherited from Admin. '''u5''' should be used as a parameter for Tariff.
 

===Reguest===

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send:
HTML POST: http://<server_ip>/billing/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

'''* Note that username and password are not included in hash'''

Other examples:

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin).

HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes user quickforwards rule to rule with ID 3 (u16=3) user with ID 789 (user_id=789). User belongs to admin (u=admin).
 

===Returns===

'''Success'''

<page>
<status>User was updated</status>
</page>
 
----
'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - Check params and permissions.
* <error>You have no editing permission</error> - Accountant dont have permission.
* <error>Tariff not found</error> - Tariff was not found using param u5.
* <error>User was not updated</error>
* <error>Responsible accountant is not valid</error> Responsible accountant id was not correct using param u31.
* <message>problem message</message>
 

=See also=

* [[MOR API]]

MOR API user details update

2017-08-31T12:34:49Z

Zilvinas: /* Parametres */

=Description=

[[MOR API]] Update user from params.
 
If Admin has checked Allow Resellers to use Admin Tariffs in [[API Configuration]] then using this API Reseller can set for his Users Wholesale or Retail Tariffs which belongs to Admin.
 
'''Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.'''
 

=Usage=

* From '''MOR X4''' call: '''/api/user_details_update'''
* For Backwards-compatibility old name 'user_update_api' is also usable. Call: '''/api/user_update_api'''
* Methods: POST, GET(if allowed, not recomended)
 

===Parameters===

Parameters which are '''included''' into hash (if it is used):

* user_id - Users ID in MOR database, whose details we want to change. '''REQUIRED'''.
* u0 - vat number
* u1 - lcr id
* u2 - warning email hour
* u3 - hide destination end
* u4 - currency id
* u5 - tariff id
* u6 - warning email balance
* u7 - spy device id
* u8 - language
* u9 - username
* u10 - warning balance call
* u11 - acc group id
* u12 - generate invoice
* u13 - usertype
* u14 - taxation country ([[Directions_and_Destinations#Directions|Direction]] id)
* u15 - blocked
* u16 - quickforwards rule id
* u17 - last name
* u18 - call limit
* u19 - clientid
* u20 - recording hdd quota
* u21 - cyberplat active
* u22 - recordings email
* u23 - first name
* u24 - warning balance sound file id
* u25 - postpaid
* u26 - accounting number
* u27 - agreement number
* u28 - hidden
* u29 - pbx pool id
* u30 - hide non answered calls
* u31 - responsible accountant id
* ay - agr_date year
* am - agr_date month
* ad - agr_date day
* by - block at date year2011
* bm - block at date month
* bd - block at date day
* pswd - password
* user_warning_email_hour
* pgui - privacy gui [0-off, 1-on]
* pcsv - privacy csv [0-off, 1-on]
* ppdf - privacy pdf [0-off, 1-on]
* recording_forced_enabled - [0-off, 1-on]
* i4 - invoice detailed csv [0-off, 16-on]
* tax4_enabled - [0-off, 1-on]
* tax2_enabled - [0-off, 1-on]
* accountant_type_invalid
* block_at_conditional - 15
* tax3_enabled - [0-off, 1-on]
* accountant_type
* tax1_value - float
* show_zero_calls - [0-off, 1-on]
* warning_email_active - [0-off, 1-on]
* compound_tax - [0-off, 1-on]
* tax4_name -
* allow_loss_calls - [0-off, 1-on]
* tax3_name -
* tax2_name -
* credit - float
* tax1_name -
* total_tax_name -
* tax2_value - float
* tax4_value - float
* ignore_global_monitorings - [0-off, 1-on]
* i1 - invoice pdf [0-off, 2-on]
* tax3_value - float
* cyberplat_active - [0-off, 1-on]
* i2 - invoice csv [0-off, 4-on]
* i3 - invoice detailed pdf [0-off, 8-on]
* recording_enabled - [0-off, 1-on]
* email_warning_sent_test - [0-off, 1-on]
* own_providers - [0-off, 1-on]
* a0 - address
* a1 - city
* a2 - postcode
* a3 - county
* a4 - mob_phone
* a5 - fax
* a6 - direction id
* a7 - phone
* a8 - email
* a9 - state

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''REQUIRED'''.
* u - username of user which can modify details (admin, reseller or accountant). '''REQUIRED'''.
* time_zone - time zone (all available references are listed on Time Zone list at the time zone name column. See more: http://wiki.kolmisoft.com/index.php/Time_Zone_list)

 
'''Additional feature'''
 
If API setting '''Allow Resellers to use Admin Quick Forward Rules''' is enabled: Reseller is able to set Quick Forward Rules inherited from Admin. '''u16''' should be used as a parameter for Quick Forward Rules. 
If API setting '''Allow Resellers to use Admin Tariffs''' is enabled: Reseller is able to set Tariff inherited from Admin. '''u5''' should be used as a parameter for Tariff.
 

===Reguest===

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send:
HTML POST: http://<server_ip>/billing/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

'''* Note that username and password are not included in hash'''

Other examples:

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin).

HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes user quickforwards rule to rule with ID 3 (u16=3) user with ID 789 (user_id=789). User belongs to admin (u=admin).
 

===Returns===

'''Success'''

<page>
<status>User was updated</status>
</page>
 
----
'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - Check params and permissions.
* <error>You have no editing permission</error> - Accountant dont have permission.
* <error>Tariff not found</error> - Tariff was not found using param u5.
* <error>User was not updated</error>
* <error>Responsible accountant is not valid</error> Responsible accountant id was not correct using param u31.
* <message>problem message</message>
 

=See also=

* [[MOR API]]

MOR API user details update

2017-08-31T12:34:41Z

Zilvinas: /* Parametres */

=Description=

[[MOR API]] Update user from params.
 
If Admin has checked Allow Resellers to use Admin Tariffs in [[API Configuration]] then using this API Reseller can set for his Users Wholesale or Retail Tariffs which belongs to Admin.
 
'''Please note that it is not necessary to send ALL user parameters - you can send only those you need to update.'''
 

=Usage=

* From '''MOR X4''' call: '''/api/user_details_update'''
* For Backwards-compatibility old name 'user_update_api' is also usable. Call: '''/api/user_update_api'''
* Methods: POST, GET(if allowed, not recomended)
 

===Parametres===

Parameters which are '''included''' into hash (if it is used):

* user_id - Users ID in MOR database, whose details we want to change. '''REQUIRED'''.
* u0 - vat number
* u1 - lcr id
* u2 - warning email hour
* u3 - hide destination end
* u4 - currency id
* u5 - tariff id
* u6 - warning email balance
* u7 - spy device id
* u8 - language
* u9 - username
* u10 - warning balance call
* u11 - acc group id
* u12 - generate invoice
* u13 - usertype
* u14 - taxation country ([[Directions_and_Destinations#Directions|Direction]] id)
* u15 - blocked
* u16 - quickforwards rule id
* u17 - last name
* u18 - call limit
* u19 - clientid
* u20 - recording hdd quota
* u21 - cyberplat active
* u22 - recordings email
* u23 - first name
* u24 - warning balance sound file id
* u25 - postpaid
* u26 - accounting number
* u27 - agreement number
* u28 - hidden
* u29 - pbx pool id
* u30 - hide non answered calls
* u31 - responsible accountant id
* ay - agr_date year
* am - agr_date month
* ad - agr_date day
* by - block at date year2011
* bm - block at date month
* bd - block at date day
* pswd - password
* user_warning_email_hour
* pgui - privacy gui [0-off, 1-on]
* pcsv - privacy csv [0-off, 1-on]
* ppdf - privacy pdf [0-off, 1-on]
* recording_forced_enabled - [0-off, 1-on]
* i4 - invoice detailed csv [0-off, 16-on]
* tax4_enabled - [0-off, 1-on]
* tax2_enabled - [0-off, 1-on]
* accountant_type_invalid
* block_at_conditional - 15
* tax3_enabled - [0-off, 1-on]
* accountant_type
* tax1_value - float
* show_zero_calls - [0-off, 1-on]
* warning_email_active - [0-off, 1-on]
* compound_tax - [0-off, 1-on]
* tax4_name -
* allow_loss_calls - [0-off, 1-on]
* tax3_name -
* tax2_name -
* credit - float
* tax1_name -
* total_tax_name -
* tax2_value - float
* tax4_value - float
* ignore_global_monitorings - [0-off, 1-on]
* i1 - invoice pdf [0-off, 2-on]
* tax3_value - float
* cyberplat_active - [0-off, 1-on]
* i2 - invoice csv [0-off, 4-on]
* i3 - invoice detailed pdf [0-off, 8-on]
* recording_enabled - [0-off, 1-on]
* email_warning_sent_test - [0-off, 1-on]
* own_providers - [0-off, 1-on]
* a0 - address
* a1 - city
* a2 - postcode
* a3 - county
* a4 - mob_phone
* a5 - fax
* a6 - direction id
* a7 - phone
* a8 - email
* a9 - state

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''REQUIRED'''.
* u - username of user which can modify details (admin, reseller or accountant). '''REQUIRED'''.
* time_zone - time zone (all available references are listed on Time Zone list at the time zone name column. See more: http://wiki.kolmisoft.com/index.php/Time_Zone_list)

 
'''Additional feature'''
 
If API setting '''Allow Resellers to use Admin Quick Forward Rules''' is enabled: Reseller is able to set Quick Forward Rules inherited from Admin. '''u16''' should be used as a parameter for Quick Forward Rules. 
If API setting '''Allow Resellers to use Admin Tariffs''' is enabled: Reseller is able to set Tariff inherited from Admin. '''u5''' should be used as a parameter for Tariff.
 

===Reguest===

We have user_id = 123, API Secret Key = 456789, u15=1 (we want to block user)

We send:
HTML POST: http://<server_ip>/billing/api/user_details_update?u=username&user_id=123&u15=1&hash=0ab3ede4e93a55c38855a2cc9b9e169d35442c48

'''* Note that username and password are not included in hash'''

Other examples:

HTML POST: http://<server_ip>/billing/api/user_update_api?u15=1&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request blocks (u15=1) user with ID 789 (user_id=789). User belongs to admin (u=admin).

HTML POST: http://<server_ip>/billing/api/user_update_api?u16=3&user_id=789&u=admin&u15=1&hash=0in2w8n01rwnodv4t0y5zzfp1h5hdp1fyk7z

This request changes user quickforwards rule to rule with ID 3 (u16=3) user with ID 789 (user_id=789). User belongs to admin (u=admin).
 

===Returns===

'''Success'''

<page>
<status>User was updated</status>
</page>
 
----
'''Errors'''

* <error>User was not found</error> - User was not found using user_id. Use correct user id.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Access Denied</error> - Check params and permissions.
* <error>You have no editing permission</error> - Accountant dont have permission.
* <error>Tariff not found</error> - Tariff was not found using param u5.
* <error>User was not updated</error>
* <error>Responsible accountant is not valid</error> Responsible accountant id was not correct using param u31.
* <message>problem message</message>
 

=See also=

* [[MOR API]]

MOR API card group get

2017-08-31T10:23:13Z

Zilvinas: /* Usage */

=Description=

[[MOR API]] Show Calling Card Group
 
=Usage=

* From '''MOR X4''' call: '''/api/card_group_get '''
* For Backwards-compatibility old name 'show_calling_card_group' is also usable. Call: '''/api/show_calling_card_group'''
* Methods: POST, GET(if allowed, not recomended)
 
===Parameters===

Parameters which are '''included''' into hash:

* id - Calling Card Group ID in MOR database. '''Required'''.

'''Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key'''
 
Parameters which are '''not included''' into hash:

* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
* u - username for authentication. '''Required'''.
 

===Request===

We have id = 6, API Secret Key = 456789

We send:

HTML POST: http://<SERVER_IP>/billing/api/card_group_get?u=username&id=6&hash=67df827dec80a7241fb3fc4de22a90e62c5e8d93

'''NOTE that username is not included in hash'''
 
===Returns===

'''Success'''

<?xml version="1.0" encoding="UTF-8"?>
<page>
<cardgroup>
<name>....</name>
<iamge_link>/billing/cards/example.jpg</iamge_link>
<description>...</description>
<price>...</price>
<price_with_tax>...</price_with_tax>
<currency>...</currency>
<free_cards_size>...</free_cards_size>
<pin_length>....</pin_length>
<number_length>....</number_length>
</cardgroup>
</page>
 
----

'''Errors'''

* <error>Bad login</error> - User supplied bad login.
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
* <error>Cardgroup was not found</error> - Use correct Calling Card Group ID .
 

=See also=

* [[MOR API]]

Auto-Dialer Addon

2017-08-14T12:32:59Z

Zilvinas: /* Numbers */

=Description=

Auto-Dialer addon lets you call an array of [[Auto-Dialer_Addon#Numbers | numbers]] automatically. When call is answered, receiver hears the audio message or he is in standby mode, it depends on what is set in Auto Dialer [[Auto-Dialer_Addon#Actions | actions]] (PLAY / IVR / WAIT).
This functionality can be used in telemarketing.
 
=Usage=

When Auto-Dialer (AD) is installed, every user can use it and '''only users can create Campaigns. Admin cannot create Campaings.'''

==From User==

The user can find the AD menu under '''PERSONAL MENU -> Various -> Auto Dialer'''.

The main window shows the user's campaigns:
 
[[Image:ad1.png]]
 
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.

A Campaign can only be '''Activated''' if it has free (not-called) numbers AND some Actions.

So please, before activating a Campaign, import some Numbers and create Actions.

'''NOTE:''' Auto Dialer starts in 5 minutes, so when you are starting this add-on, you need to wait 5 minutes before it starts.
 
===Campaigns===

Auto-Dialer can be found under '''PERSONAL MENU -> Various -> Auto Dialer'''.

[[Image:icon_add.png]] '''Add new campaign''' allows you to add a new campaign:
 
[[Image:autodialer1.png]]
 
The important fields here are:

* '''Start/Stop Times''' – when calls will be made.
* '''Max Retries''' – how many times to retry an unsuccessful call.
* '''Retry Time''' – how many seconds the system should wait to retry the call.
* '''Wait Time''' – how long to wait till the call is answered. This field by default is 10 and cannot be made less. This is done in order to
prevent annoying multiple calls from Auto Dialer to the end user if for example "Wait Time" is configured as 5 seconds.
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.
* '''CallerID''' - what CallerID to put on calls.
* '''Allow duplicate numbers''' - when checked allows duplicate number import into the Auto-Dialer Campaign.
 

=== Numbers ===

Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:
 
[[Image:autodialer2.png]]
 
The user can import phone numbers from a TXT file. Numbers should be in correct dialing format.

Example of numbers file:

442012345678
442087654321
442054987123

In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:
 
[[Image:autodialer3.png]]
 
After uploading the file, you will see status of imported numbers:
 
[[Image:autodialer4.png]]
 
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''

If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.
 

=== Actions ===

Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:
 
[[Image:autodialer5.png]]
 
In this window, the user programs the Actions for the Campaign:

Types of Actions:

* '''WAIT''' – how many seconds to wait.
* '''PLAY''' – play a file.
* '''IVR''' - send call to IVR. It can be used to connect to a real person and give the callee a greater choice. For example, it is possible to play an advertisement and tell the user to press '1' to talk with a real person about this advertisement or similar.
** NOTE: admin or [[Reseller_Pro_Addon|Reseller PRO]] must check option "All users can use it" on IVR to allow users to set that IVR on AD campaign.
 

===Redial all failed Calls===

You can redial all failed calls:
 
[[File:Autodialer_redial_all_failed_calls.png]]
 

===Autodialer Campaign statistics===
To view the Autodialer Campaign statistics, click on the bar chart icon in the '''Stats''' column.
 
[[File:Autodialer_Stats_icon.png]]
 
On the newly opened page you will be able to see the desired Autodialer Campaign statistics with a search filter and a visual representation of data.
 
[[File:Autodialer_Stats_User.png]]
 

==From Admin==

When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:
 
[[Image:autodialer6.png]]
 
The important information for each Campaign is:

* Status – is the Campaign Active or Stopped?
* Run time – tells when calls will be made.

All other fields are self-explanatory.

It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign.
 

=Workflow=

Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.

If there are some active campaigns, the script creates call files for the future.

It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.

For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.

Variables in '''/etc/mor/system.conf''':

'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).

'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.

Example #1:

calls_one_time = 10
cron_interval = 1

That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:

1st call: 0s
2nd call: 6s
3rd call: 12s
....
9th call: 54s
10th call: 60s

Example #2:

calls_one_time = 5
cron_interval = 2

That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:

1st call: 0s
2nd call: 12s
3rd call: 24s
4rd call: 36s
5th call: 48s
6th call: 60s
7th call: 72s
8th call: 84s
9th call: 96s
10th call: 108s
 

=Limitations=

Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk

server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign on both servers, if you want it to

run only on one server you need to just disable the cron job on one of the servers.
Cron can be found in
/etc/cron.d/mor_ad
 
=Logs=

Autodialer log can be found here:
/var/log/mor/mor_ad_cron.log
 
= Problems =

* [[MOR Server Speedup]] (to get more calls by AD)
* [[I have a problem with Auto Dialer]]
 
=See also=

* [[Autodialer poll example]]
* [[Convert WAV file to Asterisk playable format]] 
* [[Sound files]]

Auto-Dialer Addon

2017-08-14T12:32:30Z

Zilvinas: /* Campaigns */

=Description=

Auto-Dialer addon lets you call an array of [[Auto-Dialer_Addon#Numbers | numbers]] automatically. When call is answered, receiver hears the audio message or he is in standby mode, it depends on what is set in Auto Dialer [[Auto-Dialer_Addon#Actions | actions]] (PLAY / IVR / WAIT).
This functionality can be used in telemarketing.
 
=Usage=

When Auto-Dialer (AD) is installed, every user can use it and '''only users can create Campaigns. Admin cannot create Campaings.'''

==From User==

The user can find the AD menu under '''PERSONAL MENU -> Various -> Auto Dialer'''.

The main window shows the user's campaigns:
 
[[Image:ad1.png]]
 
The user can Activate or Stop the Campaign by clicking the [[Image:icon_play.png]] or [[Image:icon_stop.png]] button near the Campaign's status.

A Campaign can only be '''Activated''' if it has free (not-called) numbers AND some Actions.

So please, before activating a Campaign, import some Numbers and create Actions.

'''NOTE:''' Auto Dialer starts in 5 minutes, so when you are starting this add-on, you need to wait 5 minutes before it starts.
 
===Campaigns===

Auto-Dialer can be found under '''PERSONAL MENU -> Various -> Auto Dialer'''.

[[Image:icon_add.png]] '''Add new campaign''' allows you to add a new campaign:
 
[[Image:autodialer1.png]]
 
The important fields here are:

* '''Start/Stop Times''' – when calls will be made.
* '''Max Retries''' – how many times to retry an unsuccessful call.
* '''Retry Time''' – how many seconds the system should wait to retry the call.
* '''Wait Time''' – how long to wait till the call is answered. This field by default is 10 and cannot be made less. This is done in order to
prevent annoying multiple calls from Auto Dialer to the end user if for example "Wait Time" is configured as 5 seconds.
* '''Device''' – each Campaign should be assigned to a Device in order for MOR to bill the call.
* '''CallerID''' - what CallerID to put on calls.
* '''Allow duplicate numbers''' - when checked allows duplicate number import into the Auto-Dialer Campaign.
 

=== Numbers ===

Click on [[Image:icon_list.png]] in the '''Numbers''' column to check numbers which will be dialed on campaign:
 
[[Image:autodialer2.png]]
 
The user can import phone numbers from a TXT file. Numbers should be in correct dialing format and not duplicated.

Example of numbers file:

442012345678
442087654321
442054987123

In a new Campaign there are no numbers, so click on [[Image:icon_csv.png]] '''Import numbers from file''' and select the file to upload:
 
[[Image:autodialer3.png]]
 
After uploading the file, you will see status of imported numbers:
 
[[Image:autodialer4.png]]
 
You can delete all numbers by clicking [[Image:icon_cross.png]] '''Delete all numbers'''. Also you can export details by clicking [[Image:excel.png]] '''Export IVR/poll results to CSV'''

If a number is Completed, it is possible to reactivate it (tell the system to call it again) by clicking the [[Image:icon_reactivate.png]] icon near the number.
 
=== Actions ===

Click [[Image:icon_actions.png]] in the Actions column to access the Campaign's actions:
 
[[Image:autodialer5.png]]
 
In this window, the user programs the Actions for the Campaign:

Types of Actions:

* '''WAIT''' – how many seconds to wait.
* '''PLAY''' – play a file.
* '''IVR''' - send call to IVR. It can be used to connect to a real person and give the callee a greater choice. For example, it is possible to play an advertisement and tell the user to press '1' to talk with a real person about this advertisement or similar.
** NOTE: admin or [[Reseller_Pro_Addon|Reseller PRO]] must check option "All users can use it" on IVR to allow users to set that IVR on AD campaign.
 

===Redial all failed Calls===

You can redial all failed calls:
 
[[File:Autodialer_redial_all_failed_calls.png]]
 

===Autodialer Campaign statistics===
To view the Autodialer Campaign statistics, click on the bar chart icon in the '''Stats''' column.
 
[[File:Autodialer_Stats_icon.png]]
 
On the newly opened page you will be able to see the desired Autodialer Campaign statistics with a search filter and a visual representation of data.
 
[[File:Autodialer_Stats_User.png]]
 

==From Admin==

When Auto-Dialer (AD) is installed, Admin can find it under the '''ADDONS –> Auto Dialer''' menu. Here he can get a view of all users' campaigns:
 
[[Image:autodialer6.png]]
 
The important information for each Campaign is:

* Status – is the Campaign Active or Stopped?
* Run time – tells when calls will be made.

All other fields are self-explanatory.

It is possible for admin to see the Actions for users' Campaigns. Just click on the [[Image:icon_actions.png]] '''Actions''' button. However he cannot make any changes to the user's campaign.
 

=Workflow=

Each 5 minutes, "cron job" is activated to check whether any campaigns are activated.

If there are some active campaigns, the script creates call files for the future.

It puts calls in Time Period in equal time periods, to balance the workload for Asterisk.

For example, if you have 10 calls to make, the script will execute them in 6s intervals to start all calls in 1 min time.

Variables in '''/etc/mor/system.conf''':

'''calls_one_time''' - how many calls to distribute per one minute. (PLEASE NOTE, this value is not for simultaneous calls! It has a very different meaning, which is explained below).

'''cron_interval''' - the interval of time (in minutes) in which we should 'put' calls. Do not set value higher than "4" as it would cause overlapping of Autodialer sessions.

Example #1:

calls_one_time = 10
cron_interval = 1

That means that in 1 minute the script will put 10 calls. So each call will be executed at a 6s interval:

1st call: 0s
2nd call: 6s
3rd call: 12s
....
9th call: 54s
10th call: 60s

Example #2:

calls_one_time = 5
cron_interval = 2

That means that in 1 minute the script will put 5 calls and it will do so for 2 minutes. So each call will be executed at a 12s interval:

1st call: 0s
2nd call: 12s
3rd call: 24s
4rd call: 36s
5th call: 48s
6th call: 60s
7th call: 72s
8th call: 84s
9th call: 96s
10th call: 108s
 

=Limitations=

Currently MOR does not support such functionality as to issue the Auto Dialer campaign only in that Asterisk

server to which the device belongs (if you have multiple Asterisk servers). Now MOR just issues the campaign on both servers, if you want it to

run only on one server you need to just disable the cron job on one of the servers.
Cron can be found in
/etc/cron.d/mor_ad
 
=Logs=

Autodialer log can be found here:
/var/log/mor/mor_ad_cron.log
 
= Problems =

* [[MOR Server Speedup]] (to get more calls by AD)
* [[I have a problem with Auto Dialer]]
 
=See also=

* [[Autodialer poll example]]
* [[Convert WAV file to Asterisk playable format]] 
* [[Sound files]]

File:Autodialer1.png

2017-08-14T12:30:23Z

Zilvinas: uploaded a new version of "File:Autodialer1.png"

File:M2 call info.png

2017-08-10T13:20:23Z

Zilvinas: uploaded a new version of "File:M2 call info.png"

M4 Termination Points

2017-08-10T08:50:15Z

Zilvinas: /* Advanced */

=Description=

Termination Point is connection to some final entity (device/line/trunk/provider/supplier/etc) where call will be terminated.

Call comes from [[M2 Origination Points | Origination Points]] and goes to Termination Point.

Termination Points are assigned to [[M2 Dial Peers | Dial Peers]]. 

=Termination Point Settings=

* '''Act as Termination Point''' - turns on/turns of Termination Point. If selected No and saved, all settings of Termination Point will be erased. 
* '''Active''' - activates/deactivates Termination Point. 
* '''Source Transformation''' - special [[M2 Source Transformation | Source Transformation]] rules used to modify Source number. 
* '''Destination Transformation''' - special [[M2 Destination Transformation | Destination Transformation]] rules used to modify outgoing number. 
* '''Tariff''' - Tariff used for Termination Point accounting. 
* '''Capacity''' - limits the number of concurrent calls to this termination point. 
* '''Source (CallerID) Allow''' - regular expression (regexp) for CallerIDs that are allowed to go through this termination point (use regexp '''.*''' if you want to allow all CallerIDs to go through this termination point). 
* '''Source (CallerID) Deny''' - regular expression (regexp) for CallerIDs that are NOT allowed to go through this termination point (leave empty if you do not want to disallow any CallerIDs). 
* '''Register''' - should we register the provider? 
* '''Login/Username''' - username if your provider asks for it. 
* '''Password''' - password used for authentication by your provider. 
 

==Codecs==

Define which Codecs will be offered when dialing Terminator (in the order they are listed).

* '''Enforce leg A Codecs to leg B''' - if this option is enabled in Terminator settings, M2 will ignore selected Terminator Codecs and will offer the same Codecs (in same order) from leg A to leg B. More information can be found [[M2 Codec Negotiation | here]]. 

== Advanced ==

* '''Interpret NO ANSWER as FAILED''' - makes NO ANSWER calls interpretation as FAILED. 
* '''Interpret BUSY as FAILED''' - makes BUSY calls interpretation as FAILED 
* '''Periodic check''' - if enabled, periodic SIP OPTIONS requests will be sent to Termination Point to check if it is reachable. If Periodic Check is enabled and Termination Point does not respond to OPTIONS request then Termination Point will be marked as unreachable and will be skipped when making calls. Once Termination Point starts to respond to OPTIONS request it will be marked as reachable and calls will be routed through this Termination Point. Termination Points are checked every 5 minutes. 
* '''Sticky Contact''' – if this option is enabled, M2 uses only first SIP Contact header received from Termination Point. Sometimes Terminators change Contact header in the middle of SIP dialog and in some cases this may lead to unpredicted behavior (for example Terminator changes Contact header to wrong address and calls do not terminate properly). Use this option only if you know what you are doing. This option applies only to Termination points.
* '''Disable Q.850 Reason''' - by default M2 returns Q.850 Reason header in SIP responses to Originator. This can be disabled by setting this option to "yes".
* '''Forward RPID''' - by default M2 forwards RPID header from Originator to Terminator. This can be disabled by setting this option to "no".
* '''Forward PAI''' - by default M2 forwards PAI header from Originator to Terminator. This can be disabled by setting this option to "no".
* '''Bypass Media''' - when set, the media (RTP) from the originating endpoint is sent directly to the destination endpoint and vice versa. The signaling (SIP) for both endpoints still goes through M2, but the media is point-to-point.
* '''Disable SIP URI encoding''' - enable or disable SIP URI encoding. If enabled, then some characters in SIP URI (Invite, To) are encoded in percent-encoding. For example if you send number 123#99999, encoded SIP URI will be sent to Provider as 123%2399999 (note that # is replaced by %23). If your Provider does not accept encoded SIP URI, you may disable this feature and characters like # will not be encoded.
* '''Use PAI if CallerID is anonymous''' - if enabled, when CallerID is '''anonymous''' PAI header number is used as CallerID.
 

== Subnetting ==

It is possible to set [http://en.wikipedia.org/wiki/Subnetwork subnetwork] for Termination Point. Instead of IP address, you can set subnet in '''IP Address''' input field. Subnet should be written in [http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing CIDR notation] (for example 192.168.0.1/28). When call is routed through Termination Point which uses subnet, '''random''' IP address from that subnet will be chosen for outgoing call. 
You can use online subnet [http://www.aboutmyip.com/AboutMyXApp/SubnetCalculator.jsp? calculator] to check first and last usable IP address from given subnet.
 

== IP range ==

If you need to set multiple IP addresses for single Termination Point and Subnetting does not meet your needs, then you can set IP ranges. Ranges are written in the following format:

xxx.xxx.xxx.xxx-yyy

Note that you can set range only for last octet in IP address. 

When call is routed through Termination Point which uses IP range, '''random''' IP address from that range will be chosen for outgoing call. For example, if we have IP range 192.168.0.100-150, then random IP address from range 192.168.0.100 - 192.168.0.150 will be generated. 

=See also=

* [[M2 Disconnect Code Changes|Disconnect Code Changes]]
* [[NO_ANSWER/BUSY_interpretation_for_providers]]