Versions Compared

Old Version 2

changes.mady.by.user jtel Support

Saved on

compared with

New Version 3

changes.mady.by.user jtel Support

Saved on

Key

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

This API is called when a click to dial is requested by agents using SalesForce.

The API can decide whether the call can proceed, and what calling party number should be used when the call is made.

For example, calling a customer might require that the hotline telephone number is transmitted, whilst calling a supplier might require that the extension number of the agent be used. 

To make use of this API, a REST endpoint must be provided in SalesForce for the jtel System to access. The following pages describe an example implementation.

Request

GET

Parameters

Data is passed to this API as parameters in the GET request.

The following parameters are provided:

Field NameDescription

SalesForceID

The Id of the record in SalesForce which should be called.

CallerID

The number to be called (the number clicked on in SalesForce, cleaned to remove unnecessary characters, punctuation and characters which cannot be dialled).
AgentUID

The UID of the agent currently logged into the jtel system.

It is recommended, that for example the "NickName" field in SalesForce be used to map values between the systems, if the login UID cannot be made equal.

http Status Codes

The following status codes should be used:

Status CodeMeaning

200 – OK

OK, dialling may proceed using the supplied information.

400 - Bad Request

Bad input parameter, for example SalesForce record not found.

403 – Forbidden

Call is not allowed. The jtel system will refuse to place the call if this code is returned.
404 - Not foundSales Force record not found. The jtel system will refuse to place the call if this code is returned.

Return Data

Data should be returned from this request in JSON format. The following fields should be supplied:

Field NameDescription

ServiceNumber

The service number to be used (jtel field ServiceNumbers.Name).
ServiceNumberNameThe name of the service number to be used (jtel field ServiceNumbers.Name2).

The jtel system will attempt a match on the ServiceNumber, then Name. The found ServiceNumber will be used for signalling the outbound call.

 

Sv translation
languagede

Diese API wird aufgerufen, wenn von Agenten, die SalesForce verwenden, ein Click-to-Dial angefordert wird.

Die API kann entscheiden, ob der Anruf fortgesetzt werden kann und welche Nummer der anrufenden Partei verwendet werden soll, wenn der Anruf getätigt wird.

Beispielsweise könnte ein Anruf bei einem Kunden erfordern, dass die Telefonnummer der Hotline übermittelt wird, während ein Anruf bei einem Lieferanten die Verwendung der Durchwahlnummer des Agenten erfordern könnte. 

Um diese API nutzen zu können, muss in SalesForce ein REST-Endpunkt bereitgestellt werden, auf den das jtel-System zugreifen kann. Auf den folgenden Seiten wird eine Beispielimplementierung beschrieben.

Anforderung

GET

Parameter

Daten werden als Parameter in der GET-Anforderung an diese API übergeben.

Die folgenden Parameter werden bereitgestellt:

Parameter NameBeschreibung

SalesForceID

Die Id des Datensatzes in SalesForce, der aufgerufen werden soll.

CallerID

Die anzurufende Nummer (die in SalesForce angeklickte Nummer, bereinigt, um unnötige Zeichen, Satzzeichen und Zeichen, die nicht gewählt werden können, zu entfernen).
AgentUID

Die UID des Agenten, der derzeit im Jtel-System angemeldet ist.

Es wird empfohlen, dass z.B. das "NickName"-Feld in SalesForce verwendet wird, um Werte zwischen den Systemen zuzuordnen, wenn die Anmelde-UID nicht gleichgesetzt werden kann.

http Status Codes

Die folgenden Statuscodes sollten verwendet werden:

Status CodeBedeutung

200 – OK

OK, die Wahl kann mit den angegebenen Informationen fortgesetzt werden.

400 - Bad Request

Schlechter Eingabeparameter, z.B. SalesForce-Datensatz nicht gefunden.

403 – Forbidden

Anruf ist nicht erlaubt. Das Jtel-System verweigert den Anruf, wenn dieser Code zurückgegeben wird

This API is called when a click to dial is requested by agents using SalesForce.

The API can decide whether the call can proceed, and what calling party number should be used when the call is made.

For example, calling a customer might require that the hotline telephone number is transmitted, whilst calling a supplier might require that the extension number of the agent be used. 

To make use of this API, a REST endpoint must be provided in SalesForce for the jtel System to access. The following pages describe an example implementation.

Request

GET

Parameters

Data is passed to this API as parameters in the GET request.

The following parameters are provided:

Field NameDescription

SalesForceID

The Id of the record in SalesForce which should be called.

CallerID

The number to be called (the number clicked on in SalesForce, cleaned to remove unnecessary characters, punctuation and characters which cannot be dialled).
AgentUID

The UID of the agent currently logged into the jtel system.

It is recommended, that for example the "NickName" field in SalesForce be used to map values between the systems, if the login UID cannot be made equal.

http Status Codes

The following status codes should be used:

Status CodeMeaning

200 – OK

OK, dialling may proceed using the supplied information.

400 - Bad Request

Bad input parameter, for example SalesForce record not found.

403 – Forbidden

Call is not allowed. The jtel system will refuse to place the call if this code is returned.
404 - Not foundSales Force record not found. The jtel system will refuse to place the call if this code is returned.

Return Data

Data should be returned from this request in JSON format. The following fields should be supplied:

Datensatz nicht gefunden. Das Jtel-System verweigert den Anruf, wenn dieser Code zurückgegeben wird.

Rückgabe Daten (Return Data)

Daten sollten von dieser Anfrage im JSON-Format zurückgegeben werden. Die folgenden Felder sollten angegeben werden:

Feld NameBeschreibung

Servicerufnummer

Die zu verwendende Servicenummer
Field NameDescription

ServiceNumber

The service number to be used (jtel field ServiceNumbers.Name).ServiceNumberName
Servicerufnummer NameDer Name der zu verwendenden Servicenummer (jtel feld The name of the service number to be used (jtel field ServiceNumbers.Name2).

The jtel system will attempt a match on the ServiceNumber, then Name. The found ServiceNumber will be used for signalling the outbound callDas Jtel-System versucht eine Übereinstimmung mit der ServiceNummer und dann mit dem Namen. Die gefundene ServiceNummer wird zur Signalisierung des ausgehenden Anrufs verwendet.