Before continuing, refer to the Quickstart Guide to understand how Call objects are created and how different modules are instantiated. The VoicemailClient object offers a variety of functions which are covered in this article in detail.

anchorInitialize the voicemailClient

The VoicemailClient is implemented as the Voicemail class in the SDK and there are two ways of instantiating it.

To instantiate just the VoicemailClient, use the createVoicemailClient method:

const voicemailClient = createVoicemailClient(webex, logger);

If the VoicemailClient is instantiated through the calling instantiation:

const voicemailClient = calling.voicemailClient;

The voicemail client instance must be initialized to enable access to the voicemail backend services using the init() methood of the voicemailClient object:

const initResponse = await voicemailClient.init();

anchorVoicemail Response Object

Here's an example response from the voicemailClient method:

{
  statusCode: number;
  data: {
    voicemailList?: MessageInfo[];
    voicemailContent?: {
      type: string | null;
      content: string | null;
    };
    voicemailSummary?: SummaryInfo;
    voicemailTranscript?: string | null;
    error?: string;
  };
  message: string | null;
};

Fetch a Voicemail List

The getVoicemailList() method retrieves the voicemails present in the voicemail box of the user:

const voicemailListResponse = await voicemailClient.getVoicemailList(
  OFFSET,
  OFFSETLIMIT,
  SORT.DESC,
  true
);

The following table describes the options available for the arguments passed to the getVoicemailList() method:

anchorFetch a Voicemail Summary

The getVoicemailSummary() method fetches the count for various categories of voicemails in a user's mailbox. The method's response consists of counts for new voicemails received, new urgent voicemails received, old voicemails, and old urgent voicemails:

const voicemailSummaryResponse = await voicemailClient.getVoicemailSummary();

Here's an example of the response for the getVoicemailSummary() method:

{
 statusCode: 200,
    data: {
     voicemailSummary: {
         newMessages: 2,
         newUrgentMessages: 1,
         oldMessages: 3,
         oldUrgentMessages: 2,
        },
 },
    message: SUCCESS,
};

anchorFetch a Voicemail Transcription

The getVMTranscript() method API fetches a transcript for a voicemail. It takes a messageID as an argument:

const voicemailTranscriptResponse = await voicemailClient.getVMTranscript(messageID);

Here's an example of the response received when a transcript is fetched successfully:

{
 statusCode: 200,
    data: {
  transcript: "This is some transcript text from the voicemail ID.",
 },
    message: READY | FAILURE | NA | PENDING,
};

Here's an example of a messageID returned by the voicemail client:

v2.0/user/69fde5ad-fb8b-4a1b-9998-b0999e95719b/VoiceMessagingMessages/dfe55899-1f55-474f-8f00-bc5915757070

Mark a Voicemail As Read

The voicemailMarkAsRead() method API marks a voicemail as read. It takes a messageID as an argument:

const voicemailMarkAsReadResponse = await voicemailClient.voicemailMarkAsRead(messageID);

Here's an example response from the voicemailMarkAsRead() method:

{
 statusCode: 200,
    data: {},
    message: SUCCESS,
};

anchorMark a Voicemail As Unread

The voicemailMarkAsUnread() method API marks a voicemail as unread. It takes a messageID as an argument:

const voicemailMarkAsUnreadResponse =
  await voicemailClient.voicemailMarkAsUnread(messageID);

Here's an example response from the voicemailMarkAsUnread() method:

{
 statusCode: 200,
    data: {},
    message: SUCCESS,
};

anchorDelete a Voicemail

The deleteVoicemail() deletes a voicemail. It takes a messageID as an argument:

const voicemailDeleteResponse = await voicemailClient.deleteVoicemail(messageID);

Here's an example response from the deleteVoicemail() method upon successfully deleting a voicemail:

{
    statusCode: 200,
    data: {},
    message: SUCCESS,
};