Scribd
Upload
120 views

TSAPI - Deflect Call Service

This service redirects an alerting call at a device to a new destination, either on-PBX or off-PBX. The call at the redirecting device is dropped after a successful redirection. An application may redirect an alerting call (at different devices) any number of times until the call is answered or dropped by the caller. The service request is positively acknowledged if the call has successfully redirected for an onPBX destination. For an off-PBX destination, this does not imply a successful redirection. It indicates that the switch attempted to redirect the call to the off-PBX destination and subsequent call progress events or tones may indicate redirection success or failure. If the service request is negatively acknowledged, the call remains at the redirecting device and the calledDevice is not involved in the call.

Uploaded by

Rodrigo
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
120 views

TSAPI - Deflect Call Service

This service redirects an alerting call at a device to a new destination, either on-PBX or off-PBX. The call at the redirecting device is dropped after a successful redirection. An application may redirect an alerting call (at different devices) any number of times until the call is answered or dropped by the caller. The service request is positively acknowledged if the call has successfully redirected for an onPBX destination. For an off-PBX destination, this does not imply a successful redirection. It indicates that the switch attempted to redirect the call to the off-PBX destination and subsequent call progress events or tones may indicate redirection success or failure. If the service request is negatively acknowledged, the call remains at the redirecting device and the calledDevice is not involved in the call.

Uploaded by

Rodrigo
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

Deflect Call Service

Deflect Call Service


Summary

Direction: Client to Switch

Function: cstaDeflectCall ()

Confirmation Event: CSTADeflectCallConfEvent

Service Parameters: deflectCall, calledDevice

Ack Parameters: noData

Nak Parameter: universalFailure

Functional Description:
This service redirects an alerting call at a device to a new destination, either on-PBX or off-PBX.
The call at the redirecting device is dropped after a successful redirection. An application may
redirect an alerting call (at different devices) any number of times until the call is answered or
dropped by the caller.
The service request is positively acknowledged if the call has successfully redirected for an onPBX destination. For an off-PBX destination, this does not imply a successful redirection. It
indicates that the switch attempted to redirect the call to the off-PBX destination and
subsequent call progress events or tones may indicate redirection success or failure.
If the service request is negatively acknowledged, the call remains at the redirecting device and
the calledDevice is not involved in the call.
Service Parameters:

deflectCall

[mandatory] Specifies the connectionID of the call that is to be redirected to


another destination. The call must be in the alerting state at the device. The
device must be a valid voice station extension.

calledDevice

[mandatory] Specifies the destination to which the call is redirected. The


destination can be an on-PBX or off-PBX endpoint. For on-PBX endpoints, the
calledDevice may be stations, queues, announcements, VDNs, or logical agent
extensions.

Ack Parameter:

noData

None for this service.

TSAPI for Communication Manager Programmer Reference, Release 4.2

Issue 4 May 2008

241

Chapter 6: Call Control Service Group

Nak Parameter:

universalFailure

If the request is not successful, the application will receive a


CSTAUniversalFailureConfEvent. The error parameter in this event may contain
the following error values, or one of the error values described in
Table 20: Common switch-related CSTA Service errors -- universalFailure on
page 786.

PRIVILEGE_VIOLATION_ON_CALLED_DEVICE (9) (CS3/42)


- Attempted to redirect a call back to the call originator or to the redirecting
device itself.
- Attempted to redirect a call on the calledDevice of a
cstaMakePredictiveCall.

INVALID_OBJECT_STATE (22) (3/63)


- An invalid callID or device identifier is specified in deflectCall.
- The deflectCall is not in alerting state.
- Attempted to redirect the call while in vector processing.

PRIVILEGE_VIOLATION_ON_SPECIFIED_DEVICE (8) (CS3/43)


The request may fail because of one of the following:
- invalid destination specified
- toll restrictions on destination
- COR restrictions on destination
- destination is remote access extension
- call origination restriction on the redirecting device
- call is in vector processing

RESOURCE_BUSY (33) (CS0/17) A call redirected to a busy station, a


station that has call forwarding active, or a TEG group with one or more
members busy will be rejected with this error.

GENERIC_SUBSCRIBED_RESOURCE_AVAILABILITY (41) (CS0/50) This


service is requested on a DEFINITY Server administered as a release earlier
than G3V4.

GENERIC_OPERATION (1) (CS0/111) This service is requested on a


queued call or protocol error in the request.

Detailed Information:

242

Administration Without Hardware - A call cannot be redirected to/from an AWOH station.


However, if the AWOH station is forwarded to a real physical station, the call can be
redirected to/from such a station, if it is being alerted.
Attendants - Calls on attendants cannot be redirected.
Auto Call Back - ACB calls cannot be redirected by the cstaDeflectCall service from the
call originator.
Bridged Call Appearance - A call may be redirected away from a primary extension or from
a bridged station. When that happens, the call is redirected away from the primary and all
bridged stations.

TSAPI for Communication Manager Programmer Reference, Release 4.2

Issue 4 May 2008

Deflect Call Service

Call Waiting - A call may be redirected while waiting at a busy analog set.
Deflect From Queue - This service will not redirect a call from a queue to a new
destination.
Delivered Event - If the calling device or call is monitored, an application subsequently
receives Delivered (or Network Reached) Event when redirection succeeds.
Diverted Event - If the redirecting device is monitored by a cstaMonitorDevice() or the call
is monitored by a cstaMonitorCallsViaDevice(), it will receive a Diverted Event when the
call is successfully redirected, but there will be no Diverted Event for a cstaMonitorCall
association.
Loop Back - A call cannot be redirected to the call originator or to the redirecting device
itself.
Off-PBX Destination - If the call is redirected to an off-PBX destination, the caller will hear
call progress tones. There may be conditions (for example, trunk not available) that will
prevent the call from being placed. The call is nevertheless routed in those cases, and the
caller receives busy or reorder treatment. An application may subsequently receive Failed,
Call Cleared, or Connection Cleared Events if redirection fails.
If trunk-to-trunk transfer is disallowed by the switch administration, redirection of an
incoming trunk call to an off-PBX destination will fail.

Priority and Forwarded Calls - Priority and forwarded calls are allowed to be redirected
with cstaDeflectCall.
Service Availability- This service is only available on a Communication Manager with
G3V4 or later software.

TSAPI for Communication Manager Programmer Reference, Release 4.2

Issue 4 May 2008

243

Chapter 6: Call Control Service Group

Syntax
#include <acs.h>
#include <csta.h>
// cstaDeflectCall() - Service Request
RetCode_t
cstaDeflectCall (
ACSHandle_t
acsHandle,
InvokeID_t
invokeID,
ConnectionID_t
*deflectCall,
DeviceID_t
*calledDevice,
PrivateData_t
*privateData);

// CSTADeflectCallConfEvent - Service Response


typedef struct
{
ACSHandle_t
acsHandle;
EventClass_t
eventClass;// CSTACONFIRMATION
EventType_t
eventType; // CSTA_DEFLECT_CALL_CONF
} ACSEventHeader_t;
typedef struct
{
ACSEventHeader_t
eventHeader;
union
{
struct
{
InvokeID_t invokeID;
union
{
CSTADeflectCallConfEvent_t
} u;
} cstaConfirmation;
} event;
char heap[CSTA_MAX_HEAP];
} CSTAEvent_t;

deflectCall;

typedef struct CSTADeflectCallConfEvent_t {


Nulltype
null;
} CSTADeflectCallConfEvent_t;

244

TSAPI for Communication Manager Programmer Reference, Release 4.2

Issue 4 May 2008

You might also like