API du centre client
L’API Centre client fournit des points de terminaison pour accéder aux informations des clients et aux détails de configuration.
Utilisez cette API pour obtenir des enregistrements d’informations (cartes) qui étaient précédemment générés via l’interface Centre client.
Vous devez disposer du rôle administrateur ou sn_esm_agent pour accéder à cette API. En outre, avant que cette API ne soit disponible dans votre instance, vous devez activer le module d’extension com.sn_csm_customer_central .
Pour plus d’informations, consultez Centre client.
Centre client : GET /cust_central/custinfo/{context}/{context_instance}/{target}
Renvoie des informations sur le client et des détails de configuration pour un contexte client spécifique.
Le contexte client est déterminé par la table de contenu client que vous spécifiez, soit la table Consommateur [csm_consumer] ou Contact [customer_contact], et sa table cible associée. Ces informations se trouvent dans la table Contexte des informations client [sn_customercentral_cust_info_config].
Ce point de terminaison renvoie tous les enregistrements actifs (cartes) dans les tables de configuration du centre client suivantes pour le contexte client spécifié :
- Configuration de la liste [sn_customercentral_list_config]
- Configuration d’enregistrement [sn_customercentral_record_config]
- Configuration du rapport [sn_customercentral_report_config]
- Configuration du groupe du rapport [sn_customercentral_report_group_config]
Vous devez définir tous les enregistrements de configuration supplémentaires dont vous avez besoin via l’interface du Centre client. Pour plus d’informations, voir Configurer le centre client.
Format d'URL
URL versionnée : /api/sn_customercentral/{api_version}/cust_central/custinfo/{context}/{context_instance}/{target}
URL par défaut : /api/sn_customercentral/cust_central/custinfo/{context}/{context_instance}/{target}
Remarque :
Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| contexte | Nom de la table de contexte client à utiliser. Valeurs valides :
Type de données : chaîne |
| context_instance | Sys_id de l’enregistrement dans la table spécifiée dans le context paramètre à renvoyer. Type de données : chaîne |
| target | Table cible associée à la table de contexte client spécifiée dans le context paramètre. La combinaison du paramètre et target du context paramètre définit un contexte d’information client unique. Type de données : chaîne Table : Contexte des informations client [sn_customercentral_cust_info_config] |
| Nom | Description |
|---|---|
| avant | Renvoyer tous les enregistrements de configuration créés avant la date et l’heure spécifiées. Type de date : chaîne Format : JJ-MM-AAAA ou format défini dans la glide.sys.date_format propriété système Par défaut : renvoie tous les enregistrements de configuration créés avant l’heure de la session actuelle. |
| fin | Dernier enregistrement à renvoyer. Utilisez cette valeur pour paginer la récupération d’enregistrements ou utilisez-la avec le start paramètre pour sélectionner un ensemble spécifique d’enregistrements à renvoyer. Type de données : nombre Par défaut : dernier enregistrement dans le fichier |
| début | Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Ne transmettez pas de nombre négatif. Type de données : nombre Par défaut : 0 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Assurez-vous que les paramètres du chemin d’accès contiennent des valeurs valides. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| cards_info | Liste des cartes de contact associées au client spécifié. Type de données : tableau (le contenu dépend du client sélectionné) |
| cards_info.configurations_données | Informations sur la configuration. Type de données : objet |
| cards_info.data_configurations.aggregate_field | Nom de colonne à regrouper. Type de données : chaîne |
| cards_info.data_configurations.aggregate_function | Fonction à utiliser pour regrouper la colonne de table spécifiée. Valeurs possibles :
Type de données : chaîne |
| cards_info.configurations_données.decimal_precision | Nombre de chiffres à droite de la virgule décimale à renvoyer. Type de données : nombre |
| cards_info.configurations_données.requête_filtre | Chaîne de requête à utiliser pour affiner les données utilisées dans le rapport. Type de données : chaîne |
| cards_info.configurations_données.groupe_by | Nom de la colonne à utiliser pour regrouper les données du rapport. Type de données : chaîne |
| cards_info.configurations_de_données.nombre_de_groupes | Nombre maximal de groupes à afficher dans le rapport. Valeurs possibles :
Type de données : chaîne |
| cards_info.configurations_données.afficher_autre | Marqueur indiquant si le groupe « Autre » apparaît dans le rapport. Si tous les groupes ne doivent pas s’afficher, comme défini par le number_of_groups paramètre, les valeurs des groupes non affichés sont combinées et affichées sous une seule rubrique « Autre ». Valeurs possibles :
Type de données : booléennes |
| cards_info.data_configurations.source_id | Nom de table ou sys_id des informations sur la source du rapport. Ceci est en corrélation avec les informations du cards_info.reportGroupConfigurations.data_configurations.source_type paramètre. Type de données : chaîne |
| cards_info.configurations_données.type_source | Type d’informations dans le cards_info.reportGroupConfigurations.data_configurations.source_id paramètre utilisé pour identifier la table source. Valeurs possibles :
Type de données : chaîne |
| cards_info.configurations_données.pile_par_champ | Nom de la colonne de table à utiliser lors de l’implémentation de « empiler par » dans le rapport. Type de données : chaîne |
| cards_info.data_configurations.sys_id | Sys_id du rapport utilisé dans la configuration du rapport. Type de données : chaîne |
| cards_info.configurations_données.champ_tendance | Nom de la colonne de table à utiliser dans l’analyse des tendances. Type de données : chaîne |
| cards_info.data_configurations.trend_interval | Intervalle de temps pour les informations de tendance. Par exemple, semaine, mois, année, etc. Type de données : chaîne |
| cards_info.configurations_données.type | Type de rapport, par exemple score unique, anneau, vertical, ligne, barre empilée... Type de données : chaîne |
| cards_info.encodedQuery | Chaîne de requête codée à utiliser pour affiner les données qui apparaissent dans le rapport. Type de données : chaîne |
| cards_info.champs | Liste des paires nom-valeur qui définissent les champs dans l’enregistrement associé. Type de données : tableau d’objets |
| cards_info.fields.label | Étiquette de champ. Type de données : chaîne |
| cards_info.fields.value | Valeur du champ. Type de données : chaîne |
| cards_info.listLimit | Limite de pagination. Nombre d’enregistrements à afficher sur une carte de liste. Type de données : chaîne |
| cards_info.reportGroupConfigurations | Liste des objets qui définissent les groupes de rapports. Type de données : tableau d’objets |
| cards_info.reportGroupConfigurations.data_configurations | Informations sur la configuration. Type de données : objet |
| cards_info.reportGroupConfigurations.data_configurations.aggregate_field | Nom de colonne à regrouper. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.aggregate_function | Fonction à utiliser pour regrouper la colonne de table spécifiée. Valeurs possibles :
Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.decimal_precision | Nombre de chiffres à droite de la virgule décimale à renvoyer. Type de données : nombre |
| cards_info.reportGroupConfigurations.data_configurations.filter_query | Chaîne de requête à utiliser pour affiner les données utilisées dans le rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.group_by | Nom de la colonne à utiliser pour regrouper les données du rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.number_of_groups | Nombre maximal de groupes à afficher dans le rapport. Valeurs possibles :
Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.show_other | Marqueur indiquant si le groupe « Autre » apparaît dans le rapport. Si tous les groupes ne doivent pas s’afficher, comme défini par le number_of_groups paramètre, les valeurs des groupes non affichés sont combinées et affichées sous une seule rubrique « Autre ». Valeurs possibles :
Type de données : booléennes |
| cards_info.reportGroupConfigurations.data_configurations.source_id | Nom de table ou sys_id des informations sur la source du rapport. Ceci est en corrélation avec les informations du cards_info.reportGroupConfigurations.data_configurations.source_type paramètre. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.source_type | Type d’informations dans le cards_info.reportGroupConfigurations.data_configurations.source_id paramètre utilisé pour identifier la table source. Valeurs possibles :
Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.stack_by_field | Nom de la colonne de table à utiliser lors de l’implémentation de « empiler par » dans le rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.sys_id | Sys_id du rapport utilisé dans la configuration du rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.trend_field | Nom de la colonne de table à utiliser dans l’analyse des tendances. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.trend_interval | Intervalle de temps pour les informations de tendance. Par exemple, semaine, mois, année, etc. Type de données : chaîne |
| cards_info.reportGroupConfigurations.data_configurations.type | Type de rapport associé au groupe de rapports, tel qu’anneau ou single_core. Type de données : chaîne |
| cards_info.reportGroupConfigurations.style_configurations | Styles à utiliser dans le groupe de rapports associé. Type de données : objet |
| cards_info.reportGroupConfigurations.style_configurations.colorPalette | Couleurs utilisées dans le rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.style_configurations.scoreColor | Couleur de la valeur du score dans le rapport. Type de données : chaîne |
| cards_info.reportGroupConfigurations.style_configurations.show_zero | Marqueur indiquant si des points de données égaux à zéro sont affichés dans le rapport. Valeurs possibles :
Type de données : booléennes |
| cards_info.reportGroupConfigurations.title | Titre du groupe de rapports. Type de données : chaîne |
| cards_info.reportGroupConfigurations.type | Type de fichier pour lequel les informations sont renvoyées. Toujours sn_customercentral_report_config. Type de données : chaîne |
| cards_info.nom_tablesource | Nom de la table utilisée pour la carte de liste associée. Type de données : chaîne |
| cards_info.configuration_de_style | Styles à utiliser dans le rapport associé. Type de données : objet |
| cards_info.style_configurations.colorPalette | Couleurs utilisées dans le rapport. Type de données : chaîne |
| cards_info.configurations_style.dataLabelConfig | Paramètres de configuration qui contrôlent la façon dont les étiquettes de données apparaissent dans le rapport. Type de données : objet |
| cards_info.styles_configurations.dataLabelConfig.showTotal | Marqueur indiquant s’il faut afficher le total dans le rapport. Valeurs possibles :
Type de données : booléennes |
| cards_info.configurations_style.height | Hauteur du rapport associé. Type de données : chaîne Unité : Pixels ou « auto » |
| cards_info.style_configurations.hideRegister | Marqueur indiquant s’il faut afficher ou non la caisse sur la carte. Valeurs possibles :
Type de données : booléennes |
| cards_info.style_configurations.registerConfig | Valeurs de configuration qui contrôlent la façon dont le registre apparaît dans le rapport. Type de données : objet |
| cards_info.style_configurations.registerConfig.hideBorder | Marqueur indiquant s’il faut masquer la bordure autour du registre. Valeurs possibles :
Type de données : booléennes |
| cards_info.style_configurations.registerConfig.showPercentages | Marqueur indiquant s’il faut afficher ou non les pourcentages de registre. Valeurs possibles :
Type de données : booléennes |
| cards_info.configurations_style.registerPosition | Position du registre dans une carte. Type de données : chaîne |
| cards_info.style_configurations.scoreColor | Couleur de la valeur du score dans le rapport. Type de données : chaîne |
| cards_info.configurations_style.showDataLabels | Marqueur indiquant s’il faut afficher les étiquettes de données dans le rapport. Valeurs possibles :
Type de données : booléennes |
| cards_info.style_configurations.showTooltip | Marqueur indiquant s’il faut afficher des info-bulles dans le rapport. Valeurs possibles :
Type de données : booléennes |
| cards_info.configurations_style.show_zero | Marqueur indiquant si des points de données égaux à zéro sont affichés dans le rapport. Valeurs possibles :
Type de données : booléennes |
| cards_info.configurations_style.width | Largeur du rapport associé. Type de données : chaîne Unité : Pixels ou « auto » |
| cards_info.subheader_fields | Détails à afficher dans le sous-en-tête de la carte associée. Type de données : objet |
| cards_info.subheader_fields.avatar | Nom de fichier de l’avatar associé à l’élément spécifié context_instance, tel que l’avatar du contact. Type de données : chaîne |
| cards_info.subheader_fields.subheader_tags | Liste des balises associées au sous-en-tête de l’enregistrement, telles que les balises d’escalade. Type de données : tableau (le contenu varie) |
| cards_info.subheader_fields.sys_id | Sys_id du client associé. Type de données : chaîne Table : Utilisateurs [sys_user] |
| cards_info.subheader_fields.title | Titre à afficher dans le sous-en-tête. Type de données : chaîne |
| cards_info.title | Titre sur la carte (enregistrement). Type de données : chaîne |
| cards_info.type | Type de fichier pour lequel les informations sont renvoyées. Valeurs possibles :
Type de données : chaîne |
| cards_info.viewName | Nom de la vue configurée pour la table spécifiée dans cards_info.sourceTableName. Type de données : chaîne |
| has_more_records | Marqueur indiquant s’il existe d’autres enregistrements à récupérer. Valeurs possibles :
Type de données : booléennes |
| disposition | Nombre de colonnes par ligne. Chaque valeur séparée par des virgules définit la largeur d’une colonne sur l’affichage du rapport. Par exemple, « 6,6 » désigne deux colonnes, chacune ayant une largeur de six unités, pour un total de 12 unités par ligne (maximum). Une valeur de « 3,6,3 » désigne une ligne avec trois colonnes. Type de données : chaîne |
| statut | État HTTP de la demande. Type de données : chaîne |
Demande cURL
curl "https://instance.servicenow/api/sn_customercentral/cust_central/custinfo/csm_consumer/a0488cfbdb1b1200b6075200cf9619db/interaction" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"{
"result": {
"layout": "6,6",
"cards_info": [
{
"title": "Consumer",
"type": "sn_customercentral_record_config",
"subheader_fields": {
"title": "Sam Collins",
"subheader_tags": [],
"avatar": "",
"sys_id": "64488cfbdb1b1200b6075200cf9619db"
},
"fields": [
{
"label": "Mobile phone",
"value": ""
},
{
"label": "Business phone",
"value": ""
},
{
"label": "Email",
"value": "sam.collins@mailinator.com"
},
{
"label": "Street",
"value": "144 2nd St"
},
{
"label": "City",
"value": "San Francisco"
},
{
"label": "State / Province",
"value": "CA"
}
]
},
{
"title": "High priority cases",
"type": "sn_customercentral_report_group_config",
"reportGroupConfigurations": [
{
"title": "Escalated",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "active=true^active_escalationISNOTEMPTY^EQ^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "c169a0f50f3b0010e6d4fd820b767e2e"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
},
{
"title": "P1",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "active=true^priority=1^EQ^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "cce86cb50f3b0010e6d4fd820b767eba"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
},
{
"title": "SLA breached",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "single_score",
"source_type": "table",
"source_id": "task_sla",
"group_by": "",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "task.active=true^task.sys_class_name=sn_customerservice_case^stage!=cancelled^task.closed_atISEMPTY^sla.type=SLA^has_breached=true^EQ^taskIN59b65dc4db952200d75270f5bf96193eccc8cf82db912200d75270f5bf9619de^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "e739a0f50f3b0010e6d4fd820b767e22"
},
"style_configurations": {
"scoreColor": "#000000",
"show_zero": true
}
}
]
},
{
"title": "Case overview",
"type": "sn_customercentral_report_config",
"data_configurations": {
"type": "donut",
"source_type": "table",
"source_id": "sn_customerservice_case",
"group_by": "state",
"trend_interval": "year",
"trend_field": "",
"stack_by_field": "",
"aggregate_function": "COUNT",
"aggregate_field": "",
"filter_query": "^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"decimal_precision": 2,
"number_of_groups": 0,
"show_other": true,
"sys_id": "d169216c0f770010e6d4fd820b767ea8"
},
"style_configurations": {
"width": "auto",
"height": "auto",
"colorPalette": [
"#278ecf",
"#4bd762",
"#ffca1f",
"#ff9416",
"#d42ae8"
],
"hideRegister": false,
"registerConfig": {
"hideBorder": true,
"showPercentages": false
},
"registerPosition": "right",
"showDataLabels": false,
"dataLabelConfig": {
"showTotal": false
},
"showTooltip": true
}
},
{
"title": "Recent cases",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "sn_customerservice_case"
},
{
"title": "Recent chat interactions",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=false^type=chat^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "interaction"
},
{
"title": "Recent phone calls",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=false^type=phone^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "interaction"
},
{
"title": "Recent viewed articles",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "user=64488cfbdb1b1200b6075200cf9619db^viewed=true^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "kb_use"
},
{
"title": "Contracts",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^state=Active^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "ast_contract"
},
{
"title": "Entitlements",
"type": "sn_customercentral_list_config",
"listLimit": "3",
"viewName": "customer_central",
"encodedQuery": "active=true^end_date=NULL^ORend_date>=2020-05-07 07:00:00^consumer=a0488cfbdb1b1200b6075200cf9619db^ORDERBYDESCsys_created_on^sys_created_on>=2020-04-07 13:40:48",
"sourceTableName": "service_entitlement"
}
],
"has_more_records": false,
"status": "200"
}
}