Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

ACD Group Parameters can be triggered to send REST calls from the telephony server during call processing with agents.

Syntax

The syntax of the parameter name determines where in the call flow the REST call is made. 

The syntax of the parameter value determines the actual REST call made.

Parameter Name

The syntax is as follows:

CallTransfer.Client.<UseCase>.<Event>

<UseCase>

The following use cases are provided:

<UseCase>

Description

INBOUND.ACD.DIRECTA direct inbound call
INBOUND.ACD.BLENDEDA direct inbound call which has gone through call blending
OUTBOUND.CLICKTOCALLAn outbound call via the click to dial function in agent home
OUTBOUND.DIALLERAn outbound call made via the dialler
TRANSFER.AGENT

Call transfer to an agent

TRANSFER.GROUPCall transfer to an ACD-Group
TRANSFER.SYNONYMCall transfer to a synonym
TRANSFER.NUMBERCall transfer to a number
TRANSFER.NUMBER_ANNOUNCEMENTCall transfer to a number with a configured announcement

<Event>

The following events are provided which affect when the configured REST function is triggered:

<Event>

Description

InboundOutboundComments
RINGINGsent when the call is in the ringing statexxThis event is always sent FIRST.
CONNECTEDsent when the call is connectedxx
CONNRES.1sent when the call was successful and is endedxx
CONNRES.2sent when the call was not answeredxx
CONNRES.3send when the destination is busy 
x

Not provided for inbound calls, since RINGING is required first. 

CONNRES.4

sent when the caller (inbound) or agent (outbound) hungup during the call initiation or ringing phase

xx
CONNRES.5


Not provided as RINGING is required first.
CONNRES.6sent when the called agent refused the call or hungup during a whisper transfer announcementx

If a destination agent telephone rings then becomes busy, this means the agent refused the call. 

This CONNRES is used in that case.

CONNRES.7


Not provided since RINGING is required first. 

Examples

CallTransfer.Client.INBOUND.ACD.DIRECT.RINGING

CallTransfer.Client.INBOUND.ACD.DIRECT.CONNECTED

CallTransfer.Client.INBOUND.ACD.DIRECT.CONNRES.2

CallTransfer.Client.OUTBOUND.DIALLER.CONNECTED

Parameter Values

The value of the parameter determines how the REST call is made.

It is a multi-line parameter, each line must begin with one of the fields below followed by an equals ("=") sign.

The right hand part of the value determines the actual value used in the REST call.

The following lines are supported:

Value

Description

SpecifyExample
URL=<url>

Specifies the URL to be called. Should be specified in fully qualified form using http or https as the protocol.

A port can also be specified.

