Lucent Technologies DEFINITY Enterprise Communications Server Release 6 CallVisor PC ASAI Instructions Manual

							Programming Manual Pages
Issue  3  May 1998
9-129
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value when successful and -1 on failure. A return value of 0 indicates 
that there is no data to be sent.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_send()
C_EN_REQ C_3PMC_REQ C_CALEND calend_list call_id
:  See C_ALERTING.
calend_cause can be any of the following: 
C_ANSWERING_MACHINE,
C_CALLID_TERM, C_NORMAL, 
C_NUM_CHANGED,C_UNSPECIFIED. 
These values are similar to cause_value and 
are explained in Chapter 8, ‘‘ASAI Capability 
Primitives.’’ If this item is not ECS-supplied, it 
assumes the value of 
C_NUSE_LONG.
pool:  See C_ALERTING.
C_COLLECTED collected_
digitscall_id:  See C_ALERTING.
user_data provides the user information that 
will be sent from ECS.
pool:  See C_ALERTING.
Table 9-2. Event-Name Members and Descriptions — Continued
Event Nameevr_buf Member Description 
						

							Programming Manual Pages
9-130Issue  3  May 1998 
C_EN_REQ (3ASAI)
Name
C_EN_REQ — Request event reports for a specified domain
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
        asai_common_t           asai_common;
        long                    domain_type;
        char                    *domain_ext;
        char                    pool[C_DATSZ];
}acd_grp_info_t;
typedef struct{
        asai_common_t           asai_common;
        long                    domain_type;
        char                    *domain_ext;
        char                    pool[C_DATSZ];
}charge_advice_info_t;
typedef struct{
        asai_common_t           asai_common;
        long                    domain_type;
        char                    *domain_ext;
        char                    pool[C_DATSZ];
}cv_info_t;
typedef struct{
        asai_common_t           asai_common;
        long                    domain_type;
}en_common_t;
typedef union{
        en_common_t             en_common;
        acd_grp_info_t          acd_grp_info;
        cv_info_t               cv_info;
        charge_advice_info_t    charge_advice_info;
}en_buf_t; 
						

							Programming Manual Pages
Issue  3  May 1998
9-131
Description
The client sends this capability to request event notification. The parameters 
associated with this capability are defined within en_buf. A set of common 
parameters for this capability is defined in en_common.
Within en_common, the programmer sets the asai_common parameters of 
capability to C_EN_REQ and primitive_type to C_REQUEST. 
domain_type indicates the domain of the events requested and can be 
C_ACD_GROUP or C_CALL_VECTOR, or C_AOC_TRUNK (ACD group or call vector, 
or AOC trunk). This capability initiates reports on the following items: 
C_ALERTING,C_CONNECTED, C_ANSWERED,C_QUEUED,C_DROP, 
C_BUSY,C_DENIAL,C_HOLD,C_INITIATE,C_RECONNECT,C_LOGIN,
C_LOGOUT,C_TRK_SEIZED,C_COLLECT,C_CALEND,C_CUT_THROUGH,
C_CONFERENCED,C_TRANSFERED, C_CALL_ORIG, C_OFFERED, and 
C_CHARGE_ADVICE.
The en_buf union members of acd_grp_info and cv_info contain the 
identifying information of the requested domain. The following table shows the 
domain, identifying parameter and a description of the parameter. The parameters 
listed in the table are mandatory.
Table 9-3. Domain Value Parameters and Description
Domain Value Parameter Description
C_ACD_GROUPdomain_ext Pointer to a null-terminated string that indicates the 
extension of the ACD split.
pool Character array that provides buffer space for the 
ASAI library to store program-specific information. 
See ‘‘Pool’’ on page 8-15 in Chapter 8, ‘‘ASAI 
Capability Primitives’’ for more information.
C_AOC_TRUNKdomain_ext Pointer to the default string “#####” that designates 
all trunk groups. Only the requests containing the 
default string “#####” will be acknowledged.
pool Character array that provides buffer space for the 
ASAI library to store program-specific information. 
See the section ‘‘Pool’’ in Chapter 8, “ASAI 
Capability Primitives” for more information.
C_CALL_VECTORdomain_ext Pointer to a null-terminated string that indicates the 
extension of the vector directory number.
pool Character array that provides buffer space for the 
ASAI library to store program-specific information. 
See ‘‘Pool’’ on page 8-15 in Chapter 8, ‘‘ASAI 
Capability Primitives’’ for more information. 
						

							Programming Manual Pages
