2.2.4.1.3.11 CreateAgentSession

The CreateAgentSession packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet creates a new AgentSession object. It generates a LINE_PROXYREQUEST packet to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST packet of type LINEPROXYREQUEST_CREATEAGENTSESSION.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Req_Func

Reserved1

dwRequestID

lpContext

hLine

hAgent

lpszAgentPIN

dwWorkingAddressID

lpGroupID

dwSize

lphAgentSessionContext

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 147.

Return Values

On completion of ClientRequest, this field contains 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 request identifier if the asynchronous operation starts; otherwise, the function MUST return one of the following error values:

Name

Value

LINEERR_INVALLINEHANDLE

0x8000002B

LINEERR_INVALPARAM

0x80000032

LINEERR_NOMEM

0x80000044

LINEERR_OPERATIONFAILED

0x80000048

LINEERR_OPERATIONUNAVAIL

0x80000049

LINEERR_RESOURCEUNAVAIL

0x8000004B

LINEERR_UNINITIALIZED

0x80000050

Reserved1 (4 bytes): An unsigned 32-bit integer. MUST be set to zero when sent and MUST be ignored on receipt.

dwRequestID (4 bytes): An unsigned 32-bit integer. The identifier of the asynchronous request.

Value

Meaning

0x00000000

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.

hLine (4 bytes): An HLINE. The handle to the line device. This field MUST have been obtained by sending the Open packet.

hAgent (4 bytes): An unsigned 32-bit integer. The identifier of the agent for whom the session is to be created. This field MUST have been obtained by sending the CreateAgent packet.

lpszAgentPIN (4 bytes): An unsigned 32-bit integer. The offset in the VarData field that contains a null-terminated Unicode string that contains the agent PIN or password. This field is set to TAPI_NO_DATA (0xFFFFFFFF) if no PIN was supplied.

dwWorkingAddressID (4 bytes): An unsigned 32-bit integer. The identifier of the address on which the agent receives calls for this session.

lpGroupID (4 bytes): An unsigned 32-bit integer. The offset, in bytes, in the VarData field and GUID, as specified in [MS-DTYP] section 2.3.4.2, that identifies the group for which the session is being created.

dwSize (4 bytes): An unsigned 32-bit integer. The size, in bytes, of the GUID that is indicated in the lpGroupID field.

lphAgentSessionContext (4 bytes): An unsigned 32-bit integer. The handle to the created agent session that is returned by the ACD proxy. It is the responsibility of the agent handler proxy application to generate and maintain uniqueness of these identifiers.

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): Contains a null-terminated Unicode string that is indicated in the lpszAgentPIN field and a GUID that is indicated in the lpGroupID field.

The contents of this field MUST be DWORD-aligned, as specified in [MS-DTYP] section 2.2.9.