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

							Programming Manual Pages
Issue  3  May 1998
9-89
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.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also 
asai_rcv()
C_3PSL_DISC C_3PSL_RECONN C_3PSL_RECONN_ACK C_EN_REP 
C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH
C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD 
C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
9-90Issue  3  May 1998 
C_3PSSC_REQ (3ASAI)     
Name
 C_3PSSC_REQ — Single-Step Conference — adds a station to an existing call
Ty p e
Continuing — Acknowledged
Usage
typedef struct {
asai_common_t  asai_common;
char           *station_ext;
call_id_t      call_id;
long           alt_dst;
long           visibility;
char           pool [C_DATSZ];
} a3pssc_info_t;
Description
The client sends this capability to request that a station be conferenced into an 
existing call. A structure of type a3pssc_info_t contains the parameters 
needed to fulfill the request.
asai_common
The programmer sets the capability to C_3PSSC_REQ and 
primitive_type to C_REQUEST. The programmer also sets the sao_id (also 
known as cluster_id) to identify the association that controls the call to be 
conferenced.
station_ext 
station_ext is a pointer to a null-terminated string that specifies the station 
extension that is to be conferenced. station_ext is used only when the 
association is initiated by the C_3PTC_REQ or the C_3PMC_REQ capability.
call_id
Call_id is the ECS-assigned identifier of the existing call into which the station 
is to be conferenced. Call_id is used only when the association is initiated by 
the C_3PDC_REQ capability. See the ‘‘Identifiers’’ section in Chapter 8, ‘‘ASAI 
Capability Primitives’’ for more information. 
						

							Programming Manual Pages
Issue  3  May 1998
9-91
alt_dest
For this capability, the value C_ALERT_OFF will always be used by the ECS in 
G3V6 release. C_ALERT_OFF corresponds to “add station without alerting” 
(0x80). 
visibility
The visibility parameter can assume either the value C_VISIBLE_ON to 
indicate that the added party should be fully visible to the other parties on the call, 
or C_VISIBLE_OFF to indicate that the added party should not be visible to the 
other parties on the call.
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.
 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 no data has been sent.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes. If the association specified is under Call 
Control and the station_ext is null, the API will return C_BADMATCH and the 
request will be aborted. If the association is under Domain Control and the 
call _id length is 0, the API will return C_BADMATCH and abort the request.
Notes
This capability can be issued only by a client.
See Also 
asai_send()
C_3PSL_DISC C_3PSL_DISC_ACK C_3PSL_RECONN_ACK C_EN_REP
C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH 
C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD_CONF 
C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF C_3PSSC_CONF 
						

							Programming Manual Pages
9-92Issue  3  May 1998 
C_3PSSC_CONF (3ASAI)
Name
 C_3PSSC_CONF— Acknowledge a third party Single-Step Conference 
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
party_id_t           party_id;
char                 *extension;
      plan_type_t          ext_type;
} ssconf_ext_t;
typedef struct{
asai_common_t        asai_common;
call_id_t            call_id;
long                 num_conf_ext;
ssconf_ext_t         *party_list;
ucid_t               ucid;            /* new in R6 */
char                 pool [C_DATSZ];
}a3pssc_ack_t;
typedef struct{
asai_common_t        asai_common;
long                 cause_value;
} a3pssc_nak_t;
Description
The client receives this capability as a positive or negative acknowledgement of a  
C_3PSSC_REQ request.
asai_common
Within this structure, capability is returned as C_3PSSC_CONF; 
primitive_type is returned as C_POS_ACK for positive acknowledgement with 
an array of parties on the call. Primitive_type is returned as C_NEG_ACK for 
negative acknowledgement with the cause value. The sao_id (also known as 
cluster_id) specified in the C_3PSSC_CONF request is also returned. 
						

							Programming Manual Pages
Issue  3  May 1998
9-93
call_id
Within a3pssc_ack_t, call_id specifies the ECS-assigned call identifier of the 
call.
num_conf_ext
This parameter specifies the number of parties connected to the call.
party_list
This parameter, party_list is a pointer to a structure of type conf_ext_t. Each 
element of this list, up to and including the element identified by num_conf_ext 
contains information about the parties connected to the call. In each of these 
party_id structures, id_ptr is a pointer to the ECS-assigned party identifier. 
id_length indicates the length of the party identifier, extension points to a 
null-terminated character string indicating the extension or station number 
associated with that party; ext_type contains information about the numbering 
plan of the extension number.
ucid
During a positive acknowledgment, a structure of type a3pssc_ack_t contains 
information regarding the UCID (Universal Call ID) assigned by the ECS. 
pool
The pool parameter is a character array that provides the buffer space for the 
ASAI library to store program-specific information.
cause_value
This parameter can be any of the following:
              C_INVLDNUM
              C_SERV_UNAVAIL
              C_REORDER_DENIAL
              C_INCOM_ST
              C_INVALID_CRV
              C_USER_BUSY
              C_NUSE_RESP
              C_MAND_INFO
              C_PERM_DENIED
              C_PROTERR
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
9-94Issue  3  May 1998 
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.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also 
asai_rcv()
C_3PSL_DISC C_3PSL_RECONN C_3PSL_RECONN_ACK C_EN_REP 
C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH
C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD 
C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF C_3PSSC_CONF 
						

							Programming Manual Pages
Issue  3  May 1998
9-95
C_3PTC_CONF (3ASAI)
Name
C_3PTC_CONF — Acknowledge a third party take control request
Ty p e
Continuing — Unacknowledged, when received as a positive acknowledgement
Terminating — Unacknowledged, when received as a negative acknowledgement
Usage
typedef struct{
        asai_common_t       asai_common;
        long                num_party_ext;
        party_ext_t        *party_ext_list;
        ucid_t              ucid;            /*G3V6 */
        char                pool[C_DATSZ];
}a3ptc_ack_t;
typedef struct{
        asai_common_t       asai_common;
        long                cause_value;
}a3ptc_nak_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PTC_REQ request. Positive acknowledgement parameters are specified by 
a3ptc_ack_t and negative acknowledgement parameters by a3ptc_nak_t.
asai_common
Within this structure, capability is returned as C_3PTC_CONF; 
primitive_type is returned as it is set to C_POS_ACK for positive 
acknowledgement and to C_NEG_ACK for negative acknowledgement. The 
sao_id (also known as cluster_id) specified in the C_3PTC request is also 
returned.
party_ext_list,num_party_ext
This parameter points to a list of structures. During a positive acknowledgment, a 
structure of type a3ptc_ack_t contains information concerning the existing 
parties to the call. The number of structures in the list is given by
num_party_ext. Within party_ext_list, party_id specifies a party to the 
call. The extension parameter is a pointer to a null-terminated string that  
						

							Programming Manual Pages
9-96Issue  3  May 1998 
indicates the extension of the party. See ‘‘Identifiers’’ on page 8-5 in Chapter 8, 
‘‘ASAI Capability Primitives’’ for a description of party_id.
ucid
During a positive acknowledgment, a structure of type a3ptc_ack_t contains 
information regarding the UCID (Universal Call ID) assigned by ECS. 
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.
cause_value
This parameter can be any of the following:
  C_CALLID_TERM
  C_FACUNSUB
  C_INVLDIE
  C_MAND_INFO
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVAIL
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 of error messages with brief 
explanations of their probable causes.
See Also
asai_rcv()
C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PSH
C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD
C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
Issue  3  May 1998
9-97
C_3PTC_REQ (3ASAI)
Name
C_3PTC_REQ — Take control of an existing third party call
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        call_id_t           call_id;
        char                pool[C_DATSZ];
}a3ptc_info_t;
Description
The client sends this capability to request control of an existing call. The 
a3ptc_info_t structure contains the parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PTC_REQ and primitive_type to 
C_REQUEST. The programmer also sets the association identifier to the sao_id 
(also known as cluster_id) that identifies the call.
call_id
This structure contains a pointer, id_ptr, to a binary array of length id_length 
that specifies the ECS-assigned value of the call identifier for which the request is 
intended.
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.
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 no data has been sent. 
						

							Programming Manual Pages
9-98Issue  3  May 1998 
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_send()
C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_CONF C_3PSH
C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD
C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF