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

							Programming Manual Pages
Issue  3  May 1998
9-159
asai_common
Within this structure, the programmer sets the capability to C_SV_REQ and 
the primitive_type is set to C_REQUEST.The programmer also sets the
sao_id (also known as cluster_id).
The parameter sv_item defines the domain of the items to be set. This 
parameter can be C_SV_MWI (message waiting indicator) or C_SV_FLEX (flexible 
billing).
sv_mwi_val
When sv_item is set to C_SV_MWI, the sv_mwi_val union member indicates 
the specific item parameters. The called_num parameter is a pointer to a 
null-terminated string containing the extension of the end point for which the 
indicator is to be set. mwi_type indicates whether the light should be on or off
(C_MWI_ON or C_MWI_OFF).
sv_flex
When the sv_item is set to C_SV_FLEX the sv_flex union member indicates 
the specific item parameters. Call_id is ECS-assigned identifier of the call to 
which the billing rate is to be applied. The value of this parameter is a character 
array of length id_length, pointed to by id_ptr. The bill_type parameter 
specifies the rate treatment for the call and can be one of NEW_RATE,
FLAT_RATE, PREM_CHARGE, PREM_CREDIT, or FREE_CALL. The 
bill_rate parameter is a floating point number that specifies the rate 
according to the treatment indicated by bill_type.
NOTE:
The bill_rate is not sent to ECS when the bill_type is FREE_CALL. 
The pool parameter 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 there is no data to be sent. 
						

							Programming Manual Pages
9-160Issue  3  May 1998 
Errors
A C_SV_MWI request will return C_BADPMATCH if the called_num parameter is 
not set. A C_SV_FLEX request will return C_BADVALUE if the bill_rate 
parameter is greater than 999.99 or a precision higher than the hundredths is 
specified (for example, 127.312). See Chapter 7, ‘‘Error Messages’’ for a list of 
error messages with brief explanations of their probable causes.
See Also
asai_send()
C_SV_CONF 
						

							Programming Manual Pages
Issue  3  May 1998
9-161
C_VQ_CONF (3ASAI)
Name
C_VQ_CONF — Acknowledge and terminate a value query request
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 cause_value;
}vqc_cause_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 num_login;
        long                 num_avail;
        long                 num_callinque;
}vqc_split_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 num_avail;
        long                 num_inuse;
}vqc_cc_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 num_avail;
        long                 num_inuse;
}vqc_tg_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 year;
        long                 month;
        long                 day;
        long                 hour;
        long                 minute;
        long                 second; 
						

							Programming Manual Pages
