2.2.4.1.3.22 GetAgentActivityList
The GetAgentActivityList packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet obtains the identities of activities that the application can select by using the SetAgentActivity packet to indicate what function the agent is actually performing at the moment.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Req_Func |
|||||||||||||||||||||||||||||||
Reserved1 |
|||||||||||||||||||||||||||||||
dwRequestID |
|||||||||||||||||||||||||||||||
lpContext |
|||||||||||||||||||||||||||||||
hLine |
|||||||||||||||||||||||||||||||
dwAddressID |
|||||||||||||||||||||||||||||||
lpAgentActivityListContext |
|||||||||||||||||||||||||||||||
lpAgentActivityList |
|||||||||||||||||||||||||||||||
Reserved2 |
|||||||||||||||||||||||||||||||
Reserved3 |
|||||||||||||||||||||||||||||||
Reserved4 |
|||||||||||||||||||||||||||||||
Reserved5 |
|||||||||||||||||||||||||||||||
Reserved6 |
|||||||||||||||||||||||||||||||
Reserved7 |
|||||||||||||||||||||||||||||||
Reserved8 |
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 24.
-
Return Values
-
On completion of ClientRequest, this field will 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.
-
MUST return a positive request identifier if the asynchronous operation starts; otherwise, this function MUST return one of these negative error values:
-
Name
Value
LINEERR_INVALADDRESSID
0x80000011
LINEERR_OPERATIONFAILED
0x80000048
LINEERR_INVALAGENTID
0x80000057
LINEERR_OPERATIONUNAVAIL
0x80000049
LINEERR_INVALLINEHANDLE
0x8000002B
LINEERR_RESOURCEUNAVAIL
0x8000004B
LINEERR_INVALPOINTER
0x80000035
LINEERR_STRUCTURETOOSMALL
0x8000004D
LINEERR_NOMEM
0x80000044
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 open line device. This field MUST have been obtained by sending the Open packet.
dwAddressID (4 bytes): An unsigned 32-bit integer. The address on the open line device whose agent status is to be queried. An address identifier is permanently associated with an address; the identifier remains constant across operating system upgrades. A valid value of dwAddressID is in the range 0 to dwNumAddresses – 1. The client obtains dwNumAddresses from the LINEDEVCAPS obtained by sending a GetDevCaps packet to the remote server.
lpAgentActivityListContext (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.
lpAgentActivityList (4 bytes): An unsigned 32-bit integer. The maximum size, in bytes, of the agent activity list data that the client will accept on successful completion of this request.
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.
Reserved6 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved7 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.
Reserved8 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.