API du récapitulatif
Fournit des points de terminaison pour la gestion de la fonctionnalité de récapitulatif pour les systèmes ou les espaces de travail CCaaS (Contact Center as a Service) externes ServiceNow AI Platform .
Cette API nécessite le module d’extension Gestion des interactions (com.glide.interaction.awa). Pour appeler cette API, vous devez disposer du rôle interaction_integration_user.
Lorsque les agents ferment une interaction, la fonctionnalité de récapitulatif leur permet de saisir les détails de clôture et les codes de récapitulatif pour référence ultérieure. Pour plus d’informations sur la fonctionnalité de récapitulatif, reportez-vous à la section Wrap up overview.
Pour utiliser cette API pour un récapitulatif segmenté des interactions à partir de systèmes externes, vous devez implémenter le point d’extension scripté InteractionSegment pour créer et récupérer les enregistrements de segments dans la table choisie. Si vous utilisez OpenFrame, le point d’extension dispose d’une implémentation existante pour créer et récupérer des enregistrements de segments dans la table Journal téléphonique [sn_openframe_phone_log].
- Recommandations de conclusion IA
-
Les recommandations de conclusion IA peuvent provenir de deux sources :
- Interne ()Now Assist : lorsque use_third_party_ai la valeur est faux, une règle métier se déclenche automatiquement après la création du segment pour appeler l’API CSM et renseigner ai_wrap_up_code et ai_notes.
- Externe (tiers/CCaaS) : lorsque use_third_party_ai la valeur est vrai, le système externe envoie les données d’IA via le nouveau point de terminaison PUT /api/now/wrapup/segment/update/ai .
- Cas d'utilisation
-
- Réduisez le temps de traitement de l’agent en fournissant des codes de récapitulatif et des notes avec des suggestions de l’IA.
- Permettez aux plateformes CCaaS d’intégrer du contenu ServiceNow AI Platform généré par l’IA après la fin d’une interaction.
- Fournissez aux superviseurs des données de récapitulatif plus propres et plus cohérentes pour les rapports et les analyses.
- Ordre d’appel de point de terminaison pour un flux de récapitulatif assisté par l’IA
-
- POST /api/now/wrapup/segment/create : ouvrez un segment ou transmettez ai_wrap_up_code les marqueurs / ai_notes et AI config.
- PUT /api/now/wrapup/segment/update/ai — (IA externe uniquement) Transmettre les recommandations de l’IA au segment ouvert.
- PUT /api/now/wrapup/segment/update : l’agent finalise et ferme le segment.
- GET /api/now/wrapup/segment/{segment_id} : récupérer le segment, y compris les champs IA stockés.
Récapitulatif : GET /now/wrapup/code/{code_id}
Récupère les détails d’un code de récapitulatif spécifié.
Format d'URL
URL avec version : /api/now/{api_version}/wrapup/code/{code_id}
URL par défaut : /api/now/wrapup/code/{code_id}
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 autre que la plus récente. Type de données : chaîne |
| code_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| résultat | Objet contenant des informations sur la demande d’API et le code de récapitulatif. Type de données : objet |
| résultat.message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| result.result_map | Objet contenant le code de récapitulatif. Type de données : objet |
| result.result_map.wrap_up_code | Objet contenant des détails sur le code de récapitulatif. Type de données : objet |
| result.result_map.wrap_up_code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| result.result_map.wrap_up_code.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| result.result_map.wrap_up_code.description | Description du code de récapitulatif. Type de données : chaîne |
| result.result_map.wrap_up_code.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| result.result_map.wrap_up_code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| result.result_map.wrap_up_code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| result.result_map.wrap_up_code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| Résultat.Réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
Demande cURL
Cet exemple récupère les détails d’un code de récapitulatif spécifié.
curl "https://instance.service-now.com/api/now/v1/wrapup/code/49c27b679f201210c89656effa0a1cd7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"result": {
"message": "Wrap up code found.",
"result_map": {
"wrap_up_code": {
"code": "Billing Issue",
"description": "A code for billing issues",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": "Ein code für Abrechnungsprobleme"
}
},
"success": true
}
}Récapitulatif : GET /now/wrapup/segment/{segment_id}
Récupère les détails d’un segment de récapitulatif spécifié.
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/segment/{segment_id}
URL par défaut : /api/now/wrapup/segment/{segment_id}
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 autre que la plus récente. Type de données : chaîne |
| segment_id | Sys_id du segment de récapitulatif dans la table Segment de récapitulatif de l’interaction [interaction_wrap_up_segment], ou identificateur représentant le segment d’interaction sur le système externe. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| Segment de | Objet contenant des données sur le segment d’interaction et de récapitulatif. Type de données : objet |
| Segment.Agent | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| segment.ai_code_defined_at | Horodatage du stockage du code IA. Format : millisecondes d’époque Unix (par exemple, « 1752252703000 ») Type de données : chaîne |
| segment.ai_notes | Notes générées par l’IA stockées sur le segment. Type de données : chaîne |
| segment.ai_notes_defined_at | Horodatage du stockage des notes IA. Format : millisecondes d’époque Unix Type de données : chaîne |
| segment.ai_wrap_up_code | Code recommandé par l’IA stocké sur le segment. Type de données : chaîne |
| segment.awaiting_confirmation | Marqueur indiquant si le segment de récapitulatif soumis par l’agent est en attente de confirmation qu’il a été traité par le système CCaaS externe. Valeurs valides :
Type de données : booléennes |
| segment.confirmed_on | Date et heure auxquelles le segment de récapitulatif soumis est traité dans le système CCaaS externe. Type de données : chaîne |
| Segment.Externe | Marqueur indiquant si le segment d’interaction provient d’un système externe. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| Segment.Interaction | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| segment.opened_on | Date et heure de début de la période de récapitulatif en fonction du système externe. Type de données : chaîne |
| Segment.Segmenté | Marqueur indiquant si le récapitulatif est segmenté. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.segment_id | Sys_id du segment d’interaction. Type de données : chaîne |
| segment.segment_table | Nom de la table contenant le segment d’interaction. Type de données : chaîne |
| segment.état | État du segment d’interaction. Type de données : chaîne |
| segment.submitted_on | Date et heure auxquelles l’agent a soumis le segment de récapitulatif. Type de données : chaîne |
| segment.sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| segment.wrap_up_configuration | Objet contenant des détails sur la configuration de récapitulatif utilisée pour le segment de récapitulatif. Type de données : objet |
| segment.wrap_up_configuration.allowed_codes | Tableau d’objets représentant chacun un code de récapitulatif que l’agent est autorisé à utiliser. Type de données : tableau |
| segment.wrap_up_configuration.allowed_codes.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.codes_autorisés.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.codes_autorisés.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.allowed_codes.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.codes_autorisés.code_traduits | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code | Objet contenant le code de récapitulatif à utiliser par défaut. Type de données : objet |
| segment.wrap_up_configuration.default_code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.default_code.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.default_code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.enable_ai_code | Marqueur indiquant si la génération de code IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_ai_notes | Marqueur indiquant si la génération de notes IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_codes | Marqueur indiquant si l’agent doit sélectionner un code de récapitulatif. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.wrap_up_configuration. Utiliser_l’IA_as_default | Marqueur indiquant si le code IA est automatiquement défini comme code de récapitulatif par défaut pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.use_third_party_ai | Marqueur indiquant si la source de contenu IA provient d’un système externe tiers. Valeurs valides :
Type de données : booléennes |
| segment_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
Demande cURL
Cet exemple récupère les détails d’un segment de récapitulatif spécifié.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/dgajbcef12345678defdbxef123435678" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "Wrap up segment retrieved successfully.",
"segment_id": "dgajbcef12345678defdbxef123435678",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"segment_table": "sn_openframe_phone_log",
"segment_id": "dgajbcef12345678defdbxef123435678",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "closed",
"wrap_up_configuration": {
"enable_codes": true,
"allowed_codes": [
{
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
},
{
"code": "Store Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "54327b679f201210c89656effa0a1cd7",
"translated_code": " Einkaufsproblem",
"translated_description": ""
}
],
"default_code": {
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
}
},
"segmented": true,
"sys_id": "dgajbcef12345678defdbxef123435678",
"opened_on": "2024-09-16 17:52:01",
"submitted_on": "2024-09-16 18:51:59",
"confirmed_on": "2024-09-16 18:52:01",
"awaiting_confirmation": false
}
}Cet exemple récupère les détails d’un segment de récapitulatif spécifié configuré pour les recommandations d’IA.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/abcd1234abcd1234abcd1234abcd1234" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "Segment retrieved.",
"segment_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"state": "closed",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000",
"wrap_up_configuration": {
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"use_third_party_ai": false
}
}
}Récapitulatif : GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}
Récupère les détails d’un segment de récapitulatif en fonction d’un agent et d’une interaction spécifiés.
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}
URL par défaut : /api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}
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 autre que la plus récente. Type de données : chaîne |
| agent_id | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| interaction_id | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| Segment de | Objet contenant des données sur le segment d’interaction et de récapitulatif. Type de données : objet |
| Segment.Agent | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| Segment.Agent | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| segment.ai_code_defined_at | Horodatage du stockage du code IA. Format : millisecondes d’époque Unix (par exemple, « 1752252703000 ») Type de données : chaîne |
| segment.ai_notes | Notes générées par l’IA stockées sur le segment. Type de données : chaîne |
| segment.ai_notes_defined_at | Horodatage du stockage des notes IA. Format : millisecondes d’époque Unix Type de données : chaîne |
| segment.ai_wrap_up_code | Code recommandé par l’IA stocké sur le segment. Type de données : chaîne |
| segment.awaiting_confirmation | Marqueur indiquant si le segment de récapitulatif soumis par l’agent est en attente de confirmation qu’il a été traité par le système CCaaS externe. Valeurs valides :
Type de données : booléennes |
| segment.confirmed_on | Date et heure auxquelles le segment de récapitulatif soumis est traité dans le système CCaaS externe. Type de données : chaîne |
| Segment.Externe | Marqueur indiquant si le segment d’interaction provient d’un système externe. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| Segment.Interaction | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| segment.opened_on | Date et heure de début de la période de récapitulatif en fonction du système externe. Type de données : chaîne |
| Segment.Segmenté | Marqueur indiquant si le récapitulatif est segmenté. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.segment_id | Sys_id du segment d’interaction. Type de données : chaîne |
| segment.segment_table | Nom de la table contenant le segment d’interaction. Type de données : chaîne |
| segment.état | État du segment d’interaction. Type de données : chaîne |
| segment.submitted_on | Date et heure auxquelles l’agent a soumis le segment de récapitulatif. Type de données : chaîne |
| segment.sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| segment.wrap_up_configuration | Objet contenant des détails sur la configuration de récapitulatif utilisée pour le segment de récapitulatif. Type de données : objet |
| segment.wrap_up_configuration.allowed_codes | Tableau d’objets représentant chacun un code de récapitulatif que l’agent est autorisé à utiliser. Type de données : tableau |
| segment.wrap_up_configuration.allowed_codes.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.codes_autorisés.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.codes_autorisés.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.allowed_codes.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.codes_autorisés.code_traduits | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code | Objet contenant le code de récapitulatif à utiliser par défaut. Type de données : objet |
| segment.wrap_up_configuration.default_code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.default_code.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.default_code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.enable_ai_code | Marqueur indiquant si la génération de code IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_ai_notes | Marqueur indiquant si la génération de notes IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_codes | Marqueur indiquant si l’agent doit sélectionner un code de récapitulatif. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.wrap_up_configuration. Utiliser_l’IA_as_default | Marqueur indiquant si le code IA est automatiquement défini comme code de récapitulatif par défaut pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.use_third_party_ai | Marqueur indiquant si la source de contenu IA provient d’un système externe tiers. Valeurs valides :
Type de données : booléennes |
| segment_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
Demande cURL
Cet exemple récupère les détails d’un segment de récapitulatif en fonction d’un agent et d’une interaction spécifiés.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/123412345678567890ab90abcdefcdef/interaction/213412345678567890ab90abcdefcdef" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "Wrap up segment retrieved successfully.",
"segment_id": "dgajbcef12345678defdbxef123435678",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"segment_table": "sn_openframe_phone_log",
"segment_id": "dgajbcef12345678defdbxef123435678",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "closed",
"wrap_up_configuration": {
"enable_codes": true,
"allowed_codes": [
{
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
},
{
"code": "Store Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "54327b679f201210c89656effa0a1cd7",
"translated_code": " Einkaufsproblem",
"translated_description": ""
}
],
"default_code": {
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
}
},
"segmented": true,
"sys_id": "dgajbcef12345678defdbxef123435678",
"opened_on": "2024-09-16 17:52:01",
"submitted_on": "2024-09-16 18:51:59",
"confirmed_on": "2024-09-16 18:52:01",
"awaiting_confirmation": false
}
}Demande cURL
Cet exemple récupère les détails d’un segment de récapitulatif configuré pour les recommandations d’IA.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/987698761234123456xy12ghijklmnoqrst/interaction/879065432198432109xy34mnopqrstuv" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"segment": {
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about incorrect charge.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000",
"wrap_up_configuration": {
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"use_third_party_ai": false
}
}
}Récapitulatif : POST /now/wrapup/code
Crée ou met à jour des codes de récapitulatif.
Les codes de récapitulatif sont créés dans la table Code de récapitulatif d’interaction [interaction_wrap_up_code].
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/code
URL par défaut : /api/now/wrapup/code
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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| codes | Requis. Tableau d’objets représentant chacun un code de récapitulatif. Type de données : tableau |
| codes.actifs | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| codes.code | Requis. Étiquette du code de récapitulatif. Type de données : chaîne |
| codes.description | Description du code de récapitulatif. Type de données : chaîne |
| codes.traductions | Tableau d’objets représentant chacun une traduction du code de récapitulatif. Type de données : tableau |
| codes.traductions.code | Traduction de l’étiquette du code de récapitulatif (codes.code). Requis si le codes.translations paramètre est utilisé. Type de données : chaîne |
| codes.traductions.description | Traduction de la description du code de récapitulatif (codes.description). Requis si le codes.translations paramètre et une valeur ont été fournis pour codes.description. Type de données : chaîne |
| codes.traductions.langue | Code à deux lettres pour la langue utilisée dans la traduction. Requis si le codes.translations paramètre est utilisé. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
| Type de contenu | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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é traitée avec succès. |
| 207 | Réussi. Codes de récapitulatif créés avec succès. Des erreurs de validation se sont produites lors de la création d’autres personnes. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| résultat | Objet contenant des informations sur la demande API et les codes de récapitulatif créés. Type de données : objet |
| résultat.message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| result.result_map | Objet contenant un tableau des codes de récapitulatif créés. Type de données : objet |
| result.result_map.created_wrap_up_codes | Tableau d’objets représentant chacun un code de récapitulatif créé. Type de données : tableau |
| result.result_map.created_wrap_up_codes.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| result.result_map.created_wrap_up_codes.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| result.result_map.created_wrap_up_codes.description | Description du code de récapitulatif. Type de données : chaîne |
| result.result_map.created_wrap_up_codes.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| result.result_map.created_wrap_up_codes.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| result.result_map.created_wrap_up_codes.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| result.result_map.created_wrap_up_codes.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| Résultat.Réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
Demande cURL
Cet exemple crée un code de récapitulatif pour les problèmes de facturation avec une traduction en allemand.
curl "https://instance.service-now.com/api/now/v1/wrapup/code" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"codes\": [
{
\"code\": \"Billing Issue\",
\"description\": \"A code for billing issues\",
\"translations\": [
{
\"language\": \"de\",
\"code\": \"Abrechnungsproblem\",
\"description\": \"Ein code für Abrechnungsprobleme\"
}
]
}
]
}" \
--user 'username':'password'Corps de la réponse.
{
"result": {
"message": "All wrap up codes created successfully.",
"result_map": {
"created_wrap_up_codes": [
{
"code": "Billing Issue",
"description": "A code for billing issues",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": "Ein code für Abrechnungsprobleme"
}
]
},
"success": true
}
}Récapitulatif : POST /now/wrapup/segment/create
Ouvre un segment de récapitulatif pour une interaction.
Les récapitulatifs sont créés dans la table Segment de récapitulatif de l’interaction [interaction_wrap_up_segment]. Appelez ce point de terminaison au début de la période de récapitulatif.
Ce point de terminaison prend en charge les codes et les notes de récapitulatif générés par l’IA directement dans la charge utile de la demande, et il enregistre les marqueurs de configuration IA sur la configuration de récapitulatif. Si external est défini sur faux et que les codes ou notes IA sont activés dans la configuration, une règle métier synchrone s’exécute après la création du segment. Ce point de terminaison appelle l’API CSM (Now Assist) interne et remplit automatiquement les champs d’IA. Aucune action supplémentaire n’est requise de la part de l’appelant.
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/segment/create
URL par défaut : /api/now/wrapup/segment/create
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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| agent_sys_id | Requis. Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| ai_wrap_up_code | Étiquette de code de récapitulatif suggéré par l’IA. Renseigné automatiquement par Now Assist si la valeur est use_third_party_aifausse ou si le champ est absent de la configuration. Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] Type de données : chaîne |
| ai_notes | Notes générées par l’IA. Longueur maximale : 4000 caractères Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] Type de données : chaîne |
| configuration | Objet contenant les détails de code et de durée pour un récapitulatif externe. Requis si externala la valeur vrai.Type de données : objet |
| configuration.allowed_codes | Tableau d’objets représentant chacun un code de récapitulatif que l’agent est autorisé à utiliser. Requis si external et configuration.enable_codes sont tous les deux vrais.Type de données : tableau |
| configuration.allowed_codes.code | Étiquette du code de récapitulatif. Requis si le configuration.allowed_codes paramètre est utilisé. Type de données : chaîne |
| configuration.allowed_codes.traduction | Traduction du code de récapitulatif. Type de données : objet |
| configuration.allowed_codes.traduction.code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| configuration.allowed_codes.traduction.langue | Code à deux lettres pour la langue utilisée dans la traduction. Type de données : chaîne |
| configuration.default_code | Étiquette du code de récapitulatif à utiliser par défaut. Requis si external et configuration.enable_codes sont tous les deux vrais.Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] Champ : Code |
| configuration.duration | Durée maximale autorisée du récapitulatif. Doit être utilisé avec show_timer. Type de données : chaîne Unité : Secondes Par défaut : chaîne vide (aucune limite de temps). |
| configuration.enable_codes | Marqueur indiquant si l’agent doit sélectionner un code de récapitulatif. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| configuration.enable_ai_code | Marqueur indiquant si la génération de code IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| configuration.enable_ai_notes | Marqueur indiquant si la génération de notes IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| configuration.use_ai_as_default | Marqueur indiquant si le code IA est automatiquement défini comme code de récapitulatif par défaut pour cette configuration. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| configuration.show_timer | Requis lors de l’utilisation de la propriété duration. Marqueur indiquant si le minuteur s’affiche. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| externe | Marqueur indiquant si le segment d’interaction provient d’un système externe. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| external_segment_id | Identificateur représentant le segment d’interaction sur le système externe. Requis si externala la valeur vrai.Type de données : chaîne |
| interaction_sys_id | Requis. Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| opened_on | Date et heure de début de la période de récapitulatif en fonction du système externe. Requis si le configuration.duration paramètre est utilisé. Type de données : chaîne |
| segmenté | Marqueur indiquant si le récapitulatif est segmenté. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment_id | Sys_id du segment d’interaction. Requis si external et segmented sont tous les deux vrais.Remarque :
Vous devez implémenter le point d’extension scripté InteractionSegment pour créer et récupérer des enregistrements de segments dans la table choisie ou utiliser l’implémentation OpenFrame pour créer et récupérer des enregistrements de segments dans la table Journal téléphonique [sn_openframe_phone_log]. Type de données : chaîne |
| segment_table | Nom de la table contenant le segment d’interaction. Requis si external et segmented sont tous les deux vrais.Type de données : chaîne |
| wrap_up_configuration_sys_id | Sys_id de la configuration de récapitulatif à utiliser. Requis si external est faux.Type de données : chaîne Table : Configuration du récapitulatif de l’interaction [interaction_wrap_up_configuration] |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
| Type de contenu | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| Segment de | Objet contenant des données sur le segment d’interaction et de récapitulatif. Type de données : objet |
| Segment.Agent | Sys_id de l’agent affecté au segment d’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| Segment.Externe | Marqueur indiquant si le segment d’interaction provient d’un système externe. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| Segment.Interaction | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| segment.opened_on | Date et heure de début de la période de récapitulatif en fonction du système externe. Type de données : chaîne |
| Segment.Segmenté | Marqueur indiquant si le récapitulatif est segmenté. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.segment_id | Sys_id du segment d’interaction. Type de données : chaîne |
| segment.segment_table | Nom de la table contenant le segment d’interaction. Type de données : chaîne |
| segment.état | État du segment d’interaction. Les segments d’interaction créés avec succès par l’API de récapitulatif sont à l’état ouvert. Type de données : chaîne |
| segment.sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| segment.wrap_up_configuration | Objet contenant des détails sur la configuration de récapitulatif utilisée pour le segment de récapitulatif. Type de données : objet |
| segment.wrap_up_configuration.allowed_codes | Tableau d’objets représentant chacun un code de récapitulatif que l’agent est autorisé à utiliser. Type de données : tableau |
| segment.wrap_up_configuration.allowed_codes.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.codes_autorisés.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.codes_autorisés.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.allowed_codes.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.codes_autorisés.code_traduits | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code | Objet contenant le code de récapitulatif à utiliser par défaut. Type de données : objet |
| segment.wrap_up_configuration.default_code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.default_code.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.default_code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.enable_ai_code | Marqueur indiquant si la génération de code IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_ai_notes | Marqueur indiquant si la génération de notes IA est activée pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.enable_codes | Marqueur indiquant si l’agent doit sélectionner un code de récapitulatif. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.wrap_up_configuration. Utiliser_l’IA_as_default | Marqueur indiquant si le code IA est automatiquement défini comme code de récapitulatif par défaut pour cette configuration. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.use_third_party_ai | Marqueur indiquant si la source de contenu IA provient d’un système externe tiers. Valeurs valides :
Type de données : booléennes |
| réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
| sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
Demande cURL
Cet exemple ouvre un segment de récapitulatif pour une interaction.
curl --request POST \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"external": true,
"external_segment_id": "EXT-SEG-001",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge on their invoice.",
"configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
"default_code": "Billing Issue"
}
}'
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "Wrap-up segment created successfully.",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "open",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"wrap_up_configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [...],
"default_code": {...}
}
}
}Demande cURL
Cet exemple ouvre un segment de récapitulatif configuré pour les recommandations d’IA.
curl --request POST \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"external": true,
"external_segment_id": "EXT-SEG-001",
"ai_wrap_up_code": "Billing Issue",
"ai_notes": "Customer called about an incorrect charge on their invoice.",
"configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
"default_code": "Billing Issue"
}
}'Corps de la réponse.
{
"success": true,
"message": "Wrap-up segment created successfully.",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "open",
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"wrap_up_configuration": {
"enable_codes": true,
"enable_ai_code": true,
"enable_ai_notes": true,
"use_ai_as_default": true,
"allowed_codes": [...],
"default_code": {...}
}
}
}Récapitulatif : PUT /now/wrapup/segment/update
Met à jour et ferme un segment de récapitulatif pour une interaction.
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/segment/update
URL par défaut : /api/now/wrapup/segment/update
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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| agent_sys_id | Sys_id de l’agent affecté à l’interaction. Requis avec interaction_sys_id si ni ni ne segment_sys_idexternal_segment_id sont fournis. Type de données : chaîne Table : Utilisateur [sys_user] |
| external_segment_id | Identificateur représentant le segment d’interaction sur le système externe. Utilisé pour identifier le segment de récapitulatif à mettre à jour s’il segment_sys_id n’est pas fourni. |
| interaction_sys_id | Sys_id de l’interaction. Requis avec agent_sys_id si ni ni ne segment_sys_idexternal_segment_id sont fournis. Type de données : chaîne Table : Interaction [interaction] |
| segment_sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| Nom | Description |
|---|---|
| confirmed_on | Date et heure de fin de la période de récapitulatif en fonction du système externe. Type de données : chaîne |
| notes | Notes supplémentaires ajoutées au récapitulatif par l’agent. Type de données : chaîne |
| wrap_up_code | Étiquette du code de récapitulatif sélectionné par l’agent. Si l’agent ne sélectionne pas de code, le code par défaut configuré est utilisé. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] Champ : Code |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
| Type de contenu | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| Segment de | Objet contenant des données sur le segment d’interaction et de récapitulatif. Type de données : objet |
| Segment.Agent | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| segment.awaiting_confirmation | Marqueur indiquant si le segment de récapitulatif soumis par l’agent est en attente de confirmation qu’il a été traité par le système CCaaS externe. Valeurs valides :
Type de données : booléennes |
| code.segment | Objet contenant le code de récapitulatif sélectionné par l’agent. Type de données : objet |
| segment.code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| Code.Segment.Code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.code.description | Description du code de récapitulatif. Type de données : chaîne |
| Segment.Code.Externe | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.confirmed_on | Date et heure auxquelles le segment de récapitulatif soumis est traité dans le système CCaaS externe. Type de données : chaîne |
| Segment.Externe | Marqueur indiquant si le segment d’interaction provient d’un système externe. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| Segment.Interaction | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| segment.notes | Notes supplémentaires ajoutées au récapitulatif par l’agent. Type de données : chaîne |
| segment.opened_on | Date et heure de début de la période de récapitulatif en fonction du système externe. Type de données : chaîne |
| Segment.Segmenté | Marqueur indiquant si le récapitulatif est segmenté. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| segment.segment_id | Sys_id du segment d’interaction. Type de données : chaîne |
| segment.segment_table | Nom de la table contenant le segment d’interaction. Type de données : chaîne |
| segment.état | État du segment d’interaction. Les segments d’interaction que ce point de terminaison met à jour avec succès sont à l’état Fermé. Type de données : chaîne |
| segment.submitted_on | Date et heure auxquelles l’agent a soumis le segment de récapitulatif. Type de données : chaîne |
| segment.sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| segment.wrap_up_configuration | Objet contenant des détails sur la configuration de récapitulatif utilisée pour le segment de récapitulatif. Type de données : objet |
| segment.wrap_up_configuration.allowed_codes | Tableau d’objets représentant chacun un code de récapitulatif que l’agent est autorisé à utiliser. Type de données : tableau |
| segment.wrap_up_configuration.allowed_codes.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.codes_autorisés.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.codes_autorisés.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.allowed_codes.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.codes_autorisés.code_traduits | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.allowed_codes.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code | Objet contenant le code de récapitulatif à utiliser par défaut. Type de données : objet |
| segment.wrap_up_configuration.default_code.active | Marqueur indiquant si le code de récapitulatif est actif. Valeurs valides :
Type de données : booléennes Par défaut : true |
| segment.wrap_up_configuration.default_code.code | Étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.description | Description du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.external | Marqueur indiquant si le code de récapitulatif provient d’un système externe. Valeurs valides :
Type de données : booléennes |
| segment.wrap_up_configuration.default_code.sys_id | Sys_id du code de récapitulatif. Type de données : chaîne Table : Code récapitulatif de l’interaction [interaction_wrap_up_code] |
| segment.wrap_up_configuration.default_code.translated_code | Traduction de l’étiquette du code de récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.default_code.translated_description | Traduction de la description du code du récapitulatif. Type de données : chaîne |
| segment.wrap_up_configuration.enable_codes | Marqueur indiquant si l’agent doit sélectionner un code de récapitulatif. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
| sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
Demande cURL
Cet exemple met à jour et ferme un segment de récapitulatif pour une interaction.
curl "https://instance.service-now.com/api/now/v1/wrapup/segment/update?segment_sys_id=98769876543254321fed1fedcba0cba0&agent_sys_id=123412345678567890ab90abcdefcdef&interaction_sys_id=213412345678567890ab90abcdefcde" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"wrap_up_code\": \"Billing Issue\",
\"notes\": \"Customer's credit card expired. Had to switch to another one.\",
\"confirmed_on\": \"2024-09-16 18:52:01\"
}" \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "Wrap-up segment updated successfully.",
"sys_id": "98769876543254321fed1fedcba0cba0",
"segment": {
"agent": "123412345678567890ab90abcdefcdef",
"segment_table": "sn_openframe_phone_log",
"segment_id": "dgajbcef12345678defdbxef123435678",
"external": true,
"interaction": "213412345678567890ab90abcdefcdef",
"state": "closed",
"wrap_up_configuration": {
"enable_codes": true,
"allowed_codes": [
{
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
},
{
"code": "Store Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "54327b679f201210c89656effa0a1cd7",
"translated_code": " Einkaufsproblem",
"translated_description": ""
}
],
"default_code": {
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
}
},
"code": {
"code": "Billing Issue",
"description": "",
"active": true,
"external": true,
"sys_id": "49c27b679f201210c89656effa0a1cd7",
"translated_code": "Abrechnungsproblem",
"translated_description": ""
},
"notes": "Customer's credit card expired. Had to switch to another one.",
"segmented": true,
"sys_id": "dgajbcef12345678defdbxef123435678",
"opened_on": "2024-09-16 17:52:01",
"submitted_on": "2024-09-16 18:51:59",
"confirmed_on": "2024-09-16 18:52:01",
"awaiting_confirmation": false
}
}Récapitulatif : PUT /now/wrapup/segment/update/ai
Met à jour un segment de récapitulatif ouvert existant avec des notes et des codes de récapitulatif recommandés par l’IA.
Ce point de terminaison est destiné aux systèmes CCaaS externes qui génèrent du contenu d’IA de manière indépendante et le poussent dans la plateforme après la création du ServiceNow segment. La use_third_party_ai propriété doit être vraie dans la configuration de récapitulatif.
Si le enable_ai_code ou enable_ai_notes est faux dans la configuration, les champs IA correspondants sont enregistrés, même s’ils sont inclus dans la charge utile de la demande. Les ai_code_defined_at horodatages et ai_notes_defined_at sont automatiquement définis au moment du stockage.
- Recommandations de conclusion IA
-
Les recommandations de conclusion IA peuvent provenir de deux sources :
- Interne ()Now Assist : lorsque use_third_party_ai la valeur est faux, une règle métier se déclenche automatiquement après la création du segment pour appeler l’API CSM et renseigner ai_wrap_up_code et ai_notes.
- Externe (tiers/CCaaS) : lorsque use_third_party_ai la valeur est vrai, le système externe envoie les données d’IA via le nouveau point de terminaison PUT /api/now/wrapup/segment/update/ai .
- Cas d'utilisation
-
- Réduisez le temps de traitement de l’agent en fournissant des codes de récapitulatif et des notes avec des suggestions de l’IA.
- Permettez aux plateformes CCaaS d’intégrer du contenu ServiceNow AI Platform généré par l’IA après la fin d’une interaction.
- Fournissez aux superviseurs des données de récapitulatif plus propres et plus cohérentes pour les rapports et les analyses.
- Ordre d’appel de point de terminaison pour un flux de récapitulatif assisté par l’IA
-
- POST /api/now/wrapup/segment/create : ouvrez un segment ou transmettez ai_wrap_up_code les marqueurs / ai_notes et AI config.
- PUT /api/now/wrapup/segment/update/ai — (IA externe uniquement) Transmettre les recommandations de l’IA au segment ouvert.
- PUT /api/now/wrapup/segment/update : l’agent finalise et ferme le segment.
- GET /api/now/wrapup/segment/{segment_id} : récupérer le segment, y compris les champs IA stockés.
Format d'URL
URL versionnée : /api/now/{api_version}/wrapup/segment/update/ai
URL par défaut : /api/now/wrapup/segment/update/ai
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 autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| agent_sys_id | Sys_id de l’agent affecté à l’interaction. Requis avec interaction_sys_id si ni ni ne external_segment_idsegment_sys_id sont fournis. Type de données : chaîne Table : Utilisateur [sys_user] |
| ai_wrap_up_code | Étiquette de code de récapitulatif recommandée par l’IA. Stocké uniquement si la enable_ai_code propriété est vraie dans la configuration.Récapitulatif : POST /now/wrapup/segment/create Type de données : chaîne |
| ai_notes | Notes générées par l’IA. . Stocké uniquement si enable_ai_notes a la valeur vrai dans la configuration.Récapitulatif : POST /now/wrapup/segment/create Longueur maximale : 4000 caractères Type de données : chaîne |
| interaction_sys_id | Sys_id de l’interaction. Requis avec agent_sys_id si ni ni ne external_segment_idsegment_sys_id sont fournis. Type de données : chaîne Table : Interaction [interaction] |
| segment_sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
| Type de contenu | Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
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é traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 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 |
|---|---|
| message | Message décrivant le résultat de la demande d’API. Type de données : chaîne |
| Segment de | Objet contenant des données sur le segment d’interaction et de récapitulatif. Type de données : objet |
| Segment.Agent | Sys_id de l’agent affecté à l’interaction. Type de données : chaîne Table : Utilisateur [sys_user] |
| segment.ai_code_defined_at | Horodatage du stockage du code IA. Format : millisecondes d’époque Unix (par exemple, « 1752252703000 ») Type de données : chaîne |
| segment.ai_notes | Notes générées par l’IA stockées sur le segment. Type de données : chaîne |
| segment.ai_notes_defined_at | Horodatage du stockage des notes IA. Format : millisecondes d’époque Unix Type de données : chaîne |
| segment.ai_wrap_up_code | Code recommandé par l’IA stocké sur le segment. Type de données : chaîne |
| Segment.Interaction | Sys_id de l’interaction. Type de données : chaîne Table : Interaction [interaction] |
| segment.sys_id | Sys_id du segment de récapitulatif. Type de données : chaîne Table : Segment récapitulatif de l’interaction [interaction_wrap_up_segment] |
| réussite | Marqueur indiquant si la demande d’API a été traitée avec succès. Valeurs valides :
Type de données : booléennes |
Demande cURL
Cet exemple met à jour et ferme un segment de récapitulatif pour une interaction.
curl --request PUT \
--url 'https://instance.servicenow.com/api/now/wrapup/segment/update/ai' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--user 'username:password' \
--data '{
"segment_sys_id": "abcd1234abcd1234abcd1234abcd1234",
"agent_sys_id": "123412345678567890ab90abcdefcdef",
"interaction_sys_id": "213412345678567890ab90abcdefcdef",
"ai_wrap_up_code": "Plan Update",
"ai_notes": "Customer requested an upgrade to the Premium plan."
}' \
--user 'username':'password'Corps de la réponse.
{
"success": true,
"message": "AI wrap-up data updated successfully.",
"segment": {
"sys_id": "abcd1234abcd1234abcd1234abcd1234",
"agent": "123412345678567890ab90abcdefcdef",
"interaction": "213412345678567890ab90abcdefcdef",
"ai_wrap_up_code": "Plan Update",
"ai_notes": "Customer requested an upgrade to the Premium plan.",
"ai_code_defined_at": "1752252703000",
"ai_notes_defined_at": "1752252703000"
}
}