Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.
Sv translation
languageen

This API works in tandem with an IVR object in the jtel system, which can be used to search for records in SalesForce when calls are received.

The results of the search performed are available as variables, and can be used to influence the routing in the jtel system, for example to route to a particular agent, or to a particular ACD group.

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

The following parameters are provided in the REST request:

Parameter NameDescription
CallerIDThe number of the caller in E.164 (fully qualified without +) format.
ServiceNumberThe service number called (jtel field ServiceNumbers.Name).
ServiceNameThe service name called (jtel field ServiceNumbers.Name2).

http Status Codes

The following status codes should be used:

Status Code
Meaning

200 – OK

One record was found and returned.

300 – Multiple Choices

Multiple records were found. (No records should be returned in this case).
404 – Not foundNo record was found.

Return Structure

The return structure must be JSON, but otherwise any fields and any content can be returned. The jtel System will parse the data into variables for the jtel IVR GUI, of the form $SalesForce.FieldName

If structures are nested, then the variable will be named accordingly: $SalesForce.Entity.FieldName

Examining the call log will show you the exact field names returned.

Sv translation
languagede

Diese API arbeitet mit einem IVR-Objekt im Jtel-System zusammen, das bei eingehenden Anrufen zur Suche nach Datensätzen in SalesForce verwendet werden kann.

Die Ergebnisse der durchgeführten Suche stehen als Variablen zur Verfügung und können verwendet werden, um das Routing im Jtel-System zu beeinflussen, z.B. um zu einem bestimmten Agenten oder zu einer bestimmten ACD-Gruppe zu routen.

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

Die folgenden Parameter werden in der REST-Anforderung bereitgestellt:

Parameter NameBeschreibung
CallerIDDie Nummer des Anrufers im Format E.164 (voll qualifiziert ohne +).
ServiceNumberDie angerufene Servicenummer (jtel-Feld ServiceNumbers.Name).
ServiceNameDer Name des aufgerufenen Dienstes (Jtel field ServiceNumbers.Name2).

http Status Codes

Die folgenden Statuscodes sollten verwendet werden:

Status Code

Bedeutung

200 – OK

Eine Datensatz wurde gefunden und zurückgegeben.

300 – Multiple Choices

Es wurden mehrere Datensätze gefunden. (In diesem Fall sollten keine Datensätze zurückgegeben werden).
404 – Not foundEs wurde kein Datensatz gefunden.

Rückgabe-Struktur (return structure)

Die Rückgabestruktur muss JSON sein, aber ansonsten können beliebige Felder und Inhalte zurückgegeben werden. Das jtel-System wird die Daten in Variablen für die jtel IVR-GUI parsen, in der Form $SalesForce.FieldName

Wenn Strukturen verschachtelt sind, dann wird die Variable entsprechend benannt: $SalesForce.Entity.FieldName

Die Einsicht in das Anrufprotokoll zeigt Ihnen die genauen zurückgegebenen Feldnamen.

Sv translation
languagefr

Cette API fonctionne en tandem avec un objet IVR dans le système jtel, qui peut être utilisé pour rechercher des enregistrements dans SalesForce lorsque des appels sont reçus.

Les résultats de la recherche effectuée sont disponibles sous forme de variables, et peuvent être utilisés pour influencer le routage dans le système jtel, par exemple pour router vers un agent particulier, ou vers un groupe ACD particulier.

Pour utiliser cette API, un terminal REST doit être fourni dans SalesForce pour que le système jtel puisse y accéder. Les pages suivantes décrivent un exemple de mise en œuvre.

Demande

GET

Paramètres

Les paramètres suivants sont fournis dans la requête REST:

Nom du paramètreDescription
CallerIDLe numéro de l'appelant au format E.164 (entièrement qualifié sans +).
ServiceNumberLe numéro de service appelé (champ jtel ServiceNumbers.Name).
ServiceNameLe nom du service appelé (champ jtel ServiceNumbers.Name2).

Codes de statut http

Les codes de statut suivants doivent être utilisés:

Statut Code
Signification

200 – OK

Un enregistrement a été trouvé et retourné.

300 - Choix multiples

De nombreux documents ont été trouvés. (Aucun dossier ne doit être retourné dans ce cas).
404 - Not foundAucun enregistrement n'a été trouvé.

Structure de retour

La structure de retour doit être JSON, mais sinon tous les champs et tout le contenu peuvent être retournés. Le système jtel analysera les données en variables pour l'interface graphique IVR de jtel, de la forme $SalesForce.FieldName

Si les structures sont imbriquées, la variable sera nommée en conséquence: $SalesForce.Entity.FieldName

L'examen du journal des appels vous indiquera les noms exacts des champs retournés.