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

ASAI Capability Primitives
Issue  3  May 1998
8-5
Identifiers
The ASAI library routinely uses a number of identifiers, defined in structures of the 
types shown. All of these structures include a field reserved for future use. The 
most common identifiers are:
nCall identifier (call_id) — Identifies a specific call.
nParty identifier (party_id) — Identifies specific parties on a call.
nOld party identifier (old_party_id) — Identifies an ECS-assigned 
identifier before two calls are merged.
nTrunk...

ASAI Capability Primitives
8-6Issue  3  May 1998 
NOTE:
call_id is not an ASCII null-terminated string but rather an array of binary 
bytes of the specified length. The length is subject to change.
party_id
typedef struct{
        char                *id_ptr;
        long                id_length;
        long                reserved;
}party_id_t;
Within party_id_t, the parameter id_length indicates the number of bytes 
contained in the party identifier, and id_ptr is the value of a pointer to the array...

ASAI Capability Primitives
Issue  3  May 1998
8-7
trunk_id
typedef struct{
        char        *gid_ptr;
        char        *id_ptr;
        long        gid_length;
        long        id_length;
        long        direct;
        long        reserved;
} trunk_id_t;
Within trunk_id_t, gid_ptr is a pointer to an array of binary bytes indicating 
an ECS-assigned trunk group identifier of length gid_length. id_ptr is a 
pointer to an array of binary bytes indicating an ECS-assigned identifier, in the...

ASAI Capability Primitives
8-8Issue  3  May 1998 
party_ext
typedef struct{
        party_id_t      party_id;
        char            *extension;
        plan_type_t     ext_type; 
}party_ext_t;
Within party_ext_t, the parameter party_id is a structure of type
party_id_t. The extension parameter points to a null-terminated string that 
specifies the extension corresponding to the party identifier.
ext_type is a structure of type plan_type_t that supplies additional 
information about the extension field...

ASAI Capability Primitives
Issue  3  May 1998
8-9
Within merge_ext_t, the parameter old_pid is a structure of type
old_party_id_t, which provides the old party identifier (see ‘‘old_party_id’’ on 
page 8-6). 
The parameter party_id is a structure of type party_id_t that indicates an 
ECS-assigned party identifier after two calls are merged (see ‘‘party_id’’ on page 
8-6 for details).
The extension parameter points to a null-terminated string that specifies the 
extension that corresponds to the party....

ASAI Capability Primitives
8-10Issue  3  May 1998 
The user_data structure is used to convey the information about the DTMF 
digits to the ECS, and with the collected digits event report to convey information 
to the adjunct. The leng field is an integer value that indicates the number of 
octets (digits) of user_data included in the request. The type field indicates the 
type of information and is restricted to C_UU_IA5, which indicates IA5 or ASCII 
characters.
The digits field is a pointer to an ASCII...

ASAI Capability Primitives
Issue  3  May 1998
8-11
The field id_length is the length of the byte array pointed to by the field 
id_ptr. If the IE is missing from the message or its length is zero, id_length is 
zero. In all other cases, it is the size of the array.
This substructure is included in the following ASAI event report capability 
structures:
1. Alerting (alert_list_t)
2. Call conferenced (conf_list_t)
3. Call initiated (initiate_list_t)
4. Call offered to Domain (incall_list_t)
5. Call...

ASAI Capability Primitives
8-12Issue  3  May 1998 
cause_value
Certain capabilities return a parameter called cause_value if a negative 
acknowledgement is sent or received. These cause_values are noted with each 
capability. In general, a cause_value is returned by the ECS and mapped to an 
ASAI cause_value. Table 8-1 lists ASAI cause_values by name, shows the  
DEFINITY ECS value, the ASAI library value, and provides a brief explanation of 
the probable cause.
Table 8-1. ASAI Library and the DEFINITY...

ASAI Capability Primitives
Issue  3  May 1998
8-13
*C_INCS_AGT_ST CS3/12 20 Agent not in compatible state.
C_INVALID_MESSAGE CS0/95 40 Invalid message, unspecified 
(backward compatibility).
*C_INVALID_CRV CS0/81 10 Invalid call identifier (sao_id 
also known as cluster_id) 
used or call does not exist.
*C_INVLDIE CS0/100 6 Value specified in parameter is 
not allowed or defined.
*C_INVLDNUM CS0/28 0 Invalid origination or 
destination address.
*C_MAND_INFO CS0/96 5 One of the required parameters 
is...

ASAI Capability Primitives
8-14Issue  3  May 1998 
*C_OUT_CALL_BARRED CS0/52 49 Outgoing call has been barred.
*C_OUT_OF_SERV CS3/27 19 Domain has been removed by 
administration.
*C_PERM_DENIED CS3/43 17 Permission checks for service 
have failed.
*C_PROTERR CS0/111 1 Capability sequence has been 
violated or underlying protocol 
error has been detected; an 
unrecognized value was 
returned by the ECS.
*C_QUEFULL CS3/22 28 Queue is full.
*C_REC_TIMER CS0/102 12 Timer expired.
C_REDIRECT CS3/30 46...