9-162Issue  3  May 1998 
}vqc_time_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 talk_state;
        long                 work_mode;
        long                 reason_code;
}vqc_agt_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 ext_status;
}vqc_station_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 num_call;  
        stn_info_t           *stninfo_list;
        char                 pool[C_DATSZ];
}vqc_cal_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 num_party; 
        party_ext_t          *party_list;
        char                 pool[C_DATSZ];
}vqc_pty_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 domain_type;
        long                 station_type;    
        long                 domain2_type;
        char                 *extension;
        char                 pool[C_DATSZ];
}vqc_ext_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 mwi_status;
}vqc_mwi_stat_t;
typedef struct{
        asai_common_t        asai_common; 
						

							Programming Manual Pages
Issue  3  May 1998
9-163
        long                 vqc_type;
        long                 sac_status;
}vqc_sac_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 scf_status;
        char                 *redirection;
        plan_type_t          redir_type; 
        char                 pool[C_DATSZ];
}vqc_scf_stat_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
        long                 domain_type;
        char                 *extension;
        char                 *name;
        wchar_t              *w_name;
        char                 pool[C_DATSZ];
} vqc_aaid_t;
typedef struct{
        asai_common_t        asai_common;
        long                 vq_item;
        ucid_t               ucid;
        char                 pool[C_DATSZ];
}vqc_ucid_t;                               /* UCID G3V6 */
typedef struct{
        asai_common_t        asai_common;
        long                 vqc_type;
}vqc_common_t;
typedef union{
        vqc_common_t         vqc_common;
        vqc_cause_t          vqc_cause;
        vqc_split_t          vqc_split;
        vqc_cc_stat_t        vqc_cc_stat;
        vqc_tg_stat_t        vqc_tg_stat;
        vqc_time_t           vqc_time;
        vqc_agt_stat_t       vqc_agt_stat;
        vqc_station_t        vqc_station;
        vqc_cal_stat_t       vqc_cal_stat;
        vqc_pty_stat_t       vqc_pty_stat;
        vqc_ext_stat_t       vqc_ext_stat;
        vqc_mwi_stat_t       vqc_mwi_stat;
        vqc_sac_stat_t       vqc_sac_stat;
        vqc_scf_stat_t       vqc_scf_stat;
        vqc_aaid_t           vqc_aaid; 
						

							Programming Manual Pages
9-164Issue  3  May 1998 
        vqc_ucid_t           vqc_ucid;      /* UCID 63V6 */
}vqc_buf_t;
Description
The client receives this capability as a positive or negative acknowledgement that 
terminates a value query request. The information needed to service the request 
is contained in the members of the union vqc_buf.
The data common to all termination requests is contained in vqc_common. Within 
asai_common, the capability is returned as C_VQ_CONF and the 
primitive_type as C_POS_ACK for a positive acknowledgment and 
C_NEG_ACK for as a negative acknowledgement. The association identified by the 
sao_id (also known as cluster_id) of the value query request is also 
returned.
In a positive acknowledgment, the capability returns information in one of the 
following vqc_buf members: vqc_split, vqc_cc_stat, vqc_tg_stat, 
vqc_time, vqc_agt_stat, vqc_station, vqc_common, vqc_common, 
vqc_cal_stat, vqc_pty_stat, vqc_ext_stat, vqc_mwi_stat, 
vqc_sac_stat, vqc_scf_stat, vqc_aaid, or vqc_ucid_t. 
Within the vqc_common structure, vqc_type indicates the type of item to which 
the information supplied pertains. This parameter may assume the values of 
C_ACDSPT_STAT, C_CLASS_STAT, C_TG_STAT, C_TIME_OF_DAY,
C_AGT_STAT, C_STATION, C_AGTLOGIN_AUD C_PTY_STAT,
C_EXT_STAT, C_MWI_STAT, C_SAC_STAT, C_SCF_STAT, C_AAID, or 
C_UCID. (ACD split status, call classifier status, trunk group status, parties on a 
call, extension information, time of day, ACD agent status, station status, third 
party call audit, agent login audit, message waiting indication, send all calls, 
station call forwarding, name associated with the extension number, or Universal 
Call ID.)
For third party call audits and agent login audits, data comes in a variable number 
of C_VQ_RESP messages and this message is used to indicate the end of the list 
messages.
The following table shows the item type, associated vqc_buf member and a 
description of the information contained in the member. Mandatory information is 
indicated with an asterisk(*). Optional items show a value for C_NUSE_LONG. 
						

							Programming Manual Pages
Issue  3  May 1998
9-165
Table 9-4. Associated Items and Descriptions for C_VQ_CONF
Item Typevqc_buf Member Item and Description
C_ACDSPT_STAT vqc_splitnum_login is an integer value indicating the 
number of agents logged in (
C_NUSE_LONG if not 
provided).
num_avail is an integer value indicating the 
number of agents available.
num_callinque is an integer value indicating the 
number of calls in the queue (
C_NUSE_LONG if not 
provided).
C_CLASS_STAT  vqc_cc_statnum_avail is an integer value indicating the 
number of idle call classifiers.
num_inuse is an integer indicating the number of 
call classifiers in use (C_NUSE_LONG, if not 
provided).
C_TG_STAT vqc_tg_statnum_avail is an integer value indicating the 
number of available trunks in the group.
num_inuse is an integer indicating the number of 
trunks in use (
C_NUSE_LONG if not provided).
C_TIME_OF_DAY vqc_timeyear is specified by a binary quantity that is specified 
by 2 digits.
month is specified by a binary quantity that is 
specified by 2 digits.
day is specified by a binary quantity that is specified 
by 2 digits.
hour is specified by a binary quantity that is specified 
by 2 digits.
minute is specified by a binary quantity that is 
specified by 2 digits.
second is specified by a binary quantity that is 
specified by 2 digits.
C_AGT_STAT vqc_agt_stattalk_state can be C_ON_CALL or C_IDLE.
work_mode can be C_MANUAL_IN,
C_AUTO_IN, C_AFTCAL_WK, or 
C_AUX_WORK. 
reason_code can be an integer from 1 to 9 
indicating the reason why the agent is in auxiliary 
mode. 
						

							Programming Manual Pages
