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

							Programming Manual Pages
Issue  3  May 1998
9-149
calling_num
This parameter is a pointer to a null-terminated string that specifies the calling 
extension. (See trk parameter for more information.)
calling_type
This parameter 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).
called_num
This parameter is a pointer to a null-terminated string that specifies the called 
extension of the request.
called_type
This parameter is a plan_type_t structure that supplies additional information 
about the structure field that immediately precedes it.
uudata
The purpose of the user-user information is to convey information between ISDN 
users. This information is not interpreted by ECS, but rather is carried 
transparently and delivered to the remote user. If the info field is IA5 characters 
(ASCII), the string is null-terminated.
The leng field is an integer value that indicates the number of octets of user data 
included in the request. This field is set to 0 if no user_user data is present. 
Currently, ECS will accept up to 32 bytes of data (leng = 32). If more than 
32 bytes is specified, an error will be returned. ASAI supports a maximum
 user_user data length of 32 bytes, although user_user data generated from a 
PRI trunk can be up to 127 bytes in length. (DEFINITY ECS will truncate this to 
32 bytes before forwarding it to ASAI link.)
The protocol field indicates the type of information and is restricted to
C_UU_USER that indicates a user-specific protocol or C_UU_IA5 which indicates 
IA5 or ASCII characters.
The info field is a pointer to an ASCII string of no more that 32 characters in 
length.
leng_udata
This parameter is an integer value that indicates the number of octets of user data 
included in the offered call. 
udata_type
This parameter indicates the type of user data. It can be C_LOGIN_DIGITS, 
C_CALL_PROMPTER or C_NUSE_LONG (login digits, call prompter information or 
not used). 
						

							Programming Manual Pages
9-150Issue  3  May 1998 
collect
The collect parameter is a boolean field containing the collect or collected flag. 
timeout
This parameter specifies the digit collection time out and is an integer value from
0 to 63 (the default is 0). 
call_udata 
This parameter is a pointer to a null-terminated character string of user data. If 
leng_udata is 0, then it points to a null character as the first character.
vdn_num 
This parameter contains the domain (VDN) from which the route request is being 
made.
priority_level 
This parameter is an integer value that indicates the priority of the call. It can be 
C_NOT_IN_QUEUE,C_LOW,C_MEDIUM,C_HIGH, or C_TOP. If this item is not 
supplied, it assumes the value of C_NUSE_LONG.
interflow_type 
This parameter is an integer value that indicates the type of interflow. It can be
C_ALLINT_FLOW,C_THRINT_FLOW or C_VECINT_FLOW. If this item is not 
supplied, it assumes the value of C_NUSE_LONG.
hour, minute, second
These parameters indicate the time the routed call is to spend in the queue before 
interflow. Time is given in the integer values of hour, minute, second. If ECS 
does not supply a time value, the library sets all of these items to the value of 
C_NUSE_LONG.
dnis_chars 
This parameter is a pointer to an optional ECS-specified null-terminated string 
that indicates an identifier of the interflow source. If this parameter is not supplied 
by ECS, it is a null pointer.
w_dnis_chars
This parameter points to a translation of the raw optrex data in dnis_chars 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.) 
						

							Programming Manual Pages
Issue  3  May 1998
9-151
call_id
This parameter identifies the call to be routed.
trk
This parameter is optional. It identifies the trunk number from which the call 
originated. Note that calling_num and trk are mutually exclusive. One or the 
other will be present, but not both.
oli
This parameter is optional. It identifies the Information Indicator (II) digits received 
in the originating line information IE for the call.
ucid
This parameter identifies the ucid (Universal Call ID) assigned to the call by 
ECS.
pool 
This 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.
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 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_RT_SEL C_RT_END 
						

							Programming Manual Pages
9-152Issue  3  May 1998 
C_RT_SEL (3ASAI)
Name
C_RT_SEL — Inform a route requester of a proposed route selection
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
long type;
long collect;
long timeout;
char *digits;
}user_code_t;
typedefstruct{
asai_common_t asai_common;
char *calling_num;
char *called_num;
user_user_t uudata;
long ofacility;
char *ofac_ext;
long priority_call;
long dir_agtcall;
user_code_t user_data;
party_id_t party_id;
long specific_event;
char pool[C_DATSZ];
}rts_info_t;
typedefstruct{
asai_common_t asai_common;
long cause_value;
}rt_nak_t;
Description
The client (that is, ECS) sends this capability to request route selection 
information, relating to a route or route again request. Use of this capability is an 
implicit acknowledgement of the route request. A structure of type rts_info_t 
contains the information needed to fulfill the request. 
						

							Programming Manual Pages
Issue  3  May 1998
9-153
asai_common
The programmer sets capability to C_RT_SEL and primitive_type to
C_REQUEST for a positive acknowledgement. The primitive_type is set to 
C_NEG_ACK for a negative acknowledgement. The programmer also sets the 
sao_id (also known as cluster_id) to identify the association of the route 
request.
calling_num, called_num
The calling and called extensions are specified by the null-terminated strings 
pointed to by these parameters. The calling extension is optional; therefore, 
calling_num may be a null pointer. The called extension is mandatory.
uudata
The purpose of the user-user information is to convey information between ISDN 
users. This information is not interpreted by ECS, but rather is carried 
transparently and delivered to the remote user. If the info field is IA5 characters 
(ASCII), the string is null-terminated.
The leng field is an integer value that indicates the number of octets of user data 
included in the request. This field is set to 0 if no user_user data is present. 
Currently, ECS will accept up to 32 bytes of data (leng = 32). If more than 
32 bytes is specified, an error will be returned. ASAI supports a maximum
 user_user data length of 32 bytes, although user_user data generated from a 
