Alcatel 4635 Voice and Fax Messaging
Whats best for your company? Customers who are in touch, or those who receive no answer and hang up? Whats best in your company? Teams who constantly exchange information, or employees who can never reach each other? Not much doubt. So perhaps you should opt for Alcatels flagship 4635 Voice & Fax Messaging system. It keeps you talking.
The Alcatel 4635 networking capabilities provide all these features beyond a single site to the whole company. Indeed, beyond your company, to suppliers, partners, customers. That makes you a true Borderless Enterprise.
Being responsive with ease
The best of Voice Messaging Services to keep your communications going. The Alcatel 4635 streamlines your operations and saves everyone time thanks to its powerful and flexible greeting capabilities, information access, and delivery functions. Flexible individual greetings - the users individualized welcome center, simple but efficient, with a selection of greetings, standard or personalized for different situations no reply, busy, or extended absence. A wealth of message notification possibilities users at their desk get LED, icon, or voice guides on their phone sets or message notification in their e-mail client of choice (more on this later); users on the move can be notified on any specified telephone or pager number. In addition, SMS notification for GSM sets is available as a turnkey solution through the Alcatel Application Partner Program.
The Alcatel 4635 is an industry-leading voice messaging solution, seamlessly integrated in the Alcatel OmniPCX Enterprise business communications system. Its natural, intuitive Alcatel Advanced Reflexes Telephone User Interface saves you time and makes you efficient. And your staffs reachability is vastly simplified, since the Alcatel Ubiquity Solution allows everyone to hand out just a single telephone number. Then theres the Alcatel Visual Messenger it integrates Lotus Notes and
Microsoft Outlook e-mail clients to enhance
your messaging power and versatility. And since the Alcatel 4635 now supports the IMAP4 standard, your users can access their voice mail right from their e-mail client of choice no need to reconfigure all the workstations.

Alcatel 4635

Powerful message manipulation capabilities to keep everyone up to speed every message can be shared, easily replied to, or forwarded to one or more recipients, tagged urgent for faster delivery, tagged private for confidentiality. Then you may want to record a conference call and sent it to absentees. Thats Record-on-Line, helping you improve efficiency and save resources.
The Automated Attendant can offload your contact center or customer services department by providing callers with information about your company or a specific department. It gives callers a series of choices, such as obtaining the voice information service, calling a specific contact, or simply leaving a message, etc. But the key advantage of the Automated
The result is enhanced collaboration between the employees of the Borderless Enterprise and a boost to customer care. Reflexes ease of use All these features and functions are made easy by the superior ergonomics of the intuitive messaging interface on Alcatel Reflexes sets. So your user efficiency increases thanks to several unique features such as mailbox content overview, message envelope information display, and full soft key guidance. The learn and use interface makes operation easy for everyone. (And remember, smooth and rapid learning reduces your costs.) That said, you can use any set to access the Alcatel 4635 voice mail service internal or external to the Alcatel OmniPCX Enterprise.

Attendant is that it keeps callers communicating with you, not with competitors!

More mobility

Alcatels Ubiquity solution, in association with the Alcatel 4635, gives your mobile workforce a new dimension in efficiency and accessibility. This one number, one voice mail solution guarantees your mobile staff full access to all voice and fax mail services. They can record a welcome message to fit their changing geography, forward calls from their desktop set, and more. For people who are off site, the Ubiquity solution integrates cellular phones, offering a personal voice assistant for incoming calls, but also enabling staff to be contacted on their cellular phones in urgent situations.
Automated Attendant an enterprise welcome service
The Alcatel 4635 does more than enable your staff to leave and receive voice messages. It can act as a full-featured enterprise welcome service especially important for taking external callers in hand and ensure that no calls go unanswered. The Automated Attendant can guide callers to one of your departments or employees. It also provides your switchboard with additional support during peak periods.

Faxes too

The Alcatel 4635s fax capability delivers substantial added value your voice mail by: storing voice and fax in a single, universal mailbox adding voice annotations to faxes fax store and forward - fax overflow fax broadcast - fax on demand viewing, printing, and composing faxes.

>2 A L C AT E L