9-132Issue  3  May 1998 
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value when successful and -1 on failure. A return value of 0 does not 
indicate an error, it merely indicates that no data has been sent.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_send() 
C_EN_REP C_EN_CONF C_EN_CAN C_EN_CAN_CONF C_EN_END 
						

							Programming Manual Pages
Issue  3  May 1998
9-133
C_EN_SCN (3ASAI)
Name
C_EN_SCN — Stop sending event reports for a specified call
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
        asai_common_t      asai_common;
        call_id_t          call_id;
        char               pool[C_DATSZ];
}en_scn_t;
Description
The client sends this capability to request termination of event reports on a 
specified call. The call is identified by call_id. Only one call_id is allowed per 
request. The needed information is contained in the en_scn_t structure.
asai_common
The programmer sets the capability to C_EN_SCN and the primitive_type 
to C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id) to identify association inside which the call notification is being 
terminated.
call_id
id_length specifies the length of ECS-assigned call identifier and id_ptr 
points to a binary array that specifies ECS-assigned identifier of the monitored 
call.
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value when successful and -1 on failure. A return value of 0 does not 
indicate an error, it merely indicates that no data has been sent.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes. 
						

							Programming Manual Pages
9-134Issue  3  May 1998 
Notes
This capability can be issued only by a client.
See Also
asai_send() 
C_EN_SCN_CONF C_EN_REQ C_EN_CAN C_EN_CAN_CONF C_EN_END 
						

							Programming Manual Pages
Issue  3  May 1998
9-135
C_EN_SCN_CONF (3ASAI)
Name
C_EN_SCN_CONF — Acknowledge a stop call notification request
Ty p e
Continuing — Unacknowledged, when used as a positive or 
negative acknowledgement
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}en_scn_nak_t;
typedef union{
        asai_common_t        asai_common;
        en_scn_nak_t         en_scn_nak;
}en_scn_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement to a 
C_EN_SCN request. 
asai_common
The capability is returned as C_EN_SCN_CONF and the primitive_type is 
returned as C_POS_ACK for positive acknowledgement, C_NEG_ACK for negative 
acknowledgement. The sao_id (also known as cluster_id) specified in the 
stop call notification request is also returned.
cause_value
This parameter can be any of the following:
  C_FACUNSUB
  C_INVLDIE
  C_MAND_INFO
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
9-136Issue  3  May 1998 
Return Value
When this capability is used in an asai_rcv(), the function returns the size of 
the message when successful and -1 on failure. A return value of 0 does not 
indicate an error, but no data has been received.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_rcv()
C_EN_SCN C_EN_REQ C_EN_CONF C_EN_REP C_EN_CAN C_EN_CAN_CONF 
C_EN_END 
						

							Programming Manual Pages
Issue  3  May 1998
9-137
C_HB_CONF (3ASAI)
Name 
C_HB_CONF —Acknowledge a heartbeat request
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}hb_nak_t;
typedef union{
        asai_common_t        asai_common;
        hb_nak_t             hb_nak;
}hb_rsp_t;
Description
The client (that is, for this request, it can be ECS or the adjunct) receives this 
capability as a positive or negative acknowledgement of a C_HB_REQ request. 
The union hb_rsp_t contains the necessary information.
asai_common
The capability is returned as C_HB_CONF and primitive_type is returned 
as C_POS_ACK for positive acknowledgement, C_NEG_ACK for negative 
acknowledgement. The sao_id (also known as cluster_id) specified in the 
heartbeat request is also returned.
cause_value
This parameter can be any of the following:
  C_FACUNSUB
  C_INVLDIE
  C_MAND_INFO
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
9-138Issue  3  May 1998 
Return Value
When this capability is used in an asai_rcv(), the function returns the size of 
the message when successful and -1 on failure; when it is used in an 
asai_send(), the function returns a nonnegative value on success and -1 on 
failure. A return value of 0 does not indicate an error, it merely indicates that no 
data has been sent or received.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_send()  asai_rcv()
C_HB_REQ