PRI trunk can be up to 127 bytes in length. (DEFINITY ECS will truncate this to 
32 bytes before forwarding it to ASAI link.)
The protocol field indicates the type of information and is restricted to
 C_UU_USER that indicates a user-specific protocol or C_UU_IA5 which indicates 
IA5 or ASCII characters.
The info field is a pointer to an ASCII string of no more that 32 characters in 
length.
ofacility
This is an optional parameter that identifies the type of facility requested. It can be 
C_TRUNK_GROUP, C_ACD_SPLIT or C_NUSE_LONG. These values indicate a 
trunk group, an ACD group or facility not used.
ofac_ext
The ofac_ext parameter is a pointer to a null-terminated character string that 
identifies the trunk access code of the trunk group or the ACD split extension, 
depending on the value of ofacility.
priority_call 
Setting this parameter to C_PRIOR_ON indicates that the call should be tagged as 
a priority call; otherwise, the parameter should be set to C_PRIOR_OFF. 
						

							Programming Manual Pages
9-154Issue  3  May 1998 
dir_agtcall 
Setting this parameter to C_DIRAGT_ON indicates that the call should be tagged 
as a direct agent call; otherwise, the parameter should be set to C_DIRAGT_OFF.
user_data 
user_data provides the user information that will be sent to ECS.
type indicates the type of user code entered. The type field is restricted to the 
values C_TONE_DETECTOR and C_ADJUNCT_DIGITS. If C_ADJUNCT_DIGITS is 
specified, the time-out field is forced to zero(0) and the collect field is forced to
C_COLLECTED. If C_TONE_DETECTOR is specified, the collect field is forced to
C_COLLECT.
The timeout parameter specifies the digit collection time out and is an integer 
value from 0 to 63 (default is 0). 
The value of digits depends on the flag specified by the collect field. If the 
collect field has the value C_COLLECTED, digits is a pointer to an ASCII string. 
If the collect field has the value C_COLLECT, digits is a single one-byte 
character containing a binary integer indicating the maximum number of digits to 
be collected (default is 0).
party_id 
party_id is optional. party_id specifies the party generating the alerting 
event. 
NOTE:
party_id is not an ASCII null-terminated string but rather an array of 
binary bytes of the specified length. See ‘‘Identifiers’’ on page 8-5 in Chapter 
8, ‘‘ASAI Capability Primitives’’ for further information.
specific_event 
specific_event is a long integer that indicates the call prompter disconnect 
condition and indicates either connect or drop.
pool 
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. 
						

							Programming Manual Pages
Issue  3  May 1998
9-155
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value upon success 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.
Notes
This capability can be issued only by a server.
See Also
asai_send()
C_RT_REQ C_RT_END 
						

							Programming Manual Pages
9-156Issue  3  May 1998 
C_SV_CONF (3ASAI) 
Name 
C_SV_CONF — Acknowledge a set value request
Ty p e
Terminating — Unacknowledged
Usage
typedef struct {
asai_common_t   asai_common;
long cause_value;
}sv_nak_t;
typedef union {
asai_comon_t   asai_common;
sv_nak_t   sv_nak; 
}sv_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgment to a 
set value request. The union sv_resp contains the necessary information for 
both.
Within asai_common, the capability is returned as C_SV_CONF and 
primitive_type is returned as C_POS_ACK for positive acknowledgment and 
C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) of the association specified in the set value 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
Issue  3  May 1998
9-157
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, it merely indicates that no data has been received at this time.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_rcv()
C_SV_REQ 
						

							Programming Manual Pages
9-158Issue  3  May 1998 
C_SV_REQ (3ASAI)
Name
C_SV_REQ — Set the value of an item in the domain of the provider
Ty p e
Initiating — Acknowledged
Usage
typedef struct {
asai_common_t asai_common;
long sv_item;
long mwi_item;
char called_num;
char pool [C_DATSZ];
}sv_mwi_val_t;
typedef struct {
sv_common_t sv_common;
call_id_t call_id;
long bill_type;
float bill_rate;
char pool [C_DATSZ];   
}sv_flex_t;
typedef struct {
asai_common_t asai_common;
long sv_item;
}sv_common_t;
typedef Union {
sv_common_t sv_common;
sv_mwi_val_t sv_mwi_val;
sv_flex_t sv_flex; 
}sv_buf_t;
Description
The client sends this capability to request that the value of specified items be 
set.These requests are initiated from the adjunct; the time of the day can be set 
only by ECS.
Within the union sv_buf_t, the parameters contained in the sv_common 
member define a set of common parameters needed to fulfill the request. Specific 
item parameters are contained in the sv_mwi_val or sv_flex members.