Verwenden Sie das SDK, um die Genesys Cloud Platform API aufzurufen

Sendet eine HTTP-GET-Anfrage an einen Plattform-API-Endpunkt.

Parameter

Rückgabewert

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

Rückgabewert

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

Rückgabewert

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

Rückgabewert

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

Rückgabewert

Beispiel

HttpResponse response = purecloud.SDK.Rest.del('/api/v2/users/6a50987a-f00c-4b10-b627-4a677f9f0263/station/associatedstation', new Map<String, String>{'CustomHeaderValue' => 'Foo'});