DSC Tech Library
CTI Universal Softphone API Library
RESPONSE TYPES
All responses
are associated with a “response type”.
Here is a list of all possible responses and which routines will generate
them:
RSP_RT_PING
RSP_RT_LOGIN
RSP_RT_AVAILABLE
RSP_RT_UNAVAILABLE
RSP_RT_CONFERENCE
RSP_RT_DIALDIGITS
RSP_RT_MAKECALL
RSP_RT_DISCONNECTCALL
RSP_RT_ONHOLD
RSP_RT_MONITOR
RSP_RT_PAMALARM
RSP_RT_RECONNECT
RSP_RT_RECORDON
RSP_RT_RECORDOFF
RSP_RT_TRANSFER
RSP_RT_CANCELTRANSFER
RSP_RT_SHUTDOWN
RSP_RT_PAUSED
RSP_RT_ONCALL
RSP_RT_INVALID
Details
RSP_RT_PING
int RSPPing(const unsigned int context);
Always
returns RSPAPI_SUCCESS
RSP_RT_LOGIN
int RSPLogin (const unsigned int context,
const char * _campaign);
int RSPLoginPredictive(const unsigned int
context,
const char *
_campaign,
const char *
_ACDVector);
Returns:
RSPAPI_SUCCESS;
RSPAPI_ERR_INUSE;
RSPAPI_ERROR;
int RSPForceLogin (const unsigned int context,
const char *
_campaign);
int RSPForceLoginPredictive(const unsigned int
context,
const char *
_campaign,
const char * _ACDVector);
Returns:
RSPAPI_SUCCESS;
RSPAPI_ERR_FORCE;
RSPAPI_ERROR;
In addition, RspApiLoginResponse.incamp
will be 0 if not logged into a campaign, and 1 if it is – and RspApiLoginResponse.relog
will indicate if a login replaced another (some log-overs are permitted without
calling one of the RSPForceLogin() routine.
RSP_RT_AVAILABLE
int RSPMakeAvailable(const unsigned int
context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND // in most cases means not logged in
yet
RSPAPI_ERROR
RSP_RT_UNAVAILABLE
int RSPMakeUnavailable(const unsigned int
context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_CONFERENCE
int RSPConferenceHeldCall(const unsigned int
context);
//int RSPConference(const unsigned int context,
char * station); // not yet implemented as of this writing
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_DIALDIGITS
int RSPDialDigits(const unsigned int context, char
* digits);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERR_NOCALL // not connected on a call
RSPAPI_ERROR
RSP_RT_MAKECALL
int RSPMakeCall(const unsigned int context, char
* phonenumber);
int RSPMakeInternalCall(const unsigned int
context, char * extension);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_DISCONNECTCALL
int RSPDisconnectCall(const unsigned int
context, char * disposition);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_ONHOLD
int RSPHoldCall(const unsigned int context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_MONITOR
int RSPMonitorExtension(const unsigned int
context, char * extension, bool coach);
int RSPMonitorUser (const unsigned int context, char * username, bool coach);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUNDTARGET
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_PAMALARM
int RSPTriggerPAMAlarm(const unsigned int
context, char * alarmID);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERR_INVALID
RSP_RT_RECONNECT
int RSPReconnectHeldCall(const unsigned int
context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_RECORDON
int RSPBeginRecording(const unsigned int
context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_RECORDOFF
int RSPEndRecording(const unsigned int context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_TRANSFER
int RSPAnnounceTransfer (const unsigned int context,
char * extension);
int RSPBlindTransfer (const unsigned int context,
char *
extension,
char * campaign,
unsigned int
identifier);
int RSPCompleteTransfer (const unsigned int context,
char * campaign,
unsigned int identifier);
int RSPTransferToGroup (const unsigned int context,
char * group,
char * campaign,
unsigned int
identifier);
int RSPTransferToVoicemail(const unsigned int
context,
char * extension);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUNDTARGET
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_CANCELTRANSFER
int RSPCancelTransfer(const unsigned int
context);
Returns:
RSPAPI_SUCCESS
RSPAPI_ERR_NOTFOUNDTARGET
RSPAPI_ERR_NOTFOUND
RSPAPI_ERROR
RSP_RT_SHUTDOWN
RSP_RT_PAUSED
Unsolicited –
predictive campaign has been shut down or paused (list manager stopped). The distinction is for application
development convenience.
RSP_RT_ONCALL
Unsolicited –
indicates the user is on a call. Use
the RspApiInbound structure to discover if it was transferred, and whether ani,
dnis, a campaign name and/or a unique, user-defined identifier accompanied the
call.
RSP_RT_INVALID
This will be
returned if an unrecognized message arrives from the dialer.
- M. Petro
02/22/02
|
