AgentList

This help page is for Desktop Studio. This information is also available for CXone Studio.

Retourneert alle agents die aan de bedrijfseenheid zijn toegewezen (behalve als een specifieke Agent-ID is ingevoerd in de eigenschappen) in een array met de profielgegevens van elke agent. De onderstaande velden worden geretourneerd in de variabele die is gespecificeerd in de parameter ListVar:

• BusinessUnitID • UserName
• MiddleName • Email
• TeamId • ReportToId
• ReportToMiddleName • IsSupervisor
• LastModified • Custom1
• Custom3 • Custom5
• AgentID • FirstName
• LastName • IsActive
• TeamName • ReportToFirstName
• ReportToLastName • LastLogin
• Location • Custom2
• Custom4 • InternalId

U kunt deze actie bijvoorbeeld gebruiken om te controleren of een bepaalde agent actief is, om het e-mailadres van de agent te vinden, om te kijken tot welk team de agent behoort en voor nog veel meer andere toepassingen. AgentList is een van de beschikbare API's die u kunt gebruiken binnen Studio. Framework-acties en machtigingen moeten voor uw bedrijfseenheid zijn ingeschakeld om deze actie te kunnen gebruiken.

Afhankelijkheden

Zorg er altijd voor dat de SetSecurityUser action voorafgaat aan deze actie en dat de uitvoervariabele van die actie overeenkomt met de invoervariabele SecurityUser van de eigenschappen van de Agent List-actie.

Ondersteunde scripttypen

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

Generiek

E-mail Chat Telefoon Voicemail Werkitem SMS

Invoereigenschappen

Deze eigenschappen definiëren gegevens die de actie gebruikt bij het uitvoeren.

Vertakking

Beschrijving

Caption

Voer een korte woordgroep in die deze actie in het script uniek identificeert. Het bijschrift verschijnt op het scriptcanvas onder het actiepictogram. The default is the action name.

SecurityUser De uitvoerwaarde van de SetSecurityUser-actie die een geselecteerde agent authenticeert op basis van diens machtigingen in het beveiligingsprofiel. Dit veld accepteer een variabele, opgemaakt met accolades ( { } ). De standaardwaarde is SecurityUser (zelfde standaard uitvoerwaarde van SetSecurityUser).
AgentID De agent-ID. U kunt een variabele gebruiken voor dit veld, zoals {agentId}. Als deze optie leeg wordt gelaten, worden alle gebruikers van de bedrijfseenheid geretourneerd in een array. Dit veld accepteert variabelen.

Uitvoereigenschappen

Deze eigenschappen bevatten variabelen die gegevens bevatten die worden geretourneerd na het uitvoeren van de actie. Ze zijn beschikbaar voor referentie en gebruik wanneer de actie wordt voltooid.

Vertakking

Beschrijving

ListVar (out) Bevat de geretourneerde data. De inhoud van deze variabele wordt opgeslagen in een array. De standaardvariabele is Agents.

Resultaatvertakkingsvoorwaarden

Met Resultaatvertakkingsvoorwaarden kunt u vertakkingen maken in uw script om verschillende resultaten te behandelen wanneer de actie wordt uitgevoerd.

Voorwaarde

Beschrijving

Default

Het pad dat altijd wordt gevolgd, behalve als het script voldoet aan een voorwaarde die vereist dat het een van de andere vertakkingen volgt. Dit pad wordt ook gevolgd als de andere vertakkingen van de actie niet zijn gedefinieerd.

OnError

Het pad dat wordt gevolgd als de actie niet correct is uitgevoerd. Als er bijvoorbeeld een onverwacht probleem is, zoals een slechte verbinding, syntaxfouten enz. De _ERR-variabele, met één onderstrepingsteken, moet een beknopte beschrijving van het probleem bevatten.

Andere opties

Afhankelijk van de gegevens die u wilt verkrijgen, kunnen aanvullende Framework API-acties nuttig zijn. Bijvoorbeeld, All Agent Skill Assignments, Agent States V4, Get Agents List, Get Agent Details by Agent ID, enz.