One for all. voice fax e-mail
What about putting all your messaging together into a single platform combining the versatility of your PC with the Alcatel 4635s wealth of messaging functions? Thats the advantage of the Alcatel 4635 Visual Messenger, integrating voice/fax messages into Microsoft Outlook and Lotus Notes. Visual Messenger enables you to put the power of the Alcatel 4635s voice/fax messaging into your existing e-mail environment. The Alcatel 4635 Visual Messenger also enables users to view and send faxes from the PC desktop (Adobe Acrobat
the possibility to view your entire voice, fax, and e-mail message queues on your client of choice efficient message review with the screen player message folders/archives store voice/fax messages in e-mail folders, forward voice/fax messages as e-mail messages, etc. And you get this without the headaches your prior investments are safe, your growth strategy is safe, and your budget is safe because there are no further deployment costs to come. In short, no impact on your workstations, your e-mail infrastructure, your future plans.
and Microsoft Office documents), reducing your need for fax machines, servers, or modems.
Networking solutions to fit your enterprise

The Alcatel 4635 is a key enabler for streamlining information exchange in multi-site or multinational companies. All its features and productivity enhancements can span your entire enterprise through seamless networking. Basic networking Basic networking uses the Audio Messaging Interchange Specification (AMIS) for sending, receiving, or replying to voice mail, plus notification of undelivered messages. Just use AMIS when you need to network with other vendors plain old voice mail systems.

More messaging

The good news is that the Alcatel 4635 is an open system, providing a standard IMAP4 interface to the messages stored on it. All major vendors of electronic mail systems commonly support the IMAP4 standard. So regardless of the client you use Lotus Notes (Release 5 and above), Microsoft Outlook , Outlook Express, Netscape
Alcatel OmniPCX 4400 Alcatel 4635
Alcatel OmniPCX Enterprise Alcatel 4635
(Analog fall back) Ethernet LAN PC PC PC
Messenger you can review your Alcatel 4635 mailbox alongside your other e-mail accounts. That adds up to outstanding message management: a single sign-in for your e-mail and voice/fax messages

Ethernet LAN

Router

IP Network

A L C AT E L 3>
You are not alone To help with support, guidance, and training, Alcatel has built up a dense network of skilled business partners across the world. You can be sure that there's an Alcatel Business Partner nearby, ready with its experience and know-how to support and counsel you. They'll guide you as to how to best configure your Alcatel 4635 based on your current or planned installation. They will install it and maintain it. They will also provide you with training so that you make the most of your Alcatel 4635.
VPIM networking the ultimate in openness Voice Profile for Internet Mail (VPIM) establishes an internationally accepted standard ESMTP/MIME profile, enabling you to swap voice and fax messages between messaging systems. It also allows inter-working with non-voice messaging MIME-compatible e-mail systems. VPIM now enables you to build heterogeneous
Octel Networking - the ultimate in simplicity Octel Networking is your solution of choice to build a reliable, cost-effective, and feature-rich voice and fax-messaging network. Your employees will message their contacts wherever they are as easily as if they where on their own Alcatel 4635 system. And your system administrator will operate the entire network as easily as a single machine. In combination with the Alcatel OmniPCX Enterprise, you can set up a single point of management, homogeneous network addressing, and synchronized directories. Voice mail networking over IP the ultimate in scalability Octel IP networking allows transparent multi-site voice mail networking using your existing IP data network for message delivery. You can create a virtual voice mail system and lower communication costs, enhance transmission quality, speed up delivery, and improve message security. Features include: up to six Alcatel 4635 servers, 40,000 name entries up to 384 ports global automated attendant voice compression (a one-minute message is only 240 Kbytes) message encryption.

messaging networks; so mergers or partnerships no longer have to be painful. Even linking customers and suppliers is easy. VPIM will kick in when you want to build a mixed network of Alcatel 4635s and 4645s.
Configurations and capacity
Alcatel 4635 J Number of mailboxes 15,000 Recording time 40 Hours Alcatel 4635 H 15,hours (standard) 210 hours (GMR*) 4-64 ports nodes 4 ports10 hours
Simultaneous accesses Simultaneous languages Voice mail systems in a network Basic configuration
2-16 ports nodes 2 ports10 hours
* GMR stands for Global Message Redundancy, an optional software solution that replicates the system, the database, and messages over redundant disks.
4276660 - GB - 08/2003 - 2003 - Alcatel Business Systems - 32, avenue Klber 92707 Colombes - France - RCS Paris B 185 - This document does not constitute a contract - The functions mentioned are country-specific and availability depends on the public network to which systems are connected Alcatel reserves the right to modify characteristics without prior notice - All trademarks are the property of their companies - Photo: M. Langot, Digitalvision - Printed in EEC on chlorine-free paper - 5318

XML Messaging Web Service

Developers Guide

