The ININ.IceLib.UnifiedMessaging namespace contains classes for manipulating and managing Interaction Center Voicemails and Faxes.

Working with Voicemails

The voicemail functionality is implemented by classes that allow you to manage and playback voice messages received by an IC server as well as to monitor for new incoming messages.

Voicemail Retrieval

A list of current voicemail messages can be retrieved via the Voicemails property on the UnifiedMessagingManager class. To populate this list, the local Voicemail Cache must first be refreshed by calling RefreshVoicemailCache(Int32). A call to RefreshVoicemailCache(Int32) can be made at any time. Refreshing the cache will cause the following events to be fired, if applicable: NewVoicemail, VoicemailUpdated, or VoicemailDeleted.

Voicemail Playback

The primary playback functionality is available through the VoicemailMessage class. This class allows a developer to play a voice message to any of the following locations:

• Telephone Handset (PlayToHandset(VoicemailAttachment, Boolean)) - The handset associated with the station a user is currently logged into. In the case of SIP audio this handset would be speakers or headphones. In a traditional phone setup the handset is typically a phone receiver.
• Number (PlayToNumber(VoicemailAttachment, String, Boolean, Boolean)) - A remote phone number
• Station (PlayToStation(VoicemailAttachment, String, Boolean, Boolean)) - A station defined in IC

An instance of a VoicemailMessage contains zero or more VoicemailAttachment items. Each VoicemailAttachment represents an attachment to the voicemail that can be downloaded to a local file by calling SaveAsFile(VoicemailAttachment, String, Boolean).

Note
A VoicemailAttachment may (or may not) reference an audio file. When unified messaging is employed such that voicemails are stored within email messages, other arbitrary files can be added to the email (and show up as a VoicemailAttachment).

Examples

The example below iterates the list of available voicemail messages and downloads each message to a new local file. It is not recommended to use synchronous methods in client applications, nor is it recommended to download all voicemail files in this manner. This is purely a syntax usage example only.

CopyC#

// "session" is a valid ININ.IceLib.Connection.Session instance.
UnifiedMessagingManager manager = UnifiedMessagingManager.GetInstance(session);
manager.RefreshVoicemailCache(-1);
foreach (VoicemailMessage message in manager.Voicemails)
{
  foreach (VoicemailAttachment attachment in message.Attachments)
  {
    string fileName = System.IO.Path.GetTempFileName();
    message.SaveAsFile(attachment, fileName, false /* Don't mark as read */);
  }
}

Working with Faxes

The Fax functionality consists of a set of classes that allow you to manipulate and submit Faxes to an IC server for delivery, monitor all outgoing Fax activity for a logged-in user, and manage and download Fax messages received by an IC server.

Fax Retrieval

A list of current Fax messages can be retrieved via the Faxes property on the UnifiedMessagingManager class. To populate this list, the local Fax Cache must first be refreshed by calling RefreshFaxCache(Int32). A call to RefreshFaxCache(Int32) can be made at any time. Refreshing the cache will cause the following events to be fired, if applicable: NewFax, FaxUpdated, or FaxDeleted.

An instance of a FaxMessage contains zero or more FaxAttachment items. Each FaxAttachment represents an attachment to the Fax message that can be downloaded to a local file by calling SaveAsFile(FaxAttachment, String, Boolean).

Note
A FaxAttachment may (or may not) reference a Fax file. When unified messaging is employed such that Faxes are stored within email messages, other arbitrary files can be added to the Email (and show up as a FaxAttachment).

Examples

The example below iterates the list of available Fax messages and downloads each message to a new local file. It is not recommended to use synchronous methods in client applications, nor is it recommended to download all Fax files in this manner. This is purely a syntax usage example only.

CopyC#

// "session" is a valid ININ.IceLib.Connection.Session instance.
UnifiedMessagingManager manager = UnifiedMessagingManager.GetInstance(session);
manager.RefreshFaxCache(-1);
foreach (FaxMessage message in manager.Faxes)
{
  foreach (FaxAttachment attachment in message.Attachments)
  {
    string fileName = System.IO.Path.GetTempFileName();
    message.SaveAsFile(attachment, fileName, false /* Don't mark as read */);
  }
}

Fax Sending and Monitoring

Functionality that includes sending and monitoring Interaction Faxes are separated into a collection of Images, Attributes and Envelopes all available through a central class, FaxFile.

In addition to the viewing and editing capability exposed through the FaxFile, you also have the ability to send a Fax through the IC server. Faxes are addressed by using the AddEnvelope(FaxEnvelope) method on the FaxFile to add a new FaxEnvelope. Once a Fax has been assigned one or more envelopes, it is ready to be used in a call to SendFax(String) to have it submitted to the IC server for delivery.

Monitoring the status of outgoing Faxes is enabled through a call to EnableFaxMonitoring(Boolean). An application that has enabled monitoring for an IC user will periodically receive FaxMonitorUpdate events to indicate the state of each Fax being processed on the IC server on behalf of that user.

Examples

The following example demonstrates the processing of an incoming FaxMonitorUpdate event.

CopyC#

...
private delegate void UpdateStatusListDel(FaxStatus statusUpdate);

private void FaxMonitorUpdateHandler(object sender, FaxMonitorUpdateEventArgs e)
{
    if (this.InvokeRequired)
    {
        UpdateStatusListDel del = new UpdateStatusListDel(UpdateStatusList);
        this.BeginInvoke(del, new object[]{e.FaxStatus});
    }
    else
    {
        UpdateStatusList(e.FaxStatus);
    }
}

private void UpdateStatusList(FaxStatus statusUpdate)
{
    if (statusUpdate.Code == FaxStatusCode.None)
    {
        // Ignoring update for invalid status.
        return;
    }

    // Search for a row containing the envelope ID.  If we don't find it
    // then add a new row, otherwise update the current line
    ListViewItem newItem = null;
    BuildListItem(statusUpdate, out newItem);

    int nItemIdx = FindEnvelopeInList(statusUpdate.EnvelopeId);
    if (nItemIdx != -1)
    {
        // Replacing envelope at nItemIdx with new item
        statusList.Items[nItemIdx] = newItem;
    }
    else
        statusList.Items.Add(newItem);
}

private int FindEnvelopeInList(Int64 searchId)
{
    int nEnvelopeIndex = -1;
    lock (statusList.Items)
    {
        foreach (ListViewItem currentItem in this.statusList.Items)
        {
            Int64 envelopeId = (Int64)currentItem.Tag;
            if (searchId == envelopeId)
            {
                nEnvelopeIndex = this.statusList.Items.IndexOf(currentItem);
                break;
            }
        }
    }

    return nEnvelopeIndex;
}