2.2.4.1.3.57 SetAgentActivity

The SetAgentActivity packet is transmitted from a TAPI client to a TAPI server in a remote procedure call. Sending this packet sets the agent activity code that is associated with a particular address.

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

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.

MUST return a positive request identifier if the asynchronous operation starts; otherwise, the function MUST return one of these negative error values:

Name	Value
LINEERR_INVALADDRESSID	0x80000011
LINEERR_INVALADDRESSSTATE	0x80000013
LINEERR_INVALAGENTACTIVITY	0x8000005B
LINEERR_INVALLINEHANDLE	0x8000002B
LINEERR_INVALPOINTER	0x80000035
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.

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

dwAddressID (4 bytes): An unsigned 32-bit integer. The identifier of the address for which the agent activity code is to be changed. 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.

dwActivityID (4 bytes): An unsigned 32-bit integer. New agent activity id. The meaning of all values of this parameter are specific to the application and call center server.

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.

Reserved9 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.

Reserved10 (4 bytes): An unsigned 32-bit integer. This field is used for padding and MUST be ignored on receipt. It can be any value.