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

							Programming Manual Pages
Issue  3  May 1998
9-109
  typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        long                       cause;
        char                       *connect_num;
        plan_type_t                con_type;
        char                       *calling_num;
        plan_type_t                calling_type;
        char                       *called_num;
        plan_type_t                called_type;
        call_id_t                  call_id;
        party_id_t                 party_id;
        trunk_id_t                 trk;
        oli_t                      oli;
        ucid_t                     ucid;    /* G3V6 */
        char                       pool[C_DATSZ];
} connect_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        long                       answered_cause;
        party_id_t                 party_id;
        char                       *connect_num;
        plan_type_t                connect_type;
        char                       *called_num;
        plan_type_t                called_type;
        char                       pool[C_DATSZ];
} answered_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       *called_num;
        plan_type_t                called_type;
        long                       num_inque;
        char                       *acd_split_ext;
        char                       pool[C_DATSZ];
} queued_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       *hold_num;
        plan_type_t                hold_type;
        party_id_t                 party_id;
        char                       pool[C_DATSZ]; 
						

							Programming Manual Pages
9-110Issue  3  May 1998 
} hold_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       *reconnect_num;
        plan_type_t                recon_type;
        party_id_t                 party_id;
        char                       pool[C_DATSZ];
} reconnect_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        party_id_t                 party_id;
        ucid_t                     ucid;     /* G3V6 */
        char                       pool[C_DATSZ];
} initiate_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       pool[C_DATSZ];
} redirected_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        char                       *extension;
        plan_type_t                ext_type;
        long                       reason_code;
        char                       pool[C_DATSZ];
} logout_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        char                       *phys_ext;
        char                       *log_ext;
        long                       work_mode;
        char                       pool[C_DATSZ];
} login_list_t; 
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id; 
						

							Programming Manual Pages
Issue  3  May 1998
9-111
        long                       drop_cause;
        char                       *droped_num;
        plan_type_t                droped_type;
        user_user_t                uudata;
        party_id_t                 party_id;
        char                       pool[C_DATSZ];
} drop_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        party_id_t                 party_id;
        char                       *called_num;
        plan_type_t                called_type;
        long                       busy_cause;
        char                       pool[C_DATSZ];
} busy_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       *called_num;
        plan_type_t                called_type;
        long                       denial_cause;
        char                       pool[C_DATSZ];
} denial_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        party_id_t                 party_id;
        long                       location;
        long                       prog_discp;
        char                       pool[C_DATSZ];
} cuthrw_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        party_id_t                 party_id;
        char                       *called_num;
        plan_type_t                called_type;
        trunk_id_t                 trk;      /* G3V6 */
        char                       pool[C_DATSZ];
} trkszd_list_t; 
						

							Programming Manual Pages
9-112Issue  3  May 1998 
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  bef_call_id;
        call_id_t                  aft_call_id;
        char                       *calling_num;
        plan_type_t                calling_type;
        char                       *called_num;
        plan_type_t                called_type;
        long                       part_num;
        merge_ext_t                *party_list;
        ucid_t                     ucid;   /* G3V6*/
        char                       pool[C_DATSZ];
} conf_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  bef_tranid;
        call_id_t                  aft_tranid;
        char                       *calling_num;
        plan_type_t                calling_type;
        char                       *called_num;
        plan_type_t                called_type;
        long                       part_num;
        merge_ext_t                *party_list;
        ucid_t                     ucid;  /* G3V6*/
        char                       pool[C_DATSZ];
} tran_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        char                       *calling_num;
        plan_type_t                calling_type;
        char                       *called_num;
        plan_type_t                called_type;
        user_user_t                uudata;
        trunk_id_t                 trk;
        oli_t;                     oli;
        long                       domain_type;
        long                       val_length;
        char                       *domain_val;
        long                       leng_udata;
        long                       udata_type;
        long                       collect;
        long                       timeout;
        char                       *incomg_udata;
        long                       priority_level; 
						

							Programming Manual Pages
