Verwenden Sie das SDK, um die Genesys Cloud Platform API aufzurufen
Sie können unser SDK im verwalteten Paket verwenden, um die Genesys Cloud Platform API in Salesforce aufzurufen. Das SDK verwendet die Programmiersprache Salesforce Apex.
Voraussetzungen
- Authentifizierung konfiguriert
Sie können jede Plattform-API aufrufen, die nicht an einen bestimmten Benutzerkontext gebunden ist und die die Berechtigungen in Ihrem OAuth-Client zulassen. Der OAuth-Client ist der OAuth-Client, den Sie für die Authentifizierungseinstellungen in Salesforce erstellt haben. Weitere Informationen finden Sie unter Authentifizierung.
Greifen Sie auf unser SDK über die Rest-Klasse im Namespace purecloud.SDK.Rest zu Beispiele für den Zugriff auf unser SDK über die Rest-Klasse finden Sie unter Genesys Cloud for Salesforce SDK Examples (GitHub)
Rest Klasse
Enthält Methoden, die auf die Genesys Cloud Platform API durch Genesys Cloud für Salesforce wirken.
Namespace
purecloud.SDK.Rest
Verwendung
Verwenden Sie diese Methoden zum GET, PATCH, POST, PUT oder DELETE von Daten mit der Platform API über Genesys Cloud for Salesforce.
Sonstige Methoden
Die folgenden Methoden sind für die Klasse Rest verfügbar.
Sendet eine HTTP-GET-Anfrage an einen Plattform-API-Endpunkt.
Parameter
Name | Datentyp | Erforderlich oder optional | Beschreibung |
---|---|---|---|
url | Zeichenkette | Erforderlich | Pfad für eine Plattform-API, z. B. /api/v2/users/{userId}. |
Kopfzeilen | Karte<String, String=""> | Optional | Benutzerdefinierte Daten zu HTTP-Headern hinzugefügt. |
Rückgabewert
Datentyp | Beschreibung |
---|---|
Antwort abrufen | Gibt native Salesforce HttpResponse zurück. |
Beispiel
Das folgende Beispiel gibt Informationen über einen bestimmten Benutzer zurück und sendet eine benutzerdefinierte Kopfzeile mit dem Endpunkt /api/v2/users/{userId}
HttpResponse response = purecloud.SDK.Rest.get('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263', new Map<String, String>{'CustomHeaderValue' => 'Foo'});
Sendet eine HTTP-PATCH-Anfrage an einen Plattform-API-Endpunkt.
Parameter
Name | Datentyp | Erforderlich oder optional | Beschreibung |
---|---|---|---|
url | Zeichenkette | Erforderlich | Pfad für eine Plattform-API, z. B. /api/v2/users/search. |
Textkörper | Zeichenkette | Erforderlich | Serialisiertes JSON-Objekt. |
Kopfzeilen | Karte<String, String=""> | Optional | Benutzerdefinierte Daten zu HTTP-Headern hinzugefügt. |
Rückgabewert
Datentyp | Beschreibung |
---|---|
Antwort abrufen | Gibt native Salesforce HttpResponse zurück. |
Beispiel
Im folgenden Beispiel werden die Attribute eines Chatteilnehmers mit dem Endpunkt /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes geändert Der Anfragekörper ist wie folgt formatiert { "attributes": { "attrib1": "John Doe", "attrib2": "Foo" }}.
Map<String,Object> attributes = new Map<String,Object> {
'attrib1' => 'John Doe',
'attrib2' => 'Foo'
};
Map<String,Object> body = new Map<String,Object> {
'attributes' => attributes
};
HttpResponse response = purecloud.SDK.Rest.patch('/api/v2/conversations/chats/42a09688-c7e2-4d49-b9b8-8667d321a6f7/participants/5ad38568-9b97-4db6-850b-48b750566b06/attributes', JSON.serialize(body), new Map<String, String>{'CustomHeaderValue' => 'Foo'});
Sendet eine HTTP-POST-Anfrage an einen Plattform-API-Endpunkt.
Parameter
Name | Datentyp | Erforderlich oder optional | Beschreibung |
---|---|---|---|
url | Zeichenkette | Erforderlich | Pfad für eine Plattform-API, z. B. /api/v2/users/search. |
Textkörper | Zeichenkette | Erforderlich | Serialisiertes JSON-Objekt. |
Kopfzeilen | Karte<String, String=""> | Optional | Benutzerdefinierte Daten zu HTTP-Headern hinzugefügt. |
Rückgabewert
Datentyp | Beschreibung |
---|---|
Antwort abrufen | Gibt native Salesforce HttpResponse zurück. |
Beispiel
Das folgende Beispiel sucht Benutzer nach Namen und sendet eine benutzerdefinierte Kopfzeile mit dem Endpunkt /api/v2/users/search Das Beispiel verwendet zwei gemappte Objekte, um eine JSON-Zeichenfolge zu erzeugen. Der Text der Anfrage ist wie folgt formatiert { "query": [{ "Felder": ["Name"], "Wert": "John Doe", "Typ": "ENTHÄLT" }] }
Map<String,Object>query=new Map<String,Object>{
'fields'=newList<String>{'name'},
'value'=>'John Doe',
'type' =>'CONTAINS'
};
Map<String,Object>body=newMap<String,Object>{
'query' => new List<Object>{ query }
};
HttpResponse response = purecloud.SDK.Rest.post('/api/v2/users/search', JSON.serialize(body), new Map<String, String>{'CustomHeaderValue' => 'Foo'});
Sendet eine HTTP PUT Anfrage an einen Platform API Endpunkt.
Parameter
Name | Datentyp | Erforderlich oder optional | Beschreibung |
---|---|---|---|
url | Zeichenkette | Erforderlich | Pfad für eine Plattform-API, z. B. /api/v2/users/{userId}/callForwarding. |
Textkörper | Zeichenkette | Erforderlich | Serialisiertes JSON-Objekt. |
Kopfzeilen | Karte<String, String) | Optional | Benutzerdefinierte Daten zu HTTP-Headern hinzugefügt. |
Rückgabewert
Datentyp | Beschreibung |
---|---|
Antwort abrufen | Gibt native Salesforce HttpResponse zurück. |
Beispiel
Im folgenden Beispiel werden die Einstellungen für die Anrufweiterleitung für einen bestimmten Benutzer aktualisiert und eine benutzerdefinierte Kopfzeile mit dem Endpunkt /api/v2/users/{userId}/callForwarding gesendet
String body = '{ "enabled": true, "phoneNumber": "+13175550123" }';
HttpResponse response = purecloud.SDK.Rest.put('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263/callForwarding', body, new Map<String, String>{'CustomHeaderValue' => 'Foo'});
Sendet eine HTTP-DEL-Anfrage an einen Plattform-API-Endpunkt.
Parameter
Name | Datentyp | Erforderlich oder optional | Beschreibung |
---|---|---|---|
url | Zeichenkette | Erforderlich | Pfad für eine Plattform-API, z. B. /api/v2/users/{userId}/station/associatedStation. |
Kopfzeilen | Karte<String, String=""> | Optional | Benutzerdefinierte Daten zu HTTP-Headern hinzugefügt. |
Rückgabewert
Datentyp | Beschreibung |
---|---|
Antwort abrufen | Gibt native Salesforce HttpResponse zurück. |
Beispiel
Das folgende Beispiel löscht die Zuordnung zwischen einer Station und einem Benutzer und sendet eine benutzerdefinierte Kopfzeile mit dem Endpunkt /api/v2/users/{userId}/station/associatedstation
HttpResponse response = purecloud.SDK.Rest.del('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263/station/associatedstation', new Map<String, String>{'CustomHeaderValue' => 'Foo'});
Weitere Informationen finden Sie unter SDK in Genesys Cloud für Salesforce.
Weitere Informationen über die Integration finden Sie unter Über Genesys Cloud für Salesforce.