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

							Programming Manual Pages
Issue  3  May 1998
9-49
C_3PMC_CONF (3ASAI)
Name
C_3PMC_CONF — Acknowledge a third party make call request
Ty p e
Continuing — Unacknowledged, when used as a positive acknowledgment
Terminating — Unacknowledged, when used as a negative acknowledgment
Usage
typedef struct{
        asai_common_t   asai_common;
        party_id_t      party_id;
        call_id_t       call_id;
        number_id_t     connected;
        ucid_t          ucid;         /* G3V6 */ 
        char            pool[C_DATSZ];
}a3pmc_ack_t;
typedef struct{
        asai_common_t   asai_common;
        long            cause_value;
}a3pmc_nak_t;
Description
The client receives this capability as a positive or negative acknowledgment of a 
C_3PMC_REQ request.
asai_common
Within this structure, capability is returned as C_3PMC_CONF, and 
primitive_type is returned as C_POS_ACK for a positive acknowledgment and 
as C_NEG_ACK for a negative acknowledgment. The sao_id (also known as 
cluster_id) specified in the C_3PMC request is also returned.
A positive acknowledgment confirms that the C_3PMC_REQ request has been 
received and understood. Subsequent event reports will indicate the progress of 
the call. For a positive acknowledgment, a3pmc_ack is used. For a negative 
acknowledgment, a3pmc_nak is used.
party_id
This parameter indicates the originating party on the call. 
						

							Programming Manual Pages
9-50Issue  3  May 1998 
call_id
This parameter identifies the call that was created by the third party make call 
request.
connected
This parameter identifies the connected number which, along with other 
information, is contained in the number_id_t structure. The s field of the 
number_id_t structure, when not NULL, is an ASCII string containing the 
connected number. If s is NULL, the following field, type_plan, is undefined. 
The type_plan field is of type plan_type_t. For more information concerning 
plan_type_t, see the C_EN_REP: C_ALERTING description in this section. 
This field represents the calling party and is only present when the originator is an 
EAS agent.
ucid
This parameter identifies the ucid that was created by the third party make call 
request. This id is 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_FACUNSUB
  C_INCOM_OPT
  C_INVLDIE
  C_INVLDNUM
  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.
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. 
						

							Programming Manual Pages
Issue  3  May 1998
9-51
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_3PTC_REQ 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 
						

							Programming Manual Pages
9-52Issue  3  May 1998 
C_3PMC_REQ (3ASAI)
Name
C_3PMC_REQ — Make a third party call 
Ty p e
Initiating — Acknowledged or unacknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        char                *calling_num;
        char                *called_num;
        user_user_t         uudata; 
        long                ofacility;
        char                *ofac_ext;
        long                prio_call;
        long                alert_time;
        long                serv_cir;
        long                dir_agtcall;
        long                super_ast;
        long                alt_dest;
        long                ack_flag;
        long                ans_mach_treat; 
        char                pool[C_DATSZ];
}a3pmc_info_t;
Description
The client sends this capability to request establishment of a third party call. A 
structure of type a3pmc_info_t contains the third party call-setup parameters.
asai_common
Within this structure, the programmer sets capability to C_3PMC_REQ and 
primitive_type to C_REQUEST. The programmer also sets the controlling 
association to sao_id (also known as cluster_id).
calling_num
The calling_num, a mandatory parameter, is a pointer to a null-terminated 
character string that specifies the calling extension. 
						

							Programming Manual Pages
Issue  3  May 1998
9-53
called_num
The mandatory parameter called_num is a pointer to a null-terminated character 
string that specifies the called extension.
uudata
The purpose of the uudata 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-to-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-to-user data length of 32 bytes, although user-to-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.
prio_call
The requester can indicate call options to be used for the call. The prio_call 
parameter can take the value of C_PRIOR_ON (indicating that the call is a priority 
call) or C_PRIOR_OFF (indicating that the call is not a priority call).
alert_time
The alert_time parameter indicates the maximum number of rings to wait after 
the call has reached the alerting state. 
						

							Programming Manual Pages
9-54Issue  3  May 1998 
serv_cir
The serv_cir parameter with a value of C_SERV_ON indicates that a call 
classifier is to be added to the call request. The default is C_SERV_OFF.
dir_agtcall
A value of C_DIRAGT_ON for dir_agtcall indicates that the call is directed to a 
specific ACD agent. When dir_agtcall is selected, ofac_ext contains the 
identifier of the ACD split containing the agent, and ofacility should be set to 
C_ACD_SPLIT.
super_ast
A C_SUP_AS_ON value for super_ast indicates that the call is an ACD call, 
directed to an ACD supervisor by an agent who needs assistance; otherwise, this 
parameter assumes a value of C_SUP_AS_OFF when super_ast is selected. 
When super_ast is selected, ofac_ext contains the identifier of the ACD split 
containing the agent, and ofacility should be set to C_ACD_SPLIT.
alt_dest
The alt_dest parameter can assume the values of C_ALERT_ON (indicating 
that the destination is to be alerted first) or C_ALERT_OFF.
ack_flag
The ack_flag parameter allows the client to request acknowledgement of the 
make call request. A value of C_ACK_ON indicates that acknowledgement is 
expected; C_ACK_OFF indicates that acknowledgement is not expected.
ans_mach_treat
If ans_mach_treat is CO_AM_DISC, the call is disconnected upon answering 
machine detection. If the treatment is C_CO_AM_SWITCH, it follows the setting in 
ECS administration. If the treatment is C_CO_AM_CONNECT, the call is 
disconnected.
This parameter must be coded -1 if unused.
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. 
						

							Programming Manual Pages
Issue  3  May 1998
9-55
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_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_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
9-56Issue  3  May 1998 
C_3PR (3ASAI)
Name
C_3PR — Reconnect a held party
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];
}a3pr_info_t;
Description
The client sends this capability to request reconnection of a held party to a call 
controlled by the client. The structure of type a3pr_info_t contains the 
parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PR and primitive_type to 
C_REQUEST. The sao_id (also known as cluster_id) identifies the association 
that controls the call to be reconnected. The programmer also sets the sao_id     
(cluster_id) to the association identifier used to put the party on hold.
party_id
Specifies the party to be reconnected. The length of id_ptr is held in 
id_length, and is always 1. party_id is used only when the association is 
initiated by the C_3PTC_REQ or the C_3PMC_REQ capability.
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.
call_id
call_id is ECS-assigned identifier of the call to reconnect. The value of this 
parameter is a character array of length id_length, pointed to by id_ptr. 
call_id is used only when the association is initiated by the C_3PDC_REQ 
capability. 
						

							Programming Manual Pages
Issue  3  May 1998
9-57
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.
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_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
9-58Issue  3  May 1998 
C_3PR_CONF (3ASAI)
Name
C_3PR_CONF — Acknowledge a third party reconnect request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}a3pr_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement to a 
C_3PR request.
asai_common
Within asai_common, capability is returned as C_3PR_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_3PR request is also returned.
cause_value
This parameter can be any of the following:
  C_CALLID_TERM
  C_FACUNSUB
  C_INCOM_ST
  C_INVLDIE
  C_INVLDNUM
  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.