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

							Programming Manual Pages
Issue  3  May 1998
9-139
C_HB_REQ (3ASAI)
Name
C_HB_REQ — Request heartbeat
Ty p e
Initiating — Acknowledged
Usage
asai_common_t    asai_common;
Description
The client (that is, ECS or the adjunct) sends this capability to request information 
on the state of the data link connection providing service (heartbeat). The 
response implies the status of the provider servicing the data link. The
asai_common structure contains the information needed to fulfill the request. 
Within asai_common, the programmer sets capability to C_HB_REQ and 
primitive_type to C_REQUEST. The programmer also sets the sao_id (also 
known as cluster_id).
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 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 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_CONF 
						

							Programming Manual Pages
9-140Issue  3  May 1998 
C_RF_CONF (3ASAI)
Name
C_RF_CONF — Acknowledge a request feature request
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}rf_nak_t;
typedef union{
        asai_common_t        asai_common;
        rf_nak_t             rf_nak;
}rf_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_RF_REQ request. The union rf_rsp contains the necessary information.
asai_common
The capability is returned as C_RF_CONF and the primitive_type as 
C_POS_ACK for positive acknowledgement, C_NEG_ACK for negative 
acknowledgement. The sao_id (also known as cluster_id) is also returned.
cause_value
This parameter can be any of the following:
  C_AGT_STATE
  C_BAD_ADMIN
  C_FACUNSUB
  C_FEATURE_REJECTED
  C_INCOM_OPT
  C_INC_PASWD
  C_INCS_AGT_ST
  C-INVALID_CRV
  C_INVLDIE
  C_INVLDNUM
  C_MAND_INFO
  C_MAX_LOGIN
  C_NETCONJ 
						

							Programming Manual Pages
Issue  3  May 1998
9-141
  C_NOLOGIN
  C_NOSPLIT_MEM
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL
  C_TEMP_FAILURE
  C_USER_BUSY
See Table 8-1 on page 8-12 for further information on cause values.
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 that 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_RF_REQ 
						

							Programming Manual Pages
9-142Issue  3  May 1998 
C_RF_REQ (3ASAI)
Name
C_RF_REQ — Activate or deactivate a call feature for a specified endpoint
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
        asai_common_t   asai_common;
        long            rf_item;
        char            *agent_id;
        char            *split_ext;
        char            *agt_ext;
        long            work_mode;
        char            pool[C_DATSZ];
}agt_login_t;
typedef struct{
        asai_common_t   asai_common;
        long            rf_item;
        char            *split_ext;
        char            *agt_ext;
        long            reason_code;
        char            pool[C_DATSZ];
}agt_logout_t;
typedef struct{ 
        asai_common_t   asai_common;
        long            rf_item;
        char            *split_ext;
        char            *agt_ext;
        long            work_mode;
        long            reason_code;
        char            pool[C_DATSZ];
}chg_wkmod_t;
typedef struct{
        asai_common_t   asai_common;
        long            rf_item;
        char            *called_num;
        char            *redir_num;
        char            pool[C_DATSZ];
}call_frwd_t; 
						

							Programming Manual Pages
Issue  3  May 1998
9-143
typedef struct{ 
        asai_common_t   asai_common;
        long            rf_item;
        char            *called_num;
        char            pool[C_DATSZ];
}can_frwd_t;
typedef struct{
        asai_common_t   asai_common;
        long            rf_item;
        char            *called_num;
        char            pool[C_DATSZ];
}sac_t;
typedef struct{ 
        asai_common_t   asai_common;
        long            rf_item;
        char            *called_num;
        char            pool[C_DATSZ];
}sac_can_t;
typedef struct{ 
        asai_common_t   asai_common;
        long            rf_item;
}rf_common_t;
typedef union{
        rf_common_t     rf_common;
        agt_login_t     agt_login;
        agt_logout_t    agt_logout;
        chg_wkmod_t     chg_wkmod;
        call_frwd_t     call_frwd;
        can_frwd_t      can_frwd;
        sac_t           sac;
        sac_can_t       sac_can;
}rf_buf_t;
Description
The client sends this capability to request activation of a specific feature. The 
rf_buf_t union members contain either common or specific information needed 
to fulfill the request. The common parameters are contained in the rf_common_t 
structure; the specific parameters for each feature are contained in the remaining 
union members.
rf_common_t
Within asai_common, the programmer sets the capability to C_RF_REQ and 
the primitive_type to C_REQUEST. The association is identified by the sao_
id (also known as cluster_id). The parameter rf_item identifies the feature  
						

							Programming Manual Pages
9-144Issue  3  May 1998 
being requested. It can be C_AGT_LOGIN, C_AGT_LOGOUT,
C_CHAGT_WKMOD, C_CALL_FRWD, C_CAN_FRWD, C_SAC, or C_SAC_CAN 
(agent login, agent logout, change of agent work mode, call forwarding, cancel 
call forwarding, send all calls, and cancel send all calls).
agt_login_t
This structure contains the parameters needed to request the agent login feature.  
agent_id is a pointer to a null-terminated string that indicates the agent login 
identifier and/or password. With traditional ACD, the agent’s password is in the 
agent_id field. With EAS, the logical agent id is in the agent_id field. If a 
password is required then a number and the password are added after the logical 
agent id. split_ext is a pointer to a null-terminated string that specifies the 
extension for which the agent is logging in. agt_ext is a pointer to a 
null-terminated string that specifies the agent extension. work_mode can be 
C_AUX_WORK, C_AFTCAL_WK, C_AUTO_IN, or C_MANUAL_IN (auxiliary mode, 
after call work mode, auto-in mode, and manual-in mode). pool is a 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.
agt_logout_t 
This structure contains the parameters needed to request the agent logout 
feature. split_ext is a pointer to a null-terminated string that specifies the 
extension from which the agent is logging out. agt_ext is a pointer to a 
null-terminated string that specifies the agent extension. reason_code (option) 
is a long integer indicating the reason for the agent logout. pool is a 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.
chg_wkmod_t
This structure contains the parameters needed to request a change in the agent 
work mode feature. split_ext is a null-terminated string that specifies the 
extension for which the work mode is to be changed. agt_ext is a pointer to a 
null-terminated string that specifies the agent extension. work_mode can be 
C_AUX_WORK, C_AFTCAL_WK, C_AUTO_IN, or C_MANUAL_IN (auxiliary mode, 
after call work mode, auto-in mode, and manual-in mode). reason_code (option) 
is a long integer value indicating the reason for the change of work modes. pool 
is a character array that provides buffer space for the ASAI library to store 
program-specific information. See ‘‘Pool’’ on page 8-15 for more information.
call_frwd_t 
This structure contains the parameters needed to request the call forwarding 
feature. called_num is a pointer to a null-terminated string that specifies the 
extension from which the call is to be forwarded. redir_num is a pointer to a 
null-terminated string that specifies the extension to which the call is to be  
						

							Programming Manual Pages
Issue  3  May 1998
9-145
forwarded. pool is a 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.
can_frwd_t 
This structure contains the parameters needed to request the cancel call 
forwarding feature. called_num is a pointer to a null-terminated string that 
specifies the extension from which call forwarding was invoked. pool is a 
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.
sac_t 
This structure contains the parameters needed to request the send all calls 
feature. called_num is pointer to a null-terminated string that specifies the 
extension for which send all calls is to be invoked. pool is a character array that 
provides buffer space for the ASAI library to store program-specific information.
sac_can_t 
This structure contains the parameters needed to cancel the send all calls feature 
for a specified extension. called_num is a pointer to a null-terminated string that 
specifies the extension for which the send all calls feature is to be cancelled. 
pool is a 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.
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_RF_CONF 
						

							Programming Manual Pages
9-146Issue  3  May 1998 
C_RT_END (3ASAI)
Name
C_RT_END — Terminate a route request
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
        asai_common_t   asai_common;
        long            cause_value;
}rte_info_t;
Description
The client (that is, ECS) sends this capability to request termination of a routing 
request. A structure of type rte_info_t contains the information needed to fulfill 
the request.
asai_common
The programmer sets the capability to C_RT_END and the primitive_type 
to C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id) to identify the association in the route request.
cause_value
This parameter can be any of the following:
  C_AGT_NOT_SPLIT_ME
  C_CALLID_TERM
  C_FACUNSUB
  C_INCOM_ST
  C_INVLDIE
  C_INVLDNUM
  C_MAND_INFO
  C_NOLOGIN
  C_NORMAL
  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
Issue  3  May 1998
9-147
Return Value
When this capability is used in an asai_rcv(), 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 received.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
Notes
This capability can be issued only by a client.
See Also
asai_rcv()
C_RT_REQ C_RT_SEL 
						

							Programming Manual Pages
9-148Issue  3  May 1998 
C_RT_REQ (3ASAI)
Name
C_RT_REQ — Request a call route
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
sai_common_t asai_common;
char *calling_num;
plan_type_t calling_type;
char *called_num;
plan_type_t called_type;
user_user_t data;
long leng_udata;
long udata_type;
long collect;
long timeout;
char *call_udata;
char *vdn_num;
long priority_level;
long interflow_type;
long hour;
long minute;
long second;
char *dnis_chars;
call_id_t call_id:
trunk_id_t trk;
oli_t oli;
wchar_t       *w_dnis_chars;
      ucid_t        ucid;            /* G3V6 */
char pool[C_DATSZ];
}rt_info_t;
Description
The client (that is, ECS) sends this capability to request a call route. A structure of 
type rt_info_t contains the information needed to fulfill the request.
asai_common
The programmer sets the capability to C_RT_REQ and the primitive_type 
to C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id).