CA_Set_Voice_Msg_Listened()

Purpose

Changes message status to Listened.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
#include "CA_access_db.h"
int CA_Set_Voice_Msg_Listened (
 SET_VOICE_MSG_LISTENED_PARM_ST  *set_voice_msg_listened_parm_sp
);

Description

This subroutine changes the message status from New, Checked, or Undeliverable to Listened and records the date and time of the change in the database.

If an acknowledgement for a message was requested it is sent at this time.

If a message status is already Listened, this subroutine has no effect and does not return an error.

If a message status is Saved and the message has already been Listened to, this subroutine has no effect and does not return and error.

If a message status is Saved and the message was not listened to before it was saved then the date and time the message was listened to (that is, the status of the message is changed by this subroutine) is recorded in the database but the status is not changed.

Parameters

set_voice_msg_listened_parm_sp

A pointer to a SET_VOICE_MSG_LISTENED_PARM_ST output structure that will be filled in as described in SET_VOICE_MSG_LISTENED_PARM_ST.

Return codes

0

Successful

-1

Unsuccessful (global error number CA_errno is set to indicate the error)

Error names

CA_ACCESS_NOBUFS
CA_INV_ADDR
CA_INV_MAILBOX_ID
CA_INV_PROFILE_ID
CA_INV_REQUEST
CA_NO_MSG_RECV
CA_NOT_INIT
CA_REQ_FAILED
CA_TERMINATING
CA_VOICE_MSG_NOT_FOUND

Related information

CA_Create_Voice_Msg(), CA_Create_Voice_Msg_Id(), CA_Delete_Voice_Msg(), CA_Get_Voice_Msg(), CA_Get_Voice_Msg_Info(), CA_Save_Voice_Msg(), CA_Send_Voice_Msg(), CA_Set_Send_Voice_Msg_Defaults().