STRUCTURE LINEPROXYREQUEST (tapi.h)
La structure LINEPROXYREQUEST contient les valeurs de paramètre de l’application qui effectue la demande de proxy. Plusieurs fonctions de centre d’appels TAPI génèrent un message LINE_PROXYREQUEST qui fait référence à une structure LINEPROXYREQUEST .
Syntaxe
typedef struct lineproxyrequest_tag {
DWORD dwSize;
DWORD dwClientMachineNameSize;
DWORD dwClientMachineNameOffset;
DWORD dwClientUserNameSize;
DWORD dwClientUserNameOffset;
DWORD dwClientAppAPIVersion;
DWORD dwRequestType;
union {
struct {
DWORD dwAddressID;
LINEAGENTGROUPLIST GroupList;
} SetAgentGroup;
struct {
DWORD dwAddressID;
DWORD dwAgentState;
DWORD dwNextAgentState;
} SetAgentState;
struct {
DWORD dwAddressID;
DWORD dwActivityID;
} SetAgentActivity;
struct {
DWORD dwAddressID;
LINEAGENTCAPS AgentCaps;
} GetAgentCaps;
struct {
DWORD dwAddressID;
LINEAGENTSTATUS AgentStatus;
} GetAgentStatus;
struct {
DWORD dwAddressID;
DWORD dwAgentExtensionIDIndex;
DWORD dwSize;
BYTE Params[1];
} AgentSpecific;
struct {
DWORD dwAddressID;
LINEAGENTACTIVITYLIST ActivityList;
} GetAgentActivityList;
struct {
DWORD dwAddressID;
LINEAGENTGROUPLIST GroupList;
} GetAgentGroupList;
struct {
HAGENT hAgent;
DWORD dwAgentIDSize;
DWORD dwAgentIDOffset;
DWORD dwAgentPINSize;
DWORD dwAgentPINOffset;
} CreateAgent;
struct {
HAGENT hAgent;
DWORD dwAgentState;
DWORD dwNextAgentState;
} SetAgentStateEx;
struct {
HAGENT hAgent;
DWORD dwMeasurementPeriod;
} SetAgentMeasurementPeriod;
struct {
HAGENT hAgent;
LINEAGENTINFO AgentInfo;
} GetAgentInfo;
struct {
HAGENTSESSION hAgentSession;
DWORD dwAgentPINSize;
DWORD dwAgentPINOffset;
HAGENT hAgent;
GUID GroupID;
DWORD dwWorkingAddressID;
} CreateAgentSession;
struct {
HAGENT hAgent;
LINEAGENTSESSIONLIST SessionList;
} GetAgentSessionList;
struct {
HAGENTSESSION hAgentSession;
LINEAGENTSESSIONINFO SessionInfo;
} GetAgentSessionInfo;
struct {
HAGENTSESSION hAgentSession;
DWORD dwAgentSessionState;
DWORD dwNextAgentSessionState;
} SetAgentSessionState;
struct {
GUID GroupID;
LINEQUEUELIST QueueList;
} GetQueueList;
struct {
DWORD dwQueueID;
DWORD dwMeasurementPeriod;
} SetQueueMeasurementPeriod;
struct {
DWORD dwQueueID;
LINEQUEUEINFO QueueInfo;
} GetQueueInfo;
struct {
LINEAGENTGROUPLIST GroupList;
} GetGroupList;
};
} LINEPROXYREQUEST, *LPLINEPROXYREQUEST;
Membres
dwSize
Nombre total d’octets alloués par TAPI pour contenir la structure LINEPROXYREQUEST . Le membre dwTotalSize de toute structure contenue dans LINEPROXYREQUEST (par exemple, LINEAGENTCAPS) reflète uniquement le nombre d’octets alloués pour cette structure spécifique. Taille totale, en octets, du bloc de paramètres Params .
dwClientMachineNameSize
Taille de la chaîne de nom de l’ordinateur client, en octets, y compris le caractère de fin null.
dwClientMachineNameOffset
Décalage du début de la structure vers une chaîne terminée par null identifiant l’ordinateur client qui a effectué cette demande. La taille de la chaîne est spécifiée par dwClientMachineNameSize.
dwClientUserNameSize
Taille de la chaîne de nom d’utilisateur client, en octets, y compris le caractère de fin null.
dwClientUserNameOffset
Décalage du début de la structure vers une chaîne terminée par null identifiant l’utilisateur sous lequel l’application s’exécute sur l’ordinateur client. La taille de la chaîne est spécifiée par dwClientUserNameSize.
dwClientAppAPIVersion
Version d’API la plus élevée prise en charge par l’application qui a effectué la demande. Le gestionnaire de proxy doit limiter le contenu de toutes les données retournées à l’application aux membres et valeurs définis dans cette version ou dans les versions antérieures de TAPI.
dwRequestType
Une des constantes LINEPROXYREQUEST_. Identifie le type de fonction et le composant d’union qui définit les données restantes dans la structure.
SetAgentGroup
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENT.
SetAgentGroup.dwAddressID
Identificateur de l’adresse pour laquelle l’agent doit être défini.
SetAgentGroup.GroupList
Structure de type LINEAGENTGROUPLIST. Les décalages au sein de cette structure sont relatifs au début de SetAgentGroup.GroupList plutôt qu’au début de la structure LINEPROXYREQUEST .
SetAgentState
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTSTATE.
SetAgentState.dwAddressID
Identificateur de l’adresse pour laquelle l’état de l’agent doit être défini.
SetAgentState.dwAgentState
Nouvel état de l’agent ou zéro pour laisser l’état de l’agent inchangé.
SetAgentState.dwNextAgentState
Nouvel état de l’agent suivant ou zéro pour utiliser l’état suivant par défaut associé à l’état de l’agent spécifié.
SetAgentActivity
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTACTIVITY.
SetAgentActivity.dwAddressID
Identificateur de l’adresse pour laquelle l’activité de l’agent doit être définie.
SetAgentActivity.dwActivityID
Identificateur de l’activité sélectionnée.
GetAgentCaps
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTCAPS.
GetAgentCaps.dwAddressID
Identificateur de l’adresse pour laquelle les fonctionnalités de l’agent doivent être récupérées.
GetAgentCaps.AgentCaps
Structure de type LINEAGENTCAPS. Les décalages au sein de cette structure sont relatifs au début de GetAgentCaps.AgentCaps plutôt qu’au début de la structure LINEPROXYREQUEST . Le membre dwTotalSize est défini par TAPI et les octets restants sont définis sur zéro. Le gestionnaire de proxy doit renseigner dwNeededSize, dwUsedSize et les membres restants selon les besoins, avant d’appeler lineProxyResponse.
GetAgentStatus
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTGROUP.
GetAgentStatus.dwAddressID
Identificateur de l’adresse pour laquelle l’agent status doit être récupéré.
GetAgentStatus.AgentStatus
Structure de type LINEAGENTSTATUS. Les décalages au sein de cette structure sont relatifs au début de GetAgentStatus.AgentStatus plutôt qu’au début de la structure LINEPROXYREQUEST . Le membre dwTotalSize est défini par TAPI et les octets restants sont définis sur zéro. Le gestionnaire de proxy doit renseigner dwNeededSize, dwUsedSize et les membres restants selon les besoins, avant d’appeler lineProxyResponse.
AgentSpecific
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_AGENTSPECIFIC.
AgentSpecific.dwAddressID
Identificateur de l’adresse pour laquelle l’agent status doit être récupéré.
AgentSpecific.dwAgentExtensionIDIndex
Index de l’extension de gestionnaire en cours d’appel ; position de l’identificateur dans le tableau d’identificateurs d’extension retournés dans LINEAGENTCAPS.
AgentSpecific.dwSize
Taille totale, en octets, du bloc de paramètres Params .
AgentSpecific.Params[1]
Bloc de mémoire qui inclut le contenu passé au gestionnaire à partir de l’application. Si le gestionnaire doit retourner des données à l’application, elles doivent être écrites dans ce bloc de paramètres avant d’appeler lineProxyResponse.
GetAgentActivityList
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTACTIVITYLIST.
GetAgentActivityList.dwAddressID
Identificateur de l’adresse pour laquelle la liste d’activités de l’agent doit être récupérée.
GetAgentActivityList.ActivityList
Structure de type LINEAGENTACTIVITYLIST. Les décalages au sein de cette structure sont relatifs au début de GetAgentActivityList.ActivityList plutôt qu’au début de la structure LINEPROXYREQUEST . Le membre dwTotalSize est défini par TAPI et les octets restants sont définis sur zéro. Le gestionnaire de proxy doit renseigner dwNeededSize, dwUsedSize et les membres restants selon les besoins, avant d’appeler lineProxyResponse.
GetAgentGroupList
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTGROUPLIST.
GetAgentGroupList.dwAddressID
Identificateur de l’adresse pour laquelle la liste du groupe d’agents doit être récupérée.
GetAgentGroupList.GroupList
Structure de type LINEAGENTGROUPLIST. Les décalages au sein de cette structure sont relatifs au début de GetAgentGroupList.GroupList plutôt qu’au début de la structure LINEPROXYREQUEST . Le membre dwTotalSize est défini par TAPI et les octets restants sont définis sur zéro. Le gestionnaire de proxy doit renseigner dwNeededSize, dwUsedSize et les membres restants selon les besoins, avant d’appeler lineProxyResponse.
CreateAgent
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_CREATEAGENT.
CreateAgent.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
CreateAgent.dwAgentIDSize
Taille de la chaîne d’ID de l’agent, en octets.
CreateAgent.dwAgentIDOffset
Décalage du début de la structure vers une chaîne terminée par null qui spécifie l’ID de l’agent. La taille de la chaîne est spécifiée par dwAgentIDSize.
CreateAgent.dwAgentPINSize
Taille de la chaîne de code confidentiel, y compris la fin null , en octets.
CreateAgent.dwAgentPINOffset
Décalage du début de la structure vers une chaîne terminée par null qui spécifie le code pin ou le mot de passe de l’agent. La taille de la chaîne est spécifiée par dwAgentPINSize.
SetAgentStateEx
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTSTATEEX.
SetAgentStateEx.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
SetAgentStateEx.dwAgentState
Une des constantes LINEAGENTSTATEEX_.
SetAgentStateEx.dwNextAgentState
Une des constantes LINEAGENTSTATEEX_.
SetAgentMeasurementPeriod
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTMEASUREMENTPERIOD.
SetAgentMeasurementPeriod.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
SetAgentMeasurementPeriod.dwMeasurementPeriod
Période pendant laquelle le commutateur ou l’implémentation stocke et calcule les informations, en secondes. Par exemple, dwNumberOfACDCalls contient le nombre d’appels gérés par l’agent ; dwMeasurementPeriod indique si cette valeur a référencé les appels gérés au cours de la dernière heure, jour ou mois.
GetAgentInfo
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTINFO.
GetAgentInfo.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
GetAgentInfo.AgentInfo
Structure de type LINEAGENTINFO.
CreateAgentSession
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_CREATEAGENTSESSION.
CreateAgentSession.hAgentSession
Identificateur unique pour une session d’agent.
CreateAgentSession.dwAgentPINSize
Taille de la chaîne de code confidentiel de l’agent, y compris la fin null , en octets.
CreateAgentSession.dwAgentPINOffset
Décalage du début de la structure vers une chaîne terminée par null qui spécifie le code pin ou le mot de passe de l’agent. La taille de cette chaîne est spécifiée par dwAgentPINSize.
CreateAgentSession.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
CreateAgentSession.GroupID
Identificateur unique universel pour un groupe ACD. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
CreateAgentSession.dwWorkingAddressID
Identificateur de l’adresse à laquelle l’agent recevra des appels pour cette session.
GetAgentSessionList
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTSESSIONLIST.
GetAgentSessionList.hAgent
Identificateur unique pour un agent. Il incombe au gestionnaire de l’agent de générer et de maintenir l’unicité de cet identificateur.
GetAgentSessionList.SessionList
Structure de type LINEAGENTSESSIONLIST.
GetAgentSessionInfo
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETAGENTSESSIONINFO.
GetAgentSessionInfo.hAgentSession
Identificateur unique d’une session d’agent. Il incombe au gestionnaire d’agent de générer et de maintenir l’unicité de cet identificateur.
GetAgentSessionInfo.SessionInfo
Structure de type LINEAGENTSESSIONINFO.
SetAgentSessionState
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETAGENTSESSIONSTATE.
SetAgentSessionState.hAgentSession
Identificateur unique d’une session d’agent. Il incombe au gestionnaire d’agent de générer et de maintenir l’unicité de cet identificateur.
SetAgentSessionState.dwAgentSessionState
L’une des constantes LINEAGENTSESSIONSTATE_.
SetAgentSessionState.dwNextAgentSessionState
L’une des constantes LINEAGENTSESSIONSTATE_.
GetQueueList
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETQUEUELIST.
GetQueueList.GroupID
Identificateur universel unique pour un groupe ACD. Il incombe au gestionnaire d’agent de générer et de maintenir l’unicité de cet identificateur.
GetQueueList.QueueList
Structure de type LINEQUEUELIST.
SetQueueMeasurementPeriod
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_SETQUEUEMEASUREMENTPERIOD.
SetQueueMeasurementPeriod.dwQueueID
Identificateur unique d’une file d’attente. Il incombe au gestionnaire d’agent de générer et de maintenir l’unicité de cet identificateur.
SetQueueMeasurementPeriod.dwMeasurementPeriod
Période pendant laquelle le commutateur ou l’implémentation stocke et calcule les informations, en secondes.
GetQueueInfo
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETQUEUEINFO.
GetQueueInfo.dwQueueID
Identificateur unique d’une file d’attente. Il incombe au gestionnaire d’agent de générer et de maintenir l’unicité de cet identificateur.
GetQueueInfo.QueueInfo
Structure de type LINEQUEUEINFO.
GetGroupList
Composant Union utilisé lorsque dwRequestType est LINEPROXYREQUEST_GETGROUPLIST.
GetGroupList.GroupList
Structure de type LINEAGENTGROUPLIST.
Remarques
Un identificateur d’adresse est associé de manière permanente à une adresse ; l’identificateur reste constant entre les mises à niveau du système d’exploitation.
Configuration requise
| Condition requise | Valeur |
|---|---|
| En-tête | tapi.h |