Platform
Alcatel Lucent OmniPCX Enterprise Alcatel Lucent OmniPCX Office XMLMessaging Web Service R5.0 Edition 5.0.0 February 2007 My Messaging
Interface Version Revision Licenses

Abstract

This guide addresses application developers who want to design applications for handling voice messages.
[This documentation is subject to change without notice]
Alcatel Lucent Application Partner Program (AAPP)

TABLE OF CONTENTS

1 ABOUT THIS GUIDE.... 5 1.1 WHO SHOULD READ THIS GUIDE.... 5 1.2 WHAT THIS GUIDE TELLS YOU.... 5 1.3 RELATED DEVELOPERS GUIDES.... 5 1.4 TERMINOLOGY DEFINITIONS... 6 1.4.1 Glossary.... 6 1.4.2 Abbreviations.... GENERAL PRINCIPLES..... 11 2.1 2.2 2.3 2.4 2.ARCHITECTURE..... 11 TOPOLOGY - TYPE OF CONFIGURATION... 12 HARDWARE ASPECTS.... 12 SOFTWARE ASPECTS.... 12 INTERFACES..... 12
DESCRIPTION..... 13 3.1 GENERAL PRINCIPLES.... 13 3.2 PREREQUISITES..... 13 3.3 OPERATIONS SUMMARY.... 13 3.4 GENERAL OPERATIONS..... 14 3.5 SESSION MANAGEMENT.... 14 3.5.1 login..... 14 3.5.2 logout..... 16 3.5.3 getCapabilities.... 17 3.5.4 getStatus.... 18 3.6 MEDIA SESSION.... 19 3.6.1 dial..... 19 3.6.2 play.... 21 3.6.3 stop..... 23 3.6.4 pause..... 24 3.6.5 record..... 25 3.6.6 forward.... 27 3.6.7 append..... 29 3.6.8 send.... 30 3.6.9 cancel..... 32 3.6.10 callback..... 33 3.6.11 abort..... 35 3.6.12 hangup.... 36 3.7 MESSAGES MANAGEMENT..... 37 3.7.1 loadMessages.... 37 3.7.2 getCounters.... 38 3.7.3 setOrder.... 39 3.7.4 setFilter..... 40 3.7.5 getMessages.... 41 3.7.6 getIndexOf.... 42 3.7.7 deleteMessages.... 43 3.7.8 deleteAllMessages.... 44 3.7.9 getMessageUrl.... 45 3.7.10 getDraftUrl.... 46 3.8 COMMON FAULTS.... 47 3.9 SERVICE FAULTS..... 48 3.10 TYPES.... 50 3.10.1 IMCommands.... 50 3.10.2 IMState.... 51
AAPP XML Messaging WS Developers Guide
Copyright 2007 Alcatel Lucent, All rights reserved

Edition 5.0.0 Page 2

3.10.3 3.10.4 3.10.5 3.10.6 3.10.7 3.10.8 3.10.9 3.10.10 3.10.11 3.10.12 3.10.13 3.10.14 3.10.15 3.10.16 3.10.17 3.10.18 3.10.19 3.10.5
IMResult.... 51 AlcSessionResult.... 51 IMCapabilities.... 52 IMPlayResult..... 53 IMPauseResult.... 53 IMDestination..... 53 IMMsgPriority.... 54 IMMsgSensitivity.... 54 IMSendHeaders.... 54 IMSendResultCause.... 55 IMSendResultItem..... 55 IMSendResult.... 55 IMMsgType..... 55 IMMsgCounters.... 56 IMMsgField..... 56 IMMsgSortingField.... 57 IMMsgHeader.... 57 IMGetResult.... 57
XMLMESSAGING STATES.... 58 CAPABILITIES VERSUS VOICE MAILS.... 62

Edition 5.0.0 Page 3

History of the document
Edition 3.1.0 Edition 3.1.1 Edition 3.1.2 Edition 3.1.3 Edition 3.1.4 Edition 5.0.0 - February 2006: - March 2006: - April 2006: - May 2006: - July 2006: - February 2007 creation of the document based on R3.0 interface modification (Release 3.1) modifications following documentation review Release 3.1 finalization Release 3.1 finalization APIR4.0 is renamed APIR5.0

References

[1] XML Web Services [2] XML Web Services [3] XML API Framework Web Service [4] XML Framework Management Web Service - White Paper - Technical Overview - Developers Guide - Developers Guide
Copyright 2007 by Alcatel Lucent. Product specifications contained in this document are subject to change without notice. This document may not be reproduced in whole or in part without the express written permission of Alcatel Lucent. Alcatel Lucent and the Alcatel Lucent logo are registered trademarks of Alcatel Lucent. All other trademarks are the property of their respective owners.

Edition 5.0.0 Page 4

1 ABOUT THIS GUIDE
1.1 Who Should Read This Guide
This guide is for developers willing to develop applications communicating with Alcatel Lucent OmniPCX range. The reader should be familiar with XML and HTTP technologies.
1.2 What This Guide Tells You
This guide is part of the Alcatel Lucent XML Web Services open interfaces that help to design applications for Alcatel Lucent OmniPCX. XMLMessaging Web service provides efficient voice messages management whatever the existing voice mail system, would it be Unified messaging (when voice mail are physically stored on e-mail servers) or Integrated messaging (when voice messages are physically stored on legacy voice mail system : 46x5 or OXO). XMLMessaging Web service proposes a powerful Web interface to access to voice messages, enabling the user to listen to his messages with the chosen device and to manage his messages from his working desktop environment. The Web service also provides efficient forward capabilities enabling a received message to be sent to anyone. This document does not present any examples. Examples can be found in the source code of starter applications.

Edition 5.0.0 Page 15

3.5.2 logout
logout( string pFwSessionId, string pSvcSessionId)
Terminates the given Voicemail Session specified by the pSvcSessionId parameter and cleans up associated resources. The session identifier is no longer valid and no further session-related command may be issued until a new Voicemail Session is obtained using login. A logout may be issued at any time within a Voicemail Session, and causes the Voicemail Server to hang up the call if a Media Session was in progress. Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session

string pSvcSessionId

Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 16

3.5.3 getCapabilities
getCapabilities( string pFwSessionId, string pSvcSessionId) Return IMCapabilities
Retrieves the capabilities supported by the underlying Voicemail Server for which a Voicemail Session has been established (specified by the pSvcSessionId parameter). Request parameters
Response parameter The capabilities (see IMCapabilities for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 17

3.5.4 getStatus
getStatus( string pFwSessionId, string pSvcSessionId) Return IMResult
Retrieve the current state and the available commands of the given session (specified by the pSvcSessionId parameter). Request parameters
Response parameter The current session's state and the related available commands (see IMResult for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 18

3.6 Media session

3.6.1 dial

dial( string pFwSessionId, string pSvcSessionId, string pPhoneNumber, boolean pBlocking) Return IMResult
The dial command initiates a phone call to establish a Media Session within the Voicemail Session identified by the given pSvcSessionId. The dialed phone number is : the optional pPhoneNumber if the Voicemail Server supports it (see getCapabilities operation) the number given upon login, if any the users default Business Phone Number in all other cases

Response parameter The current position, the current session's state and the related available commands (see IMPauseResult for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 24

3.6.5 record
record( string pFwSessionId, string pSvcSessionId, string pPhoneNumber) Return IMResult
Start recording a voice message, after initially calling the users phone number if necessary. The command starts or restarts recording a new voice message, depending on the current state of the Voicemail Session. If a Media Session is not already established, a phone call is first initiated using the given pPhoneNumber, or the number given upon login if any, or the default Business Phone Number if either were specified. The Voicemail Server then automatically proceeds to the next step. When a Media Session is established, the Voicemail Server starts recording a new voice message. Record may also be used after a recording has started or a stop command has been issued, in which case the current recording is discarded and a new one starts.
The recording may be interrupted by the following events : The user hangs up the phone set or a hangup command is received. The Media Session is terminated but the recorded message can still be sent or retrieved using the getDraftUrl command The maximum recording time is reached or one of stop, play, send or getDraftUrl command is received. Either a cancel, callback or a play command with a message Id is received, in which case the recording is discarded. A logout command is received. The recorded message is discarded.
If successful, the command returns when the recording starts. The newly recorded message is not sent until the send command is received.

Edition 5.0.0 Page 25

Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session An optional phone number, used to specify a different phone number from the default one
string pSvcSessionId string pPhoneNumber

Edition 5.0.0 Page 26

3.6.6 forward
forward( string string string string Return IMResult pFwSessionId, pSvcSessionId, pPhoneNumber, pMessageId)
Start recording an introduction to an existing message to be forwarded, after initially calling the user's phone number if necessary. If a Media Session is not already established, a phone call is first initiated using the given pPhoneNumber, or the number given upon login if any, or the default Business Phone Number if either were specified. The Voicemail Server then automatically proceeds to the next step. When a Media Session is established, the Voicemail Server starts recording a new voice message. The given message identifier (pMessageId parameter) must refer to an existing voice message, and the recording is treated as a voice annotation that will eventually be sent along with the existing message.

The newly recorded message is not sent until the send command is received. If successful, the command returns when the recording starts.

Edition 5.0.0 Page 27

string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session An optional phone number, used to specify a different phone number from the default one Message identifier.
string pSvcSessionId string pPhoneNumber string pMessageId

Edition 5.0.0 Page 28

3.6.7 append
append(string pSvcSessionId) Return IMResult
Resume the recording of a voice message. Used to resume the recording of a voice message that has previously been stopped. The recording is appended to the end of the current voice message. Request parameters

Edition 5.0.0 Page 29

3.6.8 send
send( string pFwSessionId, string pSvcSessionId, IMDestination[] pDestinations, IMSendHeaders pHeaders) Return IMSendResult
Send a recorded message to a list of destinations. Sends the message currently being recorded to a list of destinations identified by the given array of IMDestination objects. Each destination must at least contain one of following : a mailbox number : the message is sent as a voice message a VPIM address : the message is sent as a VPIM mail a regular email address : the message is sent as an email with a WAVE file attachment
Additionnally, an IMDestination object must be assigned a unique key that will be used to identify failed destinations upon return. If the recording had been initiated by a forward command, the recording is sent along with the original message. If the send command is sent while still recording, a NO_MESSAGE error may be returned if the recorded message turns out blank or too short to qualify as a valid message. The send command returns an array of IMSendResultItem objects representing failed destinations. An empty or null list denotes success for all destinations. Each IMSendResultItem object associates one of the given destination keys to an IMSendResultCause enumerated value identifying the actual cause of the failure.

Edition 5.0.0 Page 30

IMDestination [] pDestinations List of destinations IMSendHeaders pHeaders Headers of the message to be sent
Response parameter An updated list of failed and embedded destinations, the current session state and the related available commands (see IMSendResult for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 31

3.6.9 cancel
cancel( string pFwSessionId, string pSvcSessionId) Return IMResult
Cancel and discard the message that has been or is currently being recorded. Request parameters

Edition 5.0.0 Page 32

3.6.10 callback
callback( string pFwSessionId, string pSvcSessionId, string pPhoneNumber, string pMessageId, boolean pBlocking) Return IMResult
The callback command causes the Voicemail Server to dial the number associated with the originator of a voice message. If a Media Session is not already established, a phone call is first initiated using the given pPhoneNumber, or the number given upon login if any, or the default Business Phone Number if neither were specified. The Voicemail Server then automatically proceeds to the next step. When a Media Session is established, the number of the originator of the voice message is dialed, and a transfer occurs once the call is established, causing the Media Session with the Voicemail Server to terminate. The voice message may be specified by the pMessageId parameter, or the current voice message being played.
If pBlocking is true, the callback command does not return until the call is either answered or a certain amount of time has elapsed, upon which a IMException fault NO_ANSWER is returned. The amount of time waited for the call to be answered is controlled by the Voicemail Server. Provided the Voicemail Server supports non-blocking calls, setting blocking to false makes the command return immediately and the Application has no way of knowing the outcome of the call. An abort or a hangup command may be sent to interrupt the call transfer, regardless of the blocking setting.

Edition 5.0.0 Page 33

string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session An optional phone number, used to specify a different phone number from the default one Message identifier. Blocking or non-blocking call

string pSvcSessionId string pPhoneNumber string pMessageId boolean pBlocking

Edition 5.0.0 Page 34

3.6.11 abort
abort( string pFwSessionId, string pSvcSessionId)
Abort an ongoing command. Request parameters

Edition 5.0.0 Page 35

3.6.12 hangup
hangup( string pFwSessionId, string pSvcSessionId) Return IMResult
Terminates the Media Session. Causes the Voicemail Server to hangup the call, this terminating the Media Session. If a message had been or was being recorded, it is discarded. Request parameters

Edition 5.0.0 Page 36

3.7 Messages management

3.7.1 loadMessages

loadMessages( string pFwSessionId, string pSvcSessionId, IMMsgType[]pFilters) Return IMMsgCounters
The internal message list managed by the Service acts as a buffer of message entries between Applications and the underlying Voicemail Servers. The loadMessages command fills the buffer with the actual message entries of the Mailbox. The content of the buffer may be restricted to certain types of messages as specified by the IMMsgType objects for each authorized type of message. The computed number of messages for each type is returned using an IMMsgCounters object. The pFilters parameter may be set to null to signify no filtering is to be applied, in which case the internal message list buffer represents the entire content of the Mailbox. Else, the list must contain the type of messages that are to be loaded : consult the voicemail capabilities to know which kind of messages can be loaded (an unsupported type will be ignored). Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session The list of message types to be loaded.
string pSvcSessionId IMMsgType[] pFilters
Response parameter The number of loaded messages by type and by read / unread status (see IMMsgCounters for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 37

3.7.2 getCounters
getCounters( string pFwSessionId, string pSvcSessionId) Return IMMsgCounters
The returned object IMMsgCounters contains the number of messages as computed when the internal message list buffer was created or last refreshed by the loadMessages command. If the internal message list buffer hasn't been created yet, a load is automatically performed and the numbers computed. Otherwise, only an explicit loadMessages will guarantee accurate numbers. For each type, the IMMsgCounters object distinguishes the number of new or unread messages versus the total amount. Request parameters

Edition 5.0.0 Page 38

3.7.3 setOrder
setOrder( string pFwSessionId, string pSvcSessionId, IMMsgSortingField[]pSortingFields)
The sort order is applied to the internal message list buffer for each IMMsgSortingField element, in the order provided in the pSortingFields array. Request parameters
IMMsgSortingField [] pSortingFields A set of sorting fields. The order is important : the list of messages is sorted according to the first field, then the resulting list is sorted according to the second, etc

Edition 5.0.0 Page 39

3.7.4 setFilter
setFilter( string pFwSessionId, string pSvcSessionId, IMMsgType[]pFilters)
The setFilter command is used to apply further restrictions on the types of messages that will be returned via the getMessages command. Unlike the filtering initially applied by the loadMessages command, this filtering does not modify the internal message list buffer. The pFilters argument may be set to null to signify no filtering is to be applied, in which case getMessages has access to the entire content of the internal message list buffer. Else, the list must contain the type of messages that are to be retrieve. Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session The list of filters applied to the internal list

Edition 5.0.0 Page 40

3.7.5 getMessages
getMessages( string pFwSessionId, string pSvcSessionId, integer pIndex, integer pNbItems) Return IMMsgHeader[]
The command returns a sub list of the internal message list buffer, starting at the given position pIndex and containing at most pNbItems, up to the size of the internal message list buffer. The returned list accounts for the current sorting and filtering criteria. If the internal message list buffer hasn't been created yet, a load is automatically performed.
pIndex start numbering at zero. A value of -1 for pNbItems returns the entire content of the internal message list buffer, notwithstanding the filtering criteria established with setFilter.

The list of messages headers is returned as an array of IMMsgHeader objects. A null value indicates either that no messages fulfill the established filtering criteria, or that the internal message list buffer is empty, or that the Mailbox contains no messages. Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session Index from which get the message headers Maximum number of message headers in the response
string pSvcSessionId integer pIndex integer pNbItems
Response parameter The sub list of message headers, or nothing if no messages (see IMMsgHeader for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 41

3.7.6 getIndexOf
getIndexOf( string pFwSessionId, string pSvcSessionId, string pMessageId) Return integer
The given message Id (pMessageId parameter) is looked up and an index within the internal message list buffer is returned according to the established sorting and filtering criteria. If the internal message list buffer hasn't been created yet, a load is automatically performed. Request parameters
string pFwSessionId Identifier of the Framework Session. This identifier is obtained at the session opening (through the login or loginSupervisor operation of the XMLApiFramework Web Service) Identifier of the XMLMessaging session Identifier of the message for which the index is requested
string pSvcSessionId string pMessagId
Response parameter The index of the message. Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 42

3.7.7 deleteMessages
deleteMessages( string pFwSessionId, string pSvcSessionId, string[]pMessageIdList)
Each message identifier contained in the pMessageIdList parameter is matched against the internal message list buffer and removed. The Voicemail Server is in turn instructed to delete the corresponding messages from the mailbox. The command does not return any particular value. It is assumed that invalid message identifiers are by nature non-existent, which fits the purpose of deletion. Request parameters

Response parameter All parts of a draft message as an array of URL (see IMGetResult for more details). Possible SOAP faults AlcServiceException see AlcServiceException fault for more details IMException see IMException fault for more details Required license MYMESSAGINGAPI

Edition 5.0.0 Page 46

3.8 Common faults
Each operation of each Web Service published by the API Framework can throw a AlcServiceException fault that can contain one of the following error :
BAD_DATA_ACCESS_CONNECTION Database connection error BAD_FRAMEWORK_SESSION_IDENTIFIER Framework Session identifier is not valid or absent : check that it's present and valid in your service URL. INVALID_OPERATION The requested operation does not exist or is not valid in the particular context INVALID_SVC_SESSION_ID The session identifier of a service (in XMLPhone or XMLMessaging for example) is not valid LICENSE_REQUIRED The right has been checked, but the associated license cannot be taken (no more license, connection error with the license server, license file corrupted,) LOGIN_REQUIRED Some Web Services such as XMLPhone or XMLMessaging also requires a login operation SERVICE_UNAVAILABLE A Web Service or the Service it tries to access is not started or not initialized. This error can also been thrown if the Web Service URL is not well written. SOAP_ACTION_REQUIRED The SOAP request MUST contain a valid SOAPAction HTTP header as defined in the WSDL file BAD_PARAMETER_VALUE A parameter is not valid UNAUTHORIZED The service or the operation is not authorized for this user

Edition 5.0.0 Page 47

3.9 Service faults
Each operation of this Web Service can throw a IMException fault that can contain one of the following error : VOICEMAIL_SERVER_UNREACHABLE The voicemail server associated to the user account is not reachable or does not respond VOICEMAIL_SERVER_ERROR The voicemail server experienced an internal error VOICEMAIL_DRIVER_ERROR Voicemail driver error / protocol error DATA_ACCESS_FAILURE The user account could not be retrieved INVALID_STATE The command cannot be completed from the current session state, or if the returned state is LOGGED, the media session was terminated by either a timeout or the user hanging up the phone. UNKNOWN_USER The given user does not exist UNKNOWN_ACCOUNT The voicemail account does not exist for the given user BAD_LOGIN Invalid password INVALID_SESSION Unused INVALID_PARAMETER A parameter is invalid OUT_OF_PORTS The voicemail server ran out of resources / voice ports. Unlike other errors, the command may be re-issued at a later time TOO_MANY_SESSIONS The maximum number of sessions has been reached ABORTED The command was aborted as a result of an abort command NO_MESSAGE The recorded message is blank or too short to qualify as a valid message DEPRECATED The command is deprecated and is no longer working CONCURRENT_TIMEOUT The command timed out while the session is busy processing another WRONG_NUMBER The dialed number is invalid CONGESTED The call did not get through due to network congestion NO_LINK The call did not get through because the trunk or network link is down NO_HARDWARE The call did not get through because the hardware is missing or failed DND The dialed number is set in Do Not Disturb mode

3.10.13 IMSendResultItem

Describes an item of the send operation result.
string key Key of the destination (specified in IMDestination)
IMSendResultCause cause Cause of the failure

3.10.14 IMSendResult

Result of the send operation.
IMState state IMCommands commands Current session state Current available commands according to the session state. The voicemail capabilities are not taken into account here. List of failed destinations
IMSendResultItem [] destinations
IMSendResultItem [] embeddedDestinations List of embedded destinations

3.10.15 IMMsgType

Lists the different types of messages.
VOICE FAX EMAIL Voice message Fax e-mail or VPIM notification message

Edition 5.0.0 Page 55

3.10.16 IMMsgCounters
Describes the messages' counters.
integer newEmail integer newFax integer newVoice integer totalEmail integer totalFax integer totalVoice Number of unread e-mails in the loaded messages Number of unread fax in the loaded messages Number of unread voice messages in the loaded messages Total number of e-mails in the loaded messages Total number of fax in the loaded messages Total number of voice messages in the loaded messages

3.10.17 IMMsgField

Lists the different message's field. Since this enumeration is used to sort the list of messages (setOrder operation), the following table also specify the sorting order for each value.
MSGID TYPE DATE FROM NAME SUBJECT UNREAD PRIORITY REPLYALLOWED LENGTH Message's identifier Sorting order : alphabetic (Note: does not make much sense) Type of message Sorting order : email, fax then voice Date of emission Sorting order : oldest to newest Sender's address Sorting order : alphabetic Sender's name Sorting order : alphabetic Message subject Sorting order : alphabetic Unread state Sorting order : false then true, i.e. unread messages at the end Priority Sorting order : lowest to highest, i.e. low first, high last Specifies whether reply is allowed Sorting order : false then true Message's length Sorting order : smallest to largest (Note: meaningless if list not filtered on one message type since length unit depends on message's type) Message's sensitivity Sorting order : lowest to highest, i.e. public first, private last) Specifies whether the message is forwardable Sorting order : (false then true Specifies whether message's sender is callable Sorting order : false then true Message's expiration Sorting order : first to last to expire, unknowns at the end Edition 5.0.0 Page 56

SENSITIVITY FORWARDABLE CALLABLE EXPIRATION
3.10.18 IMMsgSortingField
Describes a sorting criteria associating a particular message field and a sorting order.
IMMsgField field boolean ascend The message field on which the sort is applied. The sort is applied in ascending order if true

3.10.19 IMMsgHeader

The header that describes a message.
string msgId IMMsgType type dateTime date string from string name string subject boolean unRead integer length IMMsgPriority priority IMMsgSensitivity sensitivity boolean forwardable boolean callable boolean replyAllowed dateTime expiration Message identifier Message type. Date of the message The source of the message (e-mail address or mailbox number) Name associated to the source of the message (sender's name) Subject of the message Specifies whether the message is unread Length of the message, depending on the type : seconds for voice, pages for fax or number of bytes for e-mails. Message priority Message sensitivity or degree of confidentiality True if the message can be forwarded to another party, in relation to the sensitivity True if the sender of the message may be called back True if a reply is allowed Indicates when the message is due to expire and be deleted from the repository. An empty or null value means that the message will be kept indefinitely.

3.10.20 IMGetResult

Result of the getDraftUrl operation.
IMState state IMCommands commands string [] urls Current session state Current available commands according to the session state. The voicemail capabilities are not taken into account here. All parts of the currently recorded message as an array of URL

Edition 5.0.0 Page 57

4 XMLMessaging states
XMLMessaging strictly enforces state transitions and returns an error on commands issued from the wrong state, while at the same time trying its best to stay synchronized with the actual state of the Voicemail Server. There is, however, no mechanism to forward particular events such as hangup or session expiration to the Application. The interface provided by XMLMessaging is also flexible in that it allows various degrees of sophistication in implementing a voicemail-aware Application. The internal state machine maintained for each session potentially frees the Application from the need of maintaining a full-blown state machine of its own. All session-related commands return the new state resulting of the outcome of said command, as well as the list of commands available from the new state. The list alone may be used to enable / disable corresponding visual controls such as play / pause / stop buttons in the Application. An Application may thus choose among the following options : maintain its own state machine - identical to that of XMLMessaging - by deciding of the new state after issuing a command according to the state diagram maintain its own state machine but driven by XMLMessaging, relying on the state returned by each command issued to XMLMessaging not maintain any states but instead rely on the list of commands returned by each command issued to XMLMessaging to decide of the next possible user actions completely stateless implementation that merely issues XMLMessaging commands as a result of user action.

43 stop

PLAYREC_PAUSED 42 play

41 pause

40 play 44 stop

State diagram 1
82 callback CALLBACK 87 callback

84 callback 80 play

PLAY_PAUSED 86 record / forward

83 play

81 record / forward
89 send / getdraft / cancel
85 record / forw ard 95 send / getdraft / cancel 94 record / append / forward 92 record / append / forward
RECORD 88 record / forward
PLAYREC_PAUSED 93 send / getdraft / cancel

90 play

PLAYREC 91 play

State diagram 2

Edition 5.0.0 Page 60

105 play CALLBACK

102 callback
97 play LOGGED DIAL SESSION PLAY
104 record / forward 96 callback

103 play

RECORD PLAYREC_PAUSED
98 callback 99 play RECORD_IDLE 100 callback PLAYREC 101 play

State diagram 3

Edition 5.0.0 Page 61
5 Capabilities versus voice mails
The following table describes the capabilities of the service versus the type of voicemail. The capabilities can be dynamically got thanks to the getCapabilities operation. The description of each capability can be found in the description of the getCapabilities operation. Voicemail 4645 UM X X X X X X X X X X X X X X X X X X X X X X X
dialInterruptible nonBlockingDial play playOffsetAbsolute playOffsetRelative pause record recordInterruptible forward append sendByMailboxNumber sendByVpimAddress sendByEmail callBack nonBlockingCallBack callBackInterruptible hangup list delete get getDraft nomadic events msgVoice msgFax msgEmail msgNotifications
4635 X X X X X X X X X X X X X X X X X X X X X X X X X X

X X X X X X

Capabilities

X X X X X X X X

X X X X X X X

Edition 5.0.0 Page 62