9-166Issue  3  May 1998 
C_AAID
vqc_aaidItem and Description domain_type is 
an integer value indicating the type of the entity 
queried, (for example, Station, VDN, etc.).
extension is a pointer to a null-terminated string 
indicating the name associated with the extension 
number supplied in the request.
name is a point to a null-terminated string indicating 
the name associated with the extension in the 
Integrated Directory Database. This name will be from 
1 to 27 ASCII characters in length. If the name is not 
found, any of the optional elements of the RElease 
COMplete query response message will not be 
returned. 
w_name points to a translation of the raw OPTREX 
data in the name into its locale equivalent ISO (four 
bytes) characters. (See optrex, locale, and special 
characters in the Glossary and Appendix A, Special 
Characters for more information.)
C_UCID vqc_ucidItem is an integer value indicating the type of entity 
queried.
call_id is a structure in which the parameter
id_length specifies the length of ECS-assigned 
call identifier and id_ptr points to an array of 
binary bytes that specifies that call identifier.
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.
C_CAL_STAT vqc_cal_statstn_info is a pointer to a list of structures of type 
stn_info_t. Each structure contains a structure 
call_id that specifies ECS-assigned call identifier 
values and length and a structure party_id that 
specifies ECS-assigned party identifier values and 
length and the current call state of the party,
pty_state. When no call information is returned 
for this capability, 
stninfo_list is a null pointer.
num_call is the number of structures in the list 
pointed to by stn_info. Whenever no call 
identifiers are returned for this capability, it assumes 
the value of 
C_NUSE_LONG.
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.
Table 9-4. Associated Items and Descriptions for C_VQ_CONF — Continued
Item Typevqc_buf Member Item and Description 
						

							Programming Manual Pages
Issue  3  May 1998
9-167
C_PTY_STAT vqc_pty_stat party_list is a pointer to a list of structures 
associated with the same call identifier. Each structure 
contains the extension number and its associated 
structure, 
party_id_t. party_id_t contains 
the parameter id_ptr that points to a character 
array specifying ECS-assigned party identifier values. 
The length of each party identifier is given by 
id_length. When no party identifiers are returned 
for this capability, 
party_list is a null pointer.
num_party is the number of structures specified in 
the list pointed to by party_list. When no party 
identifiers are returned for this capability, 
num_party assumes the value of C_NUSE_LONG.
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.
C_EXT_STAT vqc_ext_stat domain_type can be C_ACD_SPLIT, 
C_VDN, C_ANNOUNCE, C_DATA, C_VOICE, C_ASAI_LINK, C_LOGICAL, 
or, if no value is returned for this capability, 
C_NUSE_LONG.
station_type can be C_ANALOG, C_BRI, 
C_PROPRIETARY, or C_NUSE_LONG.
domain_type2 can be C_LOGICAL or 0.
Extension — In an EAS environment, if an 
agent’s login is queried and the agent is logged in, the 
extension will be returned. If a physical extension 
is queried and the agent is logged in, the 
extension will be returned.
pool — See vqc_pty_stat.
C_MWI_STAT vqc_mwi_stat mwi_status can be C_MWI_ON or 
C_MWI_OFF.
C_SAC_STAT vqc_sac_stat sac_status can be C_SAC_ON or C_SAC_OFF.
Table 9-4. Associated Items and Descriptions for C_VQ_CONF — Continued
Item Typevqc_buf Member Item and Description 
						

							Programming Manual Pages
9-168Issue  3  May 1998 
cause_value
This parameter can be any of the following:
   C_FACUNSUB
   C_INVLDIE
   C_INVLDNUM
   C_MAND_INFO
   C_NOLOGIN
   C_NOSPLIT_MEM
   C_PROTERR
   C_RESUNAVL
   C_SER_UNIMP
   C_SERV_UNAVIL
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 upon success 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. C_SCF_STAT vqc_scf_stat scf_status
 can be C_SCF_ON or C_SCF_OFF.
redirection is a pointer to a null-terminated 
string specifying the redirection number if 
scf_status is C_SCF_ON.
redir_type is an optional plan_type_t 
structure that supplies additional information about the 
structure field that immediately precedes it (providing 
that the preceding field is not NULL). 
plan_type_t has two fields addr_type and numb_plan. addr_type can have two possible 
values unknown(0) and international(1). Currently, 
numb_plan can have only one value, unknown(0). 
However, additional values for both fields may be 
coded in the future.
C_STATION vqc_station_t ext_status can be C_ON_CALL or C_IDLE.
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.
Table 9-4. Associated Items and Descriptions for C_VQ_CONF — Continued
Item Typevqc_buf Member Item and Description