CA_Create_Voice_Msg

Purpose

Assigns a unique voice message identifier.

Libraries

Blueworx Voice Response library (libvae.a)

Custom Server library (libca.a)

Syntax

#include "CA_header.h"
#include "CA_access_db.h"
int  CA_Create_Voice_Msg_Id (
 CREATE_VOICE_MSG_ID_PARM_ST  *create_voice_msg_id_parm_sp
 VOICE_MSG_DATA_ID_ST         *voice_msg_data_id_sp
);

Description

This subroutine reserves a unique voice message identifier. This identifier is used for subsequent calls to the CA_Create_Voice_Msg() subroutine.

Normally Blueworx Voice Response chooses the voice message identifier and returns it to the calling subroutine. However, it is also possible for the calling routine to choose the identifier. You may need this, for example, when copying messages between Blueworx Voice Response systems.

Parameters

create_voice_msg_id_parm_sp: A pointer to a CREATE_VOICE_MSG_ID_PARM_ST input structure that is filled in by the calling application as described in CREATE_VOICE_MSG_ID_PARM_ST.
voice_msg_data_id_sp: This parameter is a pointer to a VOICE_MSG_DATA_ID_ST output structure that will be filled in on return as described in VOICE_MSG_DATA_ID_ST.
If you want Blueworx Voice Response to take the new identifier from the VOICE_MSG_DATA_ID_ST imbedded in the CREATE_VOICE_MSG_ID_PARM_ST structure, set this parameter to null allowing the caller to choose the identifier.

Return codes

0: Successful
-1: Unsuccessful (global error number CA_errno is set to indicate the error)

Error names

CA_ACCESS_NOBUFS
CA_DUPLICATE_MSG_ID_KEY
CA_INV_ADDR
CA_INV_COMPRESSION_TYPE
CA_INV_MAILBOX_ID
CA_INV_PROFILE_ID
CA_INV_REQUEST
CA_NO_MSG_RECV
CA_NOT_INIT
CA_PROFILE_NOT_FOUND
CA_REQ_FAILED
CA_TERMINATING

Related information

CA_Create_Voice_Msg(), 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().

CA_Create_Voice_Msg_Id()