| 51.2. CTIVM - CTI Voice Mail | ||
|---|---|---|
 | Chapter 51. CTIAS - CTI Advanced Services |  |
| 51.2. CTIVM - CTI Voice Mail | ||
|---|---|---|
| | Chapter 51. CTIAS - CTI Advanced Services | |
Voice mail is a centralized system of stored telephone messages which are sent via email by Abilis. The voice mail can be managed both via the web interface and CP.
Abilis provides a system message set for voice mail, but every user can customize its own messages.
The CTIVM resource requires the SOFT-PBX licence.
Add the resource to the Abilis system with the following command.
[09:08:14] ABILIS_CPX:a res:ctivm
COMMAND EXECUTEDThe CTIVM resource may already exist in the system, but may not yet be active. Set it active with the command:
[09:10:00] ABILIS_CPX:s act res:ctivm
COMMAND EXECUTED![[Caution]](../images/caution.png) | Caution |
|---|---|
You must restart the Abilis to make the resource running (use the command warm start to reboot the Abilis) after adding or setting the CTIVM active. |
![[Tip]](../images/tip.png) | Tip |
|---|---|
If the CTIVM resource is activated and the CTIAS resource is not, Abilis automatically adds the CTIAS resource: [12:11:11] ABILIS_CPX: |
[12:15:48] ABILIS_CPX:s p ctivm act:yesCOMMAND EXECUTED [12:15:56] ABILIS_CPX:d p ctivmRES:CtiVm - Not Saved (SAVE CONF), Not Refreshed (INIT) ----------------------- ------------------------------------------------------------------------ Run DESCR:CTI_Voice_Mail_service LOG:NO ACT:YES sesnum:5 TC-SESNUM:1 BUSY-NOCHAN:YES CONN-DELAY:0 MSGLEN:90 RCPT: RCPT-LIST:# OGM-MSG:default END-MSG:default wdir:C:\APP\VM\ [12:16:00] ABILIS_CPX:save confVALIDATION IN PROGRESS ... VALIDATION SUCCESSFULLY EXECUTED SAVE EXECUTED [12:16:13] ABILIS_CPX:init res:ctivmCOMMAND EXECUTED
| Caution |
|---|---|
Execute the initialization command init res:ctivm to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters. |
Use the command below to display the parameters of the resource; the d p ctivm ? command shows the meaning of parameters.
[14:08:12] ABILIS_CPX:d p ctivm
RES:CtiVm ---------------------------------------------------------------------
Run DESCR:CTI_Voice_Mail_service
LOG:NO ACT:YES sesnum:5 TC-SESNUM:1 BUSY-NOCHAN:YES
CONN-DELAY:0 MSGLEN:90
RCPT:
RCPT-LIST:#
OGM-MSG:default END-MSG:default
wdir:C:\APP\VM\Meaning of parameters:
DESCRResource description. From 0 up to 79 Alphanumeric extended characters. Spaces are not allowed. Case is preserved.Strings holding spaces must be written between quotation marks (E.g.: "str1 str2")
LOGState changes log and alarm generation [NO, D, S, A, L, T, ALL] [+E] (D: Debug Log; S: System Log; A: Alarm view; L: Local audible alarm; T: SNMP traps; +E: Extended Log of state changes, see ref. manual)
ACTRuntime CTIVM activation/deactivation.
sesnumNumber of sessions that the VM plugin can support at once [1..255]. Default is 5.
TC-SESNUMNumber of on-the-fly simultaneous transcoding sessions allowed for VM plugin [0..255]. Default is 1.
BUSY-NOCHANReturn BUSY cause instead of NOCHAN [NO, YES]. Default is YES.
CONN-DELAYConnection delay [0..60 sec.]. Default is 0.
MSGLENMaximal length of stored message [10..180 sec.]. Default is 90.
RCPTDefult Voice Mail recipient(s). From 0 up to 128 ASCII printable characters (used when a call is not for a user). Spaces are not allowed. Case is preserved. Default is empty.
RCPT-LISTIN2T list used to select Voice Mail recipient(s) on the base of called numbers [#, ListName]. Default is #.
OGM-MSGName of the file holding the Outgoing Message. From 1 up to 20 characters. Names holding spaces must be written between quotation marks (E.g.: "Dft out message"). Default is default.
END-MSGName of the file holding the End Message. From 1 up to 20 characters. Names holding spaces must be written between quotation marks (E.g.: "Sys end message"). Default is default.
wdirDirectory where message files are located. It cannot be empty. Physical full path in DOS notation, i.e. starting with a drive letter in the range ['A'..'Z'] and ending with the '\' character. Max. 128 characters. Case is preserved. Spaces are allowed. Strings holding spaces must be written between quotation marks (E.g.: "C:\My dir\"). Default is C:\APP\VM\.
The following command allows the administrator to change the configuration of the resource:
s p ctivm parameter:value...
| Caution |
|---|---|
Execute the initialization command init res:ctivm to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters. |
The following command is used to display the diagnostics of the CTIVM resource:
it shows the state of the resource sorted by session
(sesnum
parameter).
MAILER-STATECTIVM sender state (WAITING:sender is waiting for new mail to be sent. SEARCHING: sender is searching on disk for new mail to be sent. CHECKING": sender is checking metadata file.SENDING: sender is sending the mail. DELETING: sender is deleting metadata file and WAV file.)
TC-STATECTIVM transcoder state.(WAITING: transcoder is waiting for new CPM to be transcoded. SEARCHING: sender is searching on disk for new CPM to be transcoded. CHECKING: sender is checking metadata file. TRANSCODING: transcoder is transcoding CPM to WAV. DELETING: transcoder is deleting metadata file and CPM file.)
SESCTIVM session number.
VM-StateCTIVM session state. (READY: session is READY for incoming call. OGM: session is playing OGM message. OGM-BEEP: session is playing BEEP pattern after having played OGM message. RECORDING: session is recording to WAV or to CPM. END-BEEP: session is playing BEEP pattern prior to play END message. END: session is playing END message.)
UserCTIVM session current user name.
Q931-stateCTIVM session Q931 state. (DISCONNECTED: session is disconnected. 04-REM-ALERT: session received a call from CTIR and is alerting. 10-CONNECTED: session is connected)
CGCTIVM session current calling number.
CDCTIVM session current called number.
[10:52:40] ABILIS_CPX:d d ctivm
RES:CtiVm ---------------------------------------------------------------------
CTI_Voice_Mail_service
STATE:ACTIVE MAILER-STATE:WAITING TC-STATE:WAITING
------------------------------------------------------------------------
SES: VM-State User
Q931-State CG CD
------------------------------------------------------------------------
0 READY
00-DISCONNECTED
------------------------------------------------------------------------
1 READY
00-DISCONNECTED
------------------------------------------------------------------------
2 READY
00-DISCONNECTED
------------------------------------------------------------------------
3 READY
00-DISCONNECTED
------------------------------------------------------------------------
4 READY
00-DISCONNECTED
------------------------------------------------------------------------The following command is used to display the statistics of the CTIVM resource:
it shows the statistics of the CTIVM resource such as the total number of successfully sent mails (SENT), the total number of successfully transcoded CPM files (TRANSCODED).
[11:59:31] ABILIS_CPX:d s ctivm
RES:CtiVm ---------------------------------------------------------------------
CTI_Voice_Mail_service
--- Cleared 2 days 22:12:11 ago, on 05/06/2015 at 14:04:01 -------------
-----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
SENT | | 0|TRANSCODED | | 0|
------------------------------------------------------------------------VM can be configured using the users' CTI preferences or the CTI advanced preferences.
| Tip |
|---|---|
Interesting chapter: Section 57.10, “Voice Mail”. |
Each interface has its own VM parameters.
[09:31:49] ABILIS_CPX:d pref user:test2
Parameter: | Value:
--------------------+----------------------------------------------------------
USER: test2
ID: 5 <Read Only>
LAST-CHANGE: 05/05/2015 16:55:59 CET <Read Only>
PWD: ***
--------------------
CTIP-CLIP: SYS
CTIP-ACTION: ADVANCED
CTIP-CF-RULE: ALWAYS
CTIP-CF-TOUT: 15
CTIP-CF-DLY: 10
CTIP-CF-CDO: ux#
CTIP-CF-CGO: *
CTIP-VM: NO
CTIP-VM-RULE: NOANS,OTHERS
CTIP-VM-TOUT: 15
--------------------
CLUS-CLIP: SYS
CLUS-ACTION: ADVANCED
CLUS-CF-RULE: ALWAYS
CLUS-CF-TOUT: 15
CLUS-CF-DLY: 10
CLUS-CF-CDO: ux#
CLUS-CF-CGO: *
CLUS-VM: NO
CLUS-VM-RULE: NOANS,OTHERS
CLUS-VM-TOUT: 15
--------------------
IAX-CLIP: SYS
IAX-ACTION: ADVANCED
IAX-CF-RULE: ALWAYS
IAX-CF-TOUT: 15
IAX-CF-DLY: 10
IAX-CF-CDO: ux#
IAX-CF-CGO: *
IAX-VM: NO
IAX-VM-RULE: NOANS,OTHERS
IAX-VM-TOUT: 15
--------------------
SIP-CLIP: SYS
SIP-ACTION: ADVANCED
SIP-CF-RULE: ALWAYS
SIP-CF-TOUT: 5
SIP-CF-DLY: 10
SIP-CF-CDO: ux12
SIP-CF-CGO: *
SIP-VM: YES
SIP-VM-RULE: NOANS,OTHERS
SIP-VM-TOUT: 5
--------------------
VM-RCPT-LIST: #
VM-RCPT: test@antek.it
VM-OGM-MSG: Message1
VM-END-MSG: SYS
--------------------
MAIL-FAIL: NO
MAIL-FAIL-RCPT-LIST: #
MAIL-FAIL-RCPT:
MAIL-FWD: NO
MAIL-FWD-RCPT-LIST: #
MAIL-FWD-RCPT:
SEIZED-CALLS: NO
--------------------
CTI-CALLS-LOG: YES
CTI-CALLS-LOG-IN: 30
CTI-CALLS-LOG-OUT: 30
--------------------
CALLTRY-TOUT: SYS
CALLTRY-NRTY: SYS
--------------------
TON-TO-PREFIX: SYS
-------------------------------------------------------------------------------Meaning of parameters:
CTIP-VMVoice mail activation/deactivation [NO, YES]. Default is NO.
CTIP-VM-RULEVoice mail rule [ALWAYS, BUSY, NOANS, OTHERS]. Values [BUSY, NOANS, OTHERS] can be joined using ',' character. Default is NOANS,OTHERS.
CTIP-VM-TOUTVoice mail: Time-out for the 'NOANS' rule [5..180 sec.]. Default is 15.
CLUS-VMVoice mail activation/deactivation [NO, YES]. Default is NO.
CLUS-VM-RULEVoice mail rule [ALWAYS, BUSY, NOANS, OTHERS]. Values [BUSY, NOANS, OTHERS] can be joined using ',' character. Default is NOANS,OTHERS.
CLUS-VM-TOUTVoice mail: Time-out for the 'NOANS' rule [5..180 sec.]. Default is 15.
IAX-VMVoice mail activation/deactivation [NO, YES]. Default is NO.
IAX-VM-RULEVoice mail rule [ALWAYS, BUSY, NOANS, OTHERS]. Values [BUSY, NOANS, OTHERS] can be joined using ',' character. Default is NOANS,OTHERS.
IAX-VM-TOUTVoice mail: Time-out for the 'NOANS' rule [5..180 sec.]. Default is 15.
SIP-VMVoice mail activation/deactivation [NO, YES]. Default is NO.
SIP-VM-RULEVoice mail rule [ALWAYS, BUSY, NOANS, OTHERS]. Values [BUSY, NOANS, OTHERS] can be joined using ',' character. Default is NOANS,OTHERS.
SIP-VM-TOUTVoice mail: Time-out for the 'NOANS' rule [5..180 sec.]. Default is 15.
VM-RCPT-LISTIN2T list used to select Voice Mail recipient(s) on the base of called numbers [#, ListName].
VM-RCPTDefult Voice Mail recipient(s). From 0 up to 128 ASCII printable characters. Spaces are not allowed. Case is preserved.
VM-OGM-MSGName of the file holding the Outgoing Message. "SYS" or from 1 up to 20 characters. Names holding spaces must be written between quotation marks (E.g.: "My message"). Default is SYS.
VM-END-MSGName of the file holding the End Message. "SYS" or from 1 up to 20 characters. Names holding spaces must be written between quotation marks (E.g.: "My message"). Default is SYS.
VM can be configured through CTI advanced preferences. Type the command below to view the CTI advanced preferences rules.
[09:55:44] ABILIS_CPX:d cf user:test2
USER:test2 (Last change: 06/05/2015 09:55:57 CET)
------------------------------------------------------------------------------
PR |ENABLED|IN-USE|IF |TI |ACTION
ADMIN|CGI |CDI |RULE
|CGO |CDO |TOUT |DLY |FORK-TYPE
------------------------------------------------------------------------------
1 YES YES ANY ALL,00:00-23:59 VM
NO * * NOANS,OTHERS
15
------------------------------------------------------------------------------VM can be activated setting the ACTION
parameter to VM.
In the previous example, VM is activated (ACTION:VM) for every interface (IF:ANY), at any time (TI:ALL,00:00-23:59), if user test2 doesn't answer, or for any other cause, (RULE:NOANS,OTHERS) after 15 seconds (TOUT:15).
Assume to have two sip users: test2 (with sip number 11) and test3 (with sip number 12).
[16:26:28] ABILIS_CPX:d user
------------------------+-------------+----------------------------------------
USER PWD ACT|CTIP CLUS |CHAT LDAP PPP FTP HTTP MAIL IAX SIP VO
------------------------+-------------+----------------------------------------
admin *** YES # # NO YES YES YES YES NO NO NO NO
guest NO # # NO NO NO NO NO NO NO NO NO
test2 *** YES # # NO NO NO NO NO NO NO YES NO
test3 *** YES # # NO NO NO NO NO NO NO YES NO
The voice mail settings are stored in users' preferences. Type the following command to show the settings for test2 user:
[16:31:35] ABILIS_CPX:d pref user:test2
- Not Saved (SAVE CONF) -------------------------------------------------------
Parameter: | Value:
--------------------+----------------------------------------------------------
USER: test2
ID: 5 <Read Only>
LAST-CHANGE: 21/05/2015 16:31:26 CET <Read Only>
PWD: ***
...
--------------------
SIP-CLIP: SYS
SIP-ACTION: ADVANCED
SIP-CF-RULE: ALWAYS
SIP-CF-TOUT: 5
SIP-CF-DLY: 10
SIP-CF-CDO: ux12
SIP-CF-CGO: *
SIP-VM: NO
SIP-VM-RULE: NOANS,OTHERS
SIP-VM-TOUT: 15
--------------------
VM-RCPT-LIST: #
VM-RCPT:
VM-OGM-MSG: SYS
VM-END-MSG: SYS
--------------------
...These settings show that the voice mail service is not activated because SIP-VM parameter is set to NO. Change the parameters values in the following way:
[16:38:13] ABILIS_CPX:s pref user:test2 sip-vm:yes vm-rcpt:test@antek.it
COMMAND EXECUTED
[16:39:14] ABILIS_CPX:d pref user:test2
- Not Saved (SAVE CONF) -------------------------------------------------------
Parameter: | Value:
--------------------+----------------------------------------------------------
USER: test2
ID: 5 <Read Only>
LAST-CHANGE: 21/05/2015 16:39:14 CET <Read Only>
PWD: ***
...
--------------------
SIP-CLIP: SYSV
SIP-ACTION: ADVANCED
SIP-CF-RULE: ALWAYS
SIP-CF-TOUT: 5
SIP-CF-DLY: 10
SIP-CF-CDO: ux12
SIP-CF-CGO: *
SIP-VM: YES
SIP-VM-RULE: NOANS,OTHERS
SIP-VM-TOUT: 15
--------------------
VM-RCPT-LIST: #
VM-RCPT: test@antek.it
VM-OGM-MSG: SYS
VM-END-MSG: SYS
--------------------
...The call is passed to the voice mail after 15 seconds
(SIP-VM-TOUT) If test2 doesn't answer.
[16:47:09] ABILIS_CPX:start ldme
Current Local Time: Thursday 21/05/2015 16:47:22 (UTC+2.00)
Start Debug Log content real-time logging (Type CTRL+C + ENTER to stop):
Date Time Resource Ses Event Parameters
------ ------ ---------- ----- -------------- ---------------------------------
210515 164726 CtiSip 8 E-CallRx CH:7 BC:Speech CD:ue11 CG:uxq10
USER:test
210515 164726 CtiSip 8 E-Route Match PR:9 TYPE:StoS
210515 164726 CtiSip 8 E-CallTx BC:Speech TY:StoS CD:ue11
CG:uxq10
210515 164726 CtiSip 8 E-NumComplete CDI:ue11 CDO:ue11
210515 164726 CtiSip 8 E-AlertRx CH:8 USER:test2
210515 164726 CtiSip 8 E-AlertTx CH:7
210515 164741 CtiSip 0 E-VoiceMail RULE:NOANS USER:test2
210515 164741 CtiSip 9 E-CallRx AS:CtiVm CH:9 BC:Speech CD:ue11
CG:uxq10 RG:uxay11 USER:test2
210515 164741 CtiSip 9 E-Route Match PR:INT TYPE:*toA
210515 164741 CtiVm 9 E-CallTx AS:CtiVm BC:Speech TY:StoA
CD:ue11 CG:uxq10 RG:uxay11
210515 164741 CtiSip 9 E-NumComplete CDI:ue11 CDO:ue11
210515 164741 CtiSip 10 E-CallTransfer SES/ID-IN:9 SES/ID-OUT:8
210515 164741 CtiVm 10 E-ConnRx CH:3 USER:test2
210515 164741 CtiSip 10 E-ConnTx CH:7
210515 164832 CtiSip 10 E-DiscRx CH:7 CAUSE:80 9F (U, Normal,
unspecified) USER:test
210515 164832 CtiSip 10 E-DiscConfTx CH:7
210515 164832 CtiVm 10 E-DiscTx CH:3 CAUSE:80 9F (U, Normal,
unspecified) USER:test2An e-mail (with the following text) is sent from Abilis to the recipient specified in the VM-RCPT parameter. The e-mail has a wav file as attachment.
| Tip |
|---|---|
Interesting chapter: Section 57.10, “Voice Mail”. |
| Tip |
|---|---|
Configure the smtp resource to let Abilis send e-mails. |
| Tip |
|---|---|
The e-mails sender can be configured by MAIL-FROM parameter of CTISYS resource. |
A new kind of routing is available (*toA) to manage calls toward Abilis advanced services. Two hidden rules are always inside the CTIR:
a rule to encode a call on-the-fly, so that the file is directly saved in WAV format (one DSP per call is used);
a rule to save the call in its original format (used if there's no free DSP); the file is encoded in the WAV format when a DSP is free.
These rules are called INT rules (INTernal).
[16:47:09] ABILIS_CPX:start ldme
Current Local Time: Thursday 21/05/2015 16:47:22 (UTC+2.00)
Start Debug Log content real-time logging (Type CTRL+C + ENTER to stop):
Date Time Resource Ses Event Parameters
------ ------ ---------- ----- -------------- ---------------------------------
210515 164726 CtiSip 8 E-CallRx CH:7 BC:Speech CD:ue11 CG:uxq10
USER:test
210515 164726 CtiSip 8 E-Route Match PR:9 TYPE:StoS
210515 164726 CtiSip 8 E-CallTx BC:Speech TY:StoS CD:ue11
CG:uxq10
210515 164726 CtiSip 8 E-NumComplete CDI:ue11 CDO:ue11
210515 164726 CtiSip 8 E-AlertRx CH:8 USER:test2
210515 164726 CtiSip 8 E-AlertTx CH:7
210515 164741 CtiSip 0 E-VoiceMail RULE:NOANS USER:test2
210515 164741 CtiSip 9 E-CallRx AS:CtiVm CH:9 BC:Speech CD:ue11
CG:uxq10 RG:uxay11 USER:test2
210515 164741 CtiSip 9 E-Route Match PR:INT TYPE:*toA
210515 164741 CtiVm 9 E-CallTx AS:CtiVm BC:Speech TY:StoA
CD:ue11 CG:uxq10 RG:uxay11
210515 164741 CtiSip 9 E-NumComplete CDI:ue11 CDO:ue11
210515 164741 CtiSip 10 E-CallTransfer SES/ID-IN:9 SES/ID-OUT:8
210515 164741 CtiVm 10 E-ConnRx CH:3 USER:test2
210515 164741 CtiSip 10 E-ConnTx CH:7
210515 164832 CtiSip 10 E-DiscRx CH:7 CAUSE:80 9F (U, Normal,
unspecified) USER:test
210515 164832 CtiSip 10 E-DiscConfTx CH:7
210515 164832 CtiVm 10 E-DiscTx CH:3 CAUSE:80 9F (U, Normal,
unspecified) USER:test2The wdir parameter of CTIVM resource specify which is the working directory on the CF. The default value is C:\APP\VM\.
A user can choose to use system default messages (stored in system folder) or customized messages (stored in USER folder).
| Tip |
|---|---|
Interesting chapter: Section 58.3.1, “CTI preferences administration through Web interface”. |
| |  | |
| 51.1. CTIAS - CTI Advanced Services |  | Chapter 52. CTISMS - CTI SMS resource |