Issue  3  May 1998
9-113
        long                       interflow_type;
        long                       hour;
        long                       minute;
        long                       second;
        char                       *dnis_chars;
        long                       feat_type;
        wchar_t                    *w_dnis_chars;
        ucid_t                     ucid;     /* G3V6 */
        char                       pool[C_DATSZ];
} incall_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
} erep_common_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        long                       calend_cause;
        char                       pool[C_DATSZ];
} calend_list_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        user_code_t                user_data;
        char                       pool[C_DATSZ];
} collected_digits_t;
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        party_id_t                 party_id;
        char                       *charged_num;
        char                       *called_num;
        trunk_id_t                 trk;
        long                       type_of_charge;
        long                       value_of_charge;
        long                       cause_value;
        char                       pool[C_DATSZ];
} charge_advice_t;
typedef union {
        erep_common_t              erep_common;
        orig_list_t                orig_list;      
        alert_list_t               alert_list; 
						

							Programming Manual Pages
9-114Issue  3  May 1998 
        connect_list_t             connect_list;
        answered_list_t            answered_list;
        queued_list_t              queued_list;
        hold_list_t                hold_list;
        reconnect_list_t           reconnect_list;
        initiate_list_t            initiate_list;
        redirected_list_t          redirected_list;
        logout_list_t              logout_list;
        login_list_t               login_list; 
        drop_list_t                drop_list;
        busy_list_t                busy_list;
        denial_list_t              denial_list;
        cuthrw_list_t              cuthrw_list;
        trkszd_list_t              trkszd_list;
        conf_list_t                conf_list;
        tran_list_t                tran_list;
        incall_list_t              incall_list;
        calend_list_t              calend_list;
        collected_digits_t         collected_digits;
        charge_advice_t            charge_advice;
} evr_buf_t;
Description
The server sends this capability to report requested information in the form of an 
event report. An event report can be generated for calls controlled by the adjunct 
via the Call Control Capability Group for calls controlled by the adjunct via the 
Domain (Station) Call Control Capability Group, Domain Control of ACD and for 
calls for which the adjunct has requested Event Reports via the Notification 
Capability Group.
The union evr_buf_t contains the information shared by all event reports in 
erep_common_t and the specific information for each report in the remaining 
members.
erep_common
Within this structure, asai_common identifies the specific capability 
corresponding to the report, and the association about which the reports are to be 
generated. The programmer sets the capability to C_EN_REP and the 
primitive_type to C_REQUEST.
The event is identified by event_name. This parameter can be any of the values 
shown in the table on the following pages. 
						

							Programming Manual Pages
Issue  3  May 1998
9-115
For each event there is a evr_buf_t member that carries the specific 
information related to that event. The table below gives the name of the event, its 
associated evr_buf member and a description of each item within the member.
Table 9-1. Redirection Reason Codes
Redirection Reason Cause Value ASAI Value
Send All Calls CS3/31                   C_FORWARD_ALL
Cover All Calls CS3/31                   C_FORWARD_ALL
Go to Cover Active CS3/31                   C_FORWARD_ALL
Adjunct-Redirected-Alerting-Call CS3/31                   C_FORWARD_ALL
Call Forwarding CAFW2 CS3/25                   C_FORWARD_BUSY
Cover, principal Busy CS3/26                   C_COVER_BUSY
Cover, all call appearances busy CS3/26                   C_COVER_BUSY
Cover, does not answer CS3/28                   C_COV_DONT_ANS 
						

							Programming Manual Pages
9-116Issue  3  May 1998 
Table 9-2. Event-Name Members and Descriptions
Event Nameevr_buf Member Description
C_ALERTING alert_list call_id is a structure of the type 
call_id_t. call_id specifies the call 
being reported on. See‘‘Identifiers’’ on page 8-5 in 
Chapter 8, ‘‘ASAI Capability Primitives’’ for more 
information.
cause is a long integer value returned by ECS 
that indicates the cause of the alert. The new (4.0) 
Alerting Event Report redirection-reason Cause 
Value information will be provided when any type 
of domain-controlled monitored endpoint receives 
an alerting call as result of a redirection. Although 
the Cause IE in the Alerting Event is optional, it will 
always be provided when alerting at an endpoint is 
the result of a redirection. See Table 9-1 on page 
9-115 for redirection reason codes.
connect_num is a pointer to an optional 
null-terminated character string that indicates the 
alerting extension. If an extension number is not 
supplied, 
connect_num is a null pointer.
con_num_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.
party_id is a mandatory structure of the type 
party_id_t and specifies the party being 
alerted. See ‘‘Identifiers’’ on page 8-5 in Chapter 8, 
‘‘ASAI Capability Primitives’’ for more information.
calling_num is a pointer to an optional 
null-terminated character string that indicates the 
extension of the calling party. If the extension 
number is not supplied, 
calling_num is a null 
pointer.
call_num_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). See
con_num_type above for more information 
concerning plan_type_t.
dial_num is a pointer to an optional 
null-terminated character string that indicates the 
extension of the dialed number. If the extension 
number is not supplied, 
dial_num is a null 
pointer. 
						

							Programming Manual Pages
Issue  3  May 1998
9-117
C_ALERTING 
(Continued)alert_list
(Continued)
dial_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). 
See 
con_num_type above for more 
information concerning 
plan_type_t.
uudata is a structure of the type
user_user_t where 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 that indicates IA5 or ASCII 
characters. The 
info field is a pointer to an 
ASCII string of no more that 32 characters in 
length.
acd_split_ext is a pointer to an optional 
null-terminated character string that indicates the 
ACD split extension that has distributed the call to 
an alerting agent. If the number is not supplied, 
acd_split_ext is a null pointer.
trk is a structure of type trunk_id_t. Within 
this structure, direct is a parameter that can be 
C_NODIRET, C_INCTRK or
C_OUTTRK. These values indicate the direction 
the trunk was used (no direction, incoming or 
outgoing). If the ECS does not supply this item, the 
library supplies a value of 
C_NUSE_LONG. 
grp_ptr is a pointer to an optional character 
string of length gid_length that indicates a 
ECS-assigned identifier of the trunk that was used. 
If this item is not ECS-provided, the pointer is a null 
pointer. Similarly, 
id_ptr is a pointer to a 
character string of length 
id_length that 
indicates the ECS-assigned identifier of the trunk 
that was used. If this item is not ECS-provided, 
id_ptr is a null pointer.
oli is an optional oli_t structure that 
specifies II digits from the originating line 
information for the call.
Table 9-2. Event-Name Members and Descriptions — Continued
Event Nameevr_buf Member Description 
						

							Programming Manual Pages
9-118Issue  3  May 1998 
C_ALERTING 
(Continued)alert_list 
(Continued)ucid (Universal Call ID) is an optional 8 byte binary 
value assigned by ECS. 
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_CALL_ORIG orig_list call_id: See C_ALERTING.
cause
: See C_ALERTING.
connect_num
 (optional) A pointer to a 
null-terminated string that indicates the originating 
device. Normally this is the same as the call 
number and then omitted, however, in this case 
where the call is originated from a logical agent 
extension, this will indicate the physical extension 
from which the call was made.
con_num_type: See C_ALERTING.
call_id
: See C_ALERTING.
calling_num
: is a pointer to a null terminated 
string that indicates the number that originated the 
call, usually the extension number. For Third Party 
Make Calls originating from a logical agent, this is 
the logical agent number of the agent that is logged 
into the station making the call.
call_num_type: See C_ALERTING.
called_num
 is a pointer to an optional 
null-terminated string that indicates the called 
extension. If the extension number is not supplied, 
called_num is a null pointer.
called_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). See 
C_ALERTING: con_num_type for more 
information concerning plan_type_t.
uudata: See C_ALERTING.
party_id:
 the party number of the originating 
device on the call.
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