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

							Programming Manual Pages
Issue  3  May 1998
9-69
call_id
call_id is ECS-assigned identifier of the call to be dropped. call_id is used 
only when the association is initiated by the C_3PDC_REQ capability.
NOTE:
party_id and call_id are not ASCII null-terminated strings but rather an 
array of binary bytes of the specified length. See ‘‘Identifiers’’ on page 8-5 in 
Chapter 8, ‘‘ASAI Capability Primitives’’ for more information.
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 which 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.
resource
The resource field specifies the resource to be dropped from the call. The 
available resources are C_CALL_CLASSIFIER and C_TONE_GENERATOR. The 
“tone generator” is defined in this case as being any locally applied denial tone 
that is timed by ECS. The resource field may be included in the C_3PSD 
capability when the association is initiated by the either C_3PMC_REQ or 
C_3PTC_REQ capability and when the party_id is not included. The field is zero 
if no resources are to be dropped.
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
9-70Issue  3  May 1998 
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.
Notes
This capability can be issued only by a client.
See Also
asai_send()
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 
						

							Programming Manual Pages
Issue  3  May 1998
9-71
C_3PSD_CONF (3ASAI)
Name
C_3PSD_CONF — Acknowledge a third party selective drop request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}a3psd_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PSD request.
asai_common
Within this structure, capability is returned as C_3PSD_CONF; 
primitive_type is returned as C_POS_ACK for positive acknowledgement and 
as C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) specified in the C_3PSD request is also returned.
cause_value
This parameter can be any of the following:
  C_INVLDNUM
  C_PROTERR
  C_RESUNAVL
  C_FACUNSUB
  C_SER_UNIMP
  C_MAND_INFO
  C_INVLDIE
  C_SERV_UNAVIL
  C_CALLID_TERM
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
9-72Issue  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, 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_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
Issue  3  May 1998
9-73
C_3PSDS (3ASAI)
Name
C_3PSDS — Send DTMF Signals on behalf of a party on a call
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
   asai_common_t   asai_common;
   call_id_t       call_id;
   party_id_t      tx_party_id;
   party_id_t      tx_party_ids[5]; 
   user_code_t     user_data;
   long            tone_duration;
   long            pause_duration;
   char            pool [C_DATSZ];
} a3psds_info_t;
Description
The client sends this capability to request that DTMF tones be sent to all 
parties on a call that are connected to ECS via ports that support end-to-end 
signaling and that have active listen paths to the sender. A structure of type 
a3psds_info_t contains the parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PSDS 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 apply DTMF 
signals.
tx_party_id
tx_party_id is a conditional parameter and specifies the party on whose 
transmit path the DTMF signals will be applied. The length of the identifier is
 id_length. tx_party_id must be used when the association is initiated by 
the C_3PMC_REQ and C_3PTC_REQ capabilities. Otherwise, the parameter is not 
used. tx_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 more information. 
						

							Programming Manual Pages
9-74Issue  3  May 1998 
call_id
call_id is ECS-assigned identifier of the active call on which the DTMF signals 
will be applied. call_id is used only when the association is initiated by the 
C_3PDC_REQ capability.
user_data
The user_data structure is used to convey the information about the DTMF 
digits to ECS.
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 string of no more that 32 characters in 
length.
tone_duration
The tone_duration is an optional parameter that specifies in .01 second 
increments, the duration of each tone. The default duration is .35 seconds (350 
milliseconds). Valid values are from .06 seconds to .35 seconds.
pause_duration
The pause_duration is an optional parameter that specifies in .01 second 
increments, the duration of the pause in between tones. The default duration is 
.10 seconds (100 milliseconds). Valid values are from .04 seconds to .10 seconds.
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.
Notes
This capability can be issued only by a client. 
						

							Programming Manual Pages
Issue  3  May 1998
9-75
See Also
asai_send()
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 
						

							Programming Manual Pages
9-76Issue  3  May 1998 
C_3PSDS_CONF (3ASAI)
Name
C_3PSDS_CONF — Acknowledge a send DTMF request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}a3psds_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PSDS request.
asai_common
Within this structure, capability is returned as C_3PSDS_CONF, and 
primitive_type is returned as C_POS_ACK for positive acknowledgement and 
as C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) is specified in the C_3PSDS request is also returned.
cause_value
This parameter can be any of the following:
  C_INVLDNUM
  C_PROTERR
  C_RESUNAVL
  C_FACUNSUB
  C_SER_UNIMP
  C_MAND_INFO
  C_INVLDIE
  C_SERV_UNAVIL
  C_CALLID_TERM
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
Issue  3  May 1998
9-77
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_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-78Issue  3  May 1998 
C_3PSH (3ASAI)
Name
C_3PSH — Place selected party on hold
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        party_id_t          party_id;
        call_id_t           call_id;
        char                pool[C_DATSZ];
}a3psh_info_t;
Description
The client sends this capability to request that a party be placed on hold. The 
party must be on a call controlled by the client. A structure of type
a3psh_info_t contains the parameters needed to fulfill this request.
asai_common
The programmer sets capability to C_3PSH 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 held.
party_id
For call control associations, that is, those initiated with C_3PTC_REQ or 
C_3PMC_REQ, party_id specifies the party to be placed on hold. For 
domain-controlled associations the parameter is not used.
The party_id structure contains two fields, id_ptr and id_length. The field, 
id_ptr, does not point to a null-terminated character string but rather an array of 
binary bytes of the specified length.
call_id
call_id is ECS-assigned identifier of the call to be placed on hold.
call_id is used only when the association is initiated by the C_3PDC_REQ 
capability.