Versions Compared

Old Version 9

changes.mady.by.user jtel Support

Saved on

compared with

New Version 10

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 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

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 Der Name des aufgerufenen Dienstes (Jtel field ServiceNumbers.Name2).

http Status Codes

The following status codes should be usedDie folgenden Statuscodes sollten verwendet werden:

Status Code

MeaningBedeutung

200 – OK

One record was found and returnedEine Datensatz wurde gefunden und zurückgegeben.

300 – Multiple Choices

Multiple records were found. (No records should be returned in this caseEs wurden mehrere Datensätze gefunden. (In diesem Fall sollten keine Datensätze zurückgegeben werden).
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

Es 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 FeldnamenExamining the call log will show you the exact field names returned.