2.2.4.1.3.77 SetUpConference
The SetUpConference packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet MUST set up a conference call for the addition of the third party.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Req_Func |
|||||||||||||||||||||||||||||||
|
Reserved1 |
|||||||||||||||||||||||||||||||
|
dwRequestID |
|||||||||||||||||||||||||||||||
|
lpContext |
|||||||||||||||||||||||||||||||
|
hCall |
|||||||||||||||||||||||||||||||
|
hLine |
|||||||||||||||||||||||||||||||
|
lphConfCallContext |
|||||||||||||||||||||||||||||||
|
lphConsultCallContext |
|||||||||||||||||||||||||||||||
|
dwNumParties |
|||||||||||||||||||||||||||||||
|
lpCallParams |
|||||||||||||||||||||||||||||||
|
dwAsciiCallParamsCodePage |
|||||||||||||||||||||||||||||||
|
Reserved2 |
|||||||||||||||||||||||||||||||
|
Reserved3 |
|||||||||||||||||||||||||||||||
|
Reserved4 |
|||||||||||||||||||||||||||||||
|
Reserved5 |
|||||||||||||||||||||||||||||||
|
VarData (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
Req_Func (4 bytes): An unsigned 32-bit integer. The identifier of the function that will be invoked on the remote server. This value MUST be set to 84.
-
Return Values
-
On completion of ClientRequest, this field MUST contain the result of the encapsulated telephony request. A nonzero request ID value indicates that the request is in progress and will complete asynchronously, and a LINEERR_Constants value indicates synchronous failure.
-
Returns a positive request identifier if the function will be completed asynchronously or a negative error number if an error occurs. The dwParam2 parameter of the corresponding LINE_REPLY packet is zero if the function succeeds, or it is a negative error number if an error occurs. If the client specified a nonzero value in the dwRequestID field of the packet, the same value MUST be used for the returned positive request identifier. Common return values are:
-
Name
Value
LINEERR_BEARERMODEUNAVAIL
0x80000003
LINEERR_UNINITIALIZED
0x80000050
LINEERR_CALLUNAVAIL
0x80000005
LINEERR_INVALMEDIAMODE
0x8000002F
LINEERR_CONFERENCEFULL
0x80000007
LINEERR_INVALPOINTER
0x80000035
LINEERR_INUSE
0x8000000F
LINEERR_INVALRATE
0x80000037
LINEERR_INVALADDRESSMODE
0x80000012
LINEERR_NOMEM
0x80000044
LINEERR_INVALBEARERMODE
0x80000016
LINEERR_NOTOWNER
0x80000046
LINEERR_INVALCALLHANDLE
0x80000018
LINEERR_OPERATIONUNAVAIL
0x80000049
LINEERR_INVALCALLSTATE
0x8000001C
LINEERR_OPERATIONFAILED
0x80000048
LINEERR_INVALCALLPARAMS
0x80000019
LINEERR_RATEUNAVAIL
0x8000004A
LINEERR_INVALLINEHANDLE
0x8000002B
LINEERR_RESOURCEUNAVAIL
0x8000004B
LINEERR_INVALLINESTATE
0x8000002C
LINEERR_STRUCTURETOOSMALL
0x8000004D
LINEERR_USERUSERINFOTOOBIG
0x80000051
Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.
dwRequestID (4 bytes): The identifier of the asynchronous request.
-
Value
Meaning
0x00000000
An unsigned 32-bit integer. The server MUST generate a unique positive request ID to return as the Ack_ReturnValue.
0x00000001 — 0x7FFFFFFF
The server MUST use this value instead of generating a unique positive request ID.
lpContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.
hCall (4 bytes): An HCALL. The handle to the Initial call that identifies the first party of a conference call. In some environments, a call MUST exist to start a conference call, and the application MUST be an owner of this call. In other telephony environments, where no call initially exists, hCall MUST be left NULL, and hLine MUST be specified to identify the line on which the conference call is to be initiated. If hCall is not NULL, the call state of hCall must be connected. One way in which this handle can be obtained is by sending the MakeCall packet to the remote server.
hLine (4 bytes): An HLINE. The handle to the line. This handle MUST be used to identify the line device on which to originate the conference call if hCall is NULL. The hLine parameter is ignored if hCall is not NULL. This field MUST have been obtained by sending the Open packet.
lphConfCallContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.
lphConsultCallContext (4 bytes): An unsigned 32-bit integer. The opaque, client-specified value that is used by the client upon request completion; MUST be returned by the server in the request completion packet.
dwNumParties (4 bytes): An unsigned 32-bit integer. The expected number of parties in the conference call. This number MUST be passed to the service provider. The service provider is free to do as it pleases with this number: ignore it, use it as a hint to allocate the correct size of the conference bridge inside the switch, and so on.
lpCallParams (4 bytes): An unsigned 32-bit integer. The size, in bytes, of a LINECALLPARAMS packet in the VarData field that contains call parameters to use when establishing the consultation call. If this field is -1 (0xFFFFFFFF), it indicates that no LINECALLPARAMS packet was specified.
dwAsciiCallParamsCodePage (4 bytes): An unsigned 32-bit integer. This MUST be set to TAPI_NO_DATA (0xFFFFFFFF).
Reserved2 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved3 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved4 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved5 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
VarData (variable): MUST contain a LINECALLPARAMS packet.
-
The contents of this field are aligned to the next byte.