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...

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...

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...

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...

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...

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...

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...

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...

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:...