Utilisez le SDK pour appeler l’API Genesys Cloud Platform

Remarque :  Cet article s’applique à Genesys Cloud for Salesforce.

Les fonctions et fonctionnalités décrites sur cette page seront bientôt disponibles. Pour plus d’informations, voir le notes de version.

Vous pouvez utiliser notre SDK dans le package géré pour appeler l’API Genesys Cloud Platform dans Salesforce. Le SDK Salesforce utilise le langage de programmation Apex. 

Remarque :  Cet article de personnalisation avancée est destiné aux développeurs familiarisés avec Salesforce.

Conditions préalables

Vous pouvez appeler n'importe quelle API de plate-forme qui n'est pas liée à un contexte utilisateur spécifique et que les autorisations de votre client OAuth autorisent. Le client OAuth est le client OAuth que vous avez créé pour les paramètres d'authentification dans Salesforce. Pour plus d’informations, voir Activation de la file d’attente.

Accédez à notre SDK via la classe Email sous le et purecloud.Email espaces de noms. Pour des exemples qui accèdent à notre SDK via la classe Rest, consultez Exemples de SDK Genesys Cloud for Salesforce ( GitHub ).

Classe de repos

Contient des méthodes qui agissent sur l’API Genesys Cloud Platform via Genesys Cloud for Salesforce. 

Espace de noms

purecloud.SDK.Rest

Utilisation

Utilisez ces méthodes pour GET, POST, PUT ou DELETE des données avec l’API Platform via Genesys Cloud for Salesforce.

Méthodes de repos

Les méthodes suivantes sont disponibles pour la classe Rest.

Envoie une requête HTTP GET à un point de terminaison d'API Platform.

Paramètres

Nom Type de données Obligatoire / facultatif Description
url Chaîne Requis Chemin pour une API de plate-forme, par exemple, /api/v2/users/{userId}.
En-têtes Carte<String, String=""> Facultatif Données personnalisées ajoutées aux en-têtes HTTP. 

Valeur renvoyée

Type de données Description
Obtenir une réponse Renvoie la réponse native Salesforce HttpResponse.

Exemple

L'exemple suivant renvoie des informations sur un utilisateur particulier et envoie un en-tête personnalisé avec le /api/v2/users/{userId} point final.

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

Envoie une requête HTTP PATCH à un point de terminaison d'API Platform.

Paramètres

Nom Type de données Obligatoire / facultatif Description
url Chaîne Requis Chemin pour une API de plate-forme, par exemple, /api/v2/utilisateurs/recherche.
Corps Chaîne Requis Objet JSON sérialisé.
En-têtes Carte<String, String=""> Facultatif Données personnalisées ajoutées aux en-têtes HTTP. 

Valeur renvoyée

Type de données Description
Obtenir une réponse Renvoie la réponse native Salesforce HttpResponse.

Exemple

L'exemple suivant modifie les attributs d'un participant au chat avec le /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes point final. Le corps de la requête est formaté comme { "les attributs": { « attrib1 » : « John Doe », « attrib2 » : "Fou" }}.

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'});

Envoie une requête HTTP POST à un point de terminaison d'API Platform.

Paramètres

Nom Type de données Obligatoire / facultatif Description
url Chaîne Requis Chemin pour une API de plate-forme, par exemple, /api/v2/utilisateurs/recherche.
Corps Chaîne Requis Objet JSON sérialisé.
En-têtes Carte<String, String=""> Facultatif Données personnalisées ajoutées aux en-têtes HTTP. 

Valeur renvoyée

Type de données Description
Obtenir une réponse Renvoie la réponse native Salesforce HttpResponse.

Exemple

L'exemple suivant recherche les utilisateurs par nom et envoie un en-tête personnalisé avec le /api/v2/utilisateurs/recherche point final. L'exemple utilise deux objets mappés pour générer une chaîne JSON. Le corps de la requête est formaté comme { "mettre en doute": [{ "des champs": [« nom »], « valeur » : « John Doe », « tapez » : « CONTIENT » }] } 

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'});

Envoie une requête HTTP PUT à un point de terminaison d'API Platform.

Paramètres

Nom Type de données Obligatoire / facultatif Description
url Chaîne Requis Chemin pour une API de plate-forme, par exemple, /api/v2/users/{userId}/callForwarding.
Corps Chaîne Requis Objet JSON sérialisé.
En-têtes Carte<String, String) Facultatif Données personnalisées ajoutées aux en-têtes HTTP. 

Valeur renvoyée

Type de données Description
Obtenir une réponse Renvoie la réponse native Salesforce HttpResponse.

Exemple

L'exemple suivant met à jour les paramètres de transfert d'appel pour un utilisateur particulier et envoie un en-tête personnalisé avec le /api/v2/users/{userId}/callForwarding point final. 

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'});

Envoie une requête HTTP DEL à un point de terminaison d'API Platform.

Paramètres

Nom Type de données Obligatoire / facultatif Description
url Chaîne Requis Chemin pour une API de plate-forme, par exemple, /api/v2/users/{userId}/station/associatedStation.
En-têtes Carte<String, String=""> Facultatif Données personnalisées ajoutées aux en-têtes HTTP. 

Valeur renvoyée

Type de données Description
Obtenir une réponse Renvoie la réponse native Salesforce HttpResponse.

Exemple

L'exemple suivant supprime l'association entre une station et un utilisateur et envoie un en-tête personnalisé avec le /api/v2/users/{userId}/station/associatedstation point final.

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

Pour plus d’informations, consultez SDK dans Genesys Cloud pour Salesforce.

Pour plus d’informations sur l’intégration, consultezÀ propos de Genesys Cloud for Salesforce.