API de demande d’aide
L’API de demande d’aide fournit un point de terminaison pour suivre les actions d’aide du superviseur.
Cette API enregistre l’aide du superviseur pour les agents travaillant sur les interactions, y compris l’heure de début et de fin de l’aide et le type d’aide. Pour plus d’informations sur les demandes d’aide, reportez-vous à la section Agent help request for voice calls.
Cette API nécessite le module d’extension Gestion des interactions (com.glide.interaction). L’utilisateur appelant doit avoir le rôle interaction_integration_user.
Demande d’aide : POST /now/helprequest/action/create_or_update
Crée ou met à jour une action d’aide du superviseur.
Appelez ce point de terminaison lorsqu’un superviseur accepte une demande d’aide d’interaction. Un enregistrement permettant de suivre l’aide est créé dans la table Action d’aide du superviseur [supervisor_help_action]. Appelez à nouveau ce point de terminaison lorsque le superviseur a terminé son aide pour mettre à jour l’enregistrement de l’action d’aide avec l’heure de fin.
Format d'URL
URL avec version : /api/now/{api_version}/helprequest/action/create_or_update
URL par défaut : /api/now/helprequest/action/create_or_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 |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| action | Type d’assistance fournie par le superviseur. Requis lors de la création d’une action d’aide du superviseur. Valeurs valides (sensibles à la casse) :
Pour plus d’informations sur les actions du superviseur, reportez-vous à la section Monitoring calls. Type de données : chaîne |
| action_sys_id | Sys_id de l’action d’aide du superviseur. Nécessaire lors de la mise à jour d’une seule action d’aide du superviseur spécifiée, mais peut être exclu pour mettre à jour en bloc toutes les actions d’aide du superviseur pour une interaction. Table : Action d’aide du superviseur [supervisor_help_action] Type de données : chaîne |
| end_time | Date et heure auxquelles le superviseur a mis fin à l’assistance. Remarque : Pour mettre à jour une seule action d’aide du superviseur spécifiée avec une heure de fin, une valeur valide doit être fournie pour ce paramètre. Toutefois, lors de la mise à jour en bloc de toutes les actions d’aide du superviseur pour une interaction, l’exclusion de ce paramètre définit l’heure actuelle comme heure de fin. Type de données : chaîne |
| help_request | Sys_id de la demande d’aide sur l’interaction. Table : Demande d’aide pour l’interaction [interaction_help_request] Type de données : chaîne |
| interaction | Requis. Sys_id de l’interaction. Table : Interaction [interaction] Type de données : chaîne |
| start_time | Date et heure auxquelles le superviseur a commencé l’assistance. Par défaut : date et heure de création de l’enregistrement d’action d’aide du superviseur. 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. |
| 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. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Détails sur le résultat de la demande d’API. Type de données : objet |
| result.action_sys_id | Sys_id de l’action d’aide du superviseur créée ou mise à jour. Table : Action d’aide du superviseur [supervisor_help_action] Type de données : chaîne |
| résultat.message | Message contenant des détails sur la réussite ou l’échec de la demande d’API. Type de données : chaîne |
| Résultat.Réussite | Marqueur indiquant si la demande d’API a réussi. Valeurs possibles :
Type de données : booléennes |
Demande cURL
Cet exemple crée une action d’aide du superviseur.
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
\"action\": \"coach\"
}" \
--user 'username':'password'Corps de la réponse.
{
"result": {
"success": true,
"message": "Supervisor help action created successfully",
"action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
}
}Demande cURL
Cet exemple met à jour une action d’aide du superviseur avec une heure de fin.
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
\"action_sys_id\": \"d25f034f3b4bfe101baa9f7e53e45a9f\",
\"end_time\": \"2026-02-18 11:30:00\"
}" \
--user 'username':'password'Corps de la réponse.
{
"result": {
"success": true,
"message": "Supervisor help action updated successfully",
"action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
}
}Demande cURL
Cet exemple met à jour toutes les actions d’aide du superviseur pour une interaction avec une heure de fin.
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"cd87db433bcbfe101baa9f7e53e45a4d\",
\"end_time\": \"2026-02-18 11:24:18\"
}" \
--user 'username':'password'Corps de la réponse.
{
"result": {
"success": true,
"message": "end_time updated for all supervisor help actions associated with the interaction id: cd87db433bcbfe101baa9f7e53e45a4d"
}
}