Once
URL=https://myrestserver.com:1234
METHOD=GET/POSTSpecifies the http method to useOnce
METHOD=GET
TIMEOUT=<ms>Specifies a timeout in ms before the function is aborted.Once
TIMEOUT=3000
HEADER=<http_header>Specifies an http header to be used. May be specified multiple times.Zero or more times 
HEADER=Bearer-Token: xxyyzz
QUERYPARAM=<param=value>Specifies a query parameter which will be added to the URL in URL encoded format,Zero or more times
QUERYPARAM=Agent=$agent_nickname
DATA=<value>Specifies POST data which will be sent with the request. If the POST data is in JSON format, add a backslash before the double qutoe quote character (\").Zero or one time
DATA=Agent=$agent_nickname

Variables

The following variables may be used in the parameter value:

Variable

Release

Description

$date_time
the current date and time
$service_number
the ServiceNumbers.Name field
$service_name
the ServiceNumbers.Name2 field
$caller
the caller ID
$agent_name
The surname of the agent
$agent_firstname
The firstname of the agent
$agent_number
The number of the agent
$agent_id 
The ID of the agent
$agent_tel 
The telephone number of the agent
$agent_uid
The UID of the agent
$agent_nickname
The NickName of the agent
$agent_email

Status
colourBlue
title3.31 and later

The email address of the agent
$group_name
The name of the ACD group
$group_number 
The number of the ACD group
$diallercampaign_name
The name of the dialler campaign
$diallercontact_name
The surname of the dialler contact
$diallercontact_firstname
The firstname of the dialler contact
$diallercontact_externalsystemlink
The external system link for the dialler contact
$diallercontact_userdata
The UserData field for the dialler contact
$statisticsparta_id
The ID of the call (in StatisticsPartA)
$call_duration

Status
colourBlue
title3.31 and later

The duration of the call in seconds. Note, this is only relevant for the event CONNRES.1

Examples

Direct Inbound RINGING

The following parameter will send a GET request when a direct inbound ACD call is ringing:

Direct Inbound Answer

This parameter will send a POST request when a direct inbound ACD call is not answered:



...

Sv translation
languagede

ACD-Gruppenparameter können verwendet werden, um während der Anrufbearbeitung mit Agenten REST-Calls vom Telefonieserver zu senden.

Syntax

Die Syntax des Parameternamens bestimmt, an welcher Stelle des Anrufablaufs der REST-Call erfolgt. 

Die Syntax des Parameterwerts bestimmt den tatsächlich durchgeführten REST-Call.

Parameter Name

Die Syntax ist wie folgt:

CallTransfer.Client.<UseCase>.<Event>

<UseCase>

Die folgenden Use Cases sind vorgesehen:

<UseCase>

Beschreibung

INBOUND.ACD.DIRECTEin direkter eingehender-Anruf
INBOUND.ACD.BLENDEDEin direkter eingehender Anruf, der durch Call-Blending gegangen ist.
OUTBOUND.CLICKTOCALLEin ausgehender Anruf über die Click-to-Dial-Funktion in Agent Home
OUTBOUND.DIALLEREin über den Dialer getätigter ausgehender Anruf
TRANSFER.AGENT

Anrufweiterleitung an einen Agenten

TRANSFER.GROUPAnrufweiterleitung an eine ACD-Gruppe
TRANSFER.SYNONYMAnrufweiterleitung an ein Synonym
TRANSFER.NUMBERAnrufweiterleitung an eine Nummer
TRANSFER.NUMBER_ANNOUNCEMENTAnrufweiterleitung an eine Nummer mit einer Konfigurierten Ansage

<Event>

Die folgenden Events sind bereitgestellt. Sie beeinflussen, wann die konfigurierte REST-Funktion ausgelöst wird:

<Event>

Beschreibung

EingehendAusgehendKommentar
RINGINGwird gesendet, wenn der Anruf klingelt.xxDieses Ereignis wird immer ZUERST gesendet.
CONNECTEDwird gesendet, wenn der Anruf verbunden ist.xx
CONNRES.1wird gesendet, wenn der Anruf erfolgreich war und beendet wurde.xx
CONNRES.2wird gesendet, wenn der Anruf nicht angenommen wurde.xx
CONNRES.3wird gesendet, wenn das Ziel besetzt ist. 
x

Für eingehende Anrufe nicht bereitgestellt, da zuerst RINGING erforderlich ist. 

CONNRES.4

wird gesendet, wenn der Anrufer (eingehend) oder der Agent (ausgehend) während der Einleitungs- oder Klingelphase des Anrufs aufgelegt hat

xx
CONNRES.5


Nicht bereitgestellt, da zuerst RINGING erforderlich ist. 
CONNRES.6gesendet, wenn der angerufene Agent den Anruf abgelehnt oder während einer Flüstertransferansage aufgelegt hatx

Wenn das Telefon eines Zielagenten klingelt und dann besetzt ist, bedeutet dies, dass der Agent den Anruf abgelehnt hat. 

Dieses CONNRES wird in diesem Fall verwendet.

CONNRES.7


Nicht bereitgestellt, da zuerst RINGING erforderlich ist. 

Beispiele

CallTransfer.Client.INBOUND.ACD.DIRECT.RINGING

CallTransfer.Client.INBOUND.ACD.DIRECT.CONNECTED

CallTransfer.Client.INBOUND.ACD.DIRECT.CONNRES.2

CallTransfer.Client.OUTBOUND.DIALLER.CONNECTED

Parameter Werte

Der Wert des Parameters bestimmt, wie der REST-Call durchgeführt wird.

Es ist ein mehrzeiliger Parameter, jede Zeile muss mit einer der unteren Feldern beginnen, gefolgt von einem Ist-Gleich("=") Zeichen

Der rechte Teil des Wertes bestimmt den tatsächlichen Wert, der im REST-Call verwendet wird.

Die folgenden Zeilen werden unterstützt:

Wert

Beschreibung

SpezifizierenBeispiel
URL=<url>

Spezifiziert die aufzurufende URL. Sie sollte in vollqualifizierter Form unter Verwendung von http oder https als Protokoll spezifiziert werden.

Es kann auch ein Port angegeben werden.

einmal
URL=https://myrestserver.com:1234
METHOD=GET/POSTSpezifiziert die http Methode die benutzt wird.einmal
METHOD=GET
TIMEOUT=<ms>Spezifiziert eine Zeitüberschreitung in ms, bevor die Funktion abgebrochen wird.einmal
TIMEOUT=3000
HEADER=<http_header>Spezifiziert einen zu verwendenden http-Header. Kann mehrfach angegeben werden.kein- oder mehrmals 
HEADER=Bearer-Token: xxyyzz
QUERYPARAM=<param=value>Spezifiziert einen Abfrageparameter, welcher der URL im URL-kodierten Format hinzugefügt wird,kein- oder mehrmals
QUERYPARAM=Agent=$agent_nickname
DATA=<value>Spezifiziert die POST-Daten, die mit der Anfrage gesendet werden. Wenn die POST-Daten im JSON-Format vorliegen, fügen Sie einen Backslash vor dem Doppel-Qutoe doppelten Anführungszeichen (\") hinzu.kein- oder einmal
DATA=Agent=$agent_nickname

Variablen

Die folgenden Variablen können im Parameterwert verwendet werden:

Variable

Release

Beschreibung

$date_time
Datum und Uhrzeit aktuell
$service_number
das ServiceNumbers.Name Feld
$service_name

das ServiceNumbers.Name2 Feld

$caller
die Anrufer ID
$agent_name
Der Nachname des Agenten
$agent_firstname
Der Vorname des Agenten
$agent_number
Die Nummer des Agenten
$agent_id 
Die ID des Agenten
$agent_tel 
Die Telefonnummer des Agenten
$agent_uid
Die UID des Agenten
$agent_nickname
Der NickName des Agenten
$agent_email

Status
colourBlue
titleab 3.31

Die E-Mail Adresse des Agenten
$group_name
Der Name der ACD-Gruppe
$group_number 
Die Nummer der ACD-Gruppe
$diallercampaign_name
Der Name der Dialer-Kampagane
$diallercontact_name
Der Nachname des Dialer-Kontaktes
$diallercontact_firstname
Der Vorname des Dialer-Kontaktes
$diallercontact_externalsystemlink
Der externe System-Link für den Dialer-Kontakt
$diallercontact_userdata
Das Benutzerdaten-Feld für den Dialer-Kontakt
$statisticsparta_id
Die ID des Anrufs (in StatisticsPartA)
$call_duration

Status
colourBlue
titleab 3.31

Die Dauer des Anrufs in Sekunden. Hinweis: Dies ist nur für das Ereignis CONNRES.1 relevant.

Beispiele

Direkt Eingehend RINGING

Der folgende Parameter sendet eine GET-Anfrage, wenn ein direkt eingehender ACD-Anruf klingelt:

Direkt Eingehend ANSWER

Dieser Parameter sendet eine POST-Anfrage, wenn ein direkt eingehender ACD-Anruf nicht beantwortet wird: