API de consultation d’agent AWA
Gère les éléments de travail de consultation de l’agent.
Cette API nécessite le module d’extension Affectation de travail avancée (com.glide.awa) et le rôle awa_integration_user.
Pour plus d’informations sur AWA, voir Affectation de travail avancée.
Utilisez pour API de travail d’offre AWA initier le transfert d’une consultation vers un agent ou une file d’attente.
Consultation d’agent AWA : PUT /now/awa/consult/end
Met fin à un élément de travail de consultation.
Lorsqu’un document est transféré à un agent, l’élément de travail concerné doit être fermé avec l’état de consultation approprié, soit Transféré, soit Terminé.
Un élément de travail est un travail unique géré par un agent AWA du début à la fin. Un élément de travail est créé à partir d’un document, tel qu’une interaction ou une tâche.
Format d'URL
URL versionnée : /api/now/{api_version}/awa/consult/end
URL par défaut : /api/now/awa/consult/end
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 |
|---|---|
| document_sys_id | Sys_id du document associé à l’élément de travail de consultation. Un document est un enregistrement dans n’importe quelle table, comme une interaction, un ticket ou un incident. Type de données : chaîne |
| hand_over | Marqueur indiquant si le transfert d’une consultation doit être interrompu ou transféré. Valeurs valides :
Remarque :
Si l’état de consultation de l’élément de travail de consultation est Demandé, l’état devient Annulé. Type de données : booléennes |
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. |
| 403 | Interdit. Raisons possibles :
|
| 404 | Introuvable. L’élément demandé est introuvable. |
| 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éussite | Marqueur indiquant si la consultation de fin a réussi. Valeurs valides :
Type de données : booléennes |
| message | Informations sur la réussite ou l’échec de la consultation de fin. Valeurs possibles :
Type de données : chaîne |
Exemple de demande cURL
curl "https://instance.servicenow.com/api/now/awa/consult/end" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
"document_sys_id": "59616aba87bd5210be070d48dabb35e6",
"hand_over": "true"
}' \
--user 'username':'password'{
"result": {
"success": true,
"message": "Consult is successfully ended."
}
}