Interaction Management API

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 6 minutes de lecture

    • L’API Gestion des interactions fournit des points de terminaison pour créer des interactions.

    Cette classe nécessite le module d’extension Interaction Logging, Routing, and Queueing (com.glide.interaction).

    Interaction : POST /now/interaction

    Insère ou met à jour un enregistrement dans la table d’interaction.

    Format d'URL

    URL versionnée : /api/now/{api_version}/interaction

    URL par défaut : /api/now/interaction

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. 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
    Tableau 2. Paramètres de requête
    Nom Description
    Aucun
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Élément Description
    canal Requis. Sys_id du connecteur d’interaction pour lequel vous souhaitez créer une interaction.

    Type de données : chaîne
    contexte Une carte ou une paire table/sys_id. Par défaut, les interactions ont un enregistrement dans la table interaction_json_blob qui stocke les données de contexte en tant qu’objet JSON. Vous pouvez pointer une interaction vers un autre enregistrement pour le contexte. Utilisez le contexte ou context_table/context_id pour définir le contexte d’une interaction.

    Type de données : chaîne
    context_id ID de document d’un enregistrement que vous souhaitez utiliser pour stocker le contexte. La valeur par défaut est un nouvel enregistrement dans la table insteraction_json_blob. Si vous définissez l’ID de contexte, vous devez également définir la table.

    Type de données : chaîne
    context_table Table de contexte que vous souhaitez utiliser pour stocker le contexte de l’interaction. La valeur par défaut est interaction_json_blob. Si vous définissez la table de contexte, vous devez également définir l’ID de contexte.

    Type de données : chaîne
    channel_metadata Carte ou paire table/sys_id. Les métadonnées de canal contiennent des informations qu’un connecteur peut utiliser pour communiquer via le canal associé.

    Type de données : chaîne
    channel_metadata_id ID de document d’un enregistrement que vous souhaitez utiliser pour stocker les métadonnées de canal. La valeur par défaut est un nouvel enregistrement dans la table live_group_profile. Si vous définissez l’ID des métadonnées du canal, vous devez également définir la table.

    Type de données : chaîne
    channel_metadata_table Table que vous souhaitez utiliser pour stocker les métadonnées de canal. La valeur par défaut est la table live_group_profile. Si vous définissez la table de métadonnées du canal, vous devez également définir l’ID des métadonnées du canal.

    Type de données : chaîne
    queue Sys_id de la file d’attente que vous souhaitez associer à l’interaction.

    Type de données : chaîne

    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.

    Tableau 4. En-têtes de demandes
    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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 5. En-têtes de réponses
    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.

    Tableau 6. Codes d'état
    Code d'état Description
    201 Indique que la requête a été exécutée avec succès.
    400 Indique qu’un ou plusieurs paramètres obligatoires étaient manquants dans la demande.
    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 réponse (JSON ou XML)

    Élément Description
    assigned_to sys_id de l’utilisateur auquel l’interaction est affectée.

    Type de données : chaîne
    channelMetadataDocument (en anglais seulement) Le sys_id du document de métadonnées de canal associé à l’interaction.

    Type de données : chaîne
    channelMetadataTable Nom de table de la table de métadonnées du canal associée à l’interaction.

    Type de données : chaîne
    channel_metadata Toutes les métadonnées de canal incluses pour l’interaction.

    Type de données : chaîne
    closed_by Le sys_id de l’utilisateur qui a fermé l’interaction.

    Type de données : chaîne
    contextDocument Le sys_id du document de contexte associé à l’interaction.

    Type de données : chaîne
    contextTable Le nom de la table associée à l’interaction.

    Type de données : chaîne
    Numéro Numéro de la nouvelle interaction.

    Type de données : chaîne
    opened_for Le sys_id de l’utilisateur pour lequel l’interaction a été ouverte.

    Type de données : chaîne
    queue Le sys_id de la file d’attente pour laquelle vous créez l’interaction.

    Type de données : chaîne
    État L’état de l’interaction. Si vous affectez une file d’attente, l’état passe automatiquement à Mis en file d’attente, sinon la valeur par défaut est Nouveau.

    Type de données : chaîne
    sys_id Le sys_id de l’interaction.

    Type de données : chaîne

    Exemple de demande cURL

    curl "http://instance.servicenow.com/api/now/interaction" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"channel\":\"28a59893873103002ae97e2526cb0b5d\",\"queue\":\"f3a50867b30303002186a72256a8dcb7\"}" \
--user "username":"password"
    {
  "result": {
    "channel": "28a59893873103002ae97e2526cb0b5d",
    "context": {
      "present": true
    },
    "queue": "f3a50867b30303002186a72256a8dcb7",
    "state": "queued",
    "number": "IMS0000075",
    "contextDocument": "1863a6f0d9471300964f387107a8a36d",
    "contextTable": "interaction_json_blob",
    "channelMetadataDocument": "9463a6f0d9471300964f387107a8a36c",
    "channelMetadataTable": "live_group_profile",
    "channel_metadata": {
      "present": true
    },
    "sys_id": "dc63a6f0d9471300964f387107a8a36b",
    "assigned_to": "",
    "closed_by": "",
    "opened_for": ""
  }
}

    Interaction : PUBLIER /now/interaction/{interaction_id}/close

    Bascule l’état d’une interaction sur Fermé ou Fermé terminé.

    Format d'URL

    URL versionnée : /api/now/{api_version}interaction/{interaction_id}/close

    URL par défaut : /api/now/interaction/{interaction_id}/close

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. 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
    interaction_id Sys_id de l’interaction que vous souhaitez fermer.

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    Aucun
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Aucun

    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.

    Tableau 10. En-têtes de demandes
    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
    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 11. En-têtes de réponses
    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.

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    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 réponse (JSON ou XML)

    Élément Description
    assigned_to sys_id de l’utilisateur auquel l’interaction est affectée.

    Type de données : chaîne
    channelMetadataDocument (en anglais seulement) Le sys_id du document de métadonnées de canal associé à l’interaction.

    Type de données : chaîne
    channelMetadataTable Nom de table de la table de métadonnées du canal associée à l’interaction.

    Type de données : chaîne
    channel_metadata Toutes les métadonnées de canal incluses pour l’interaction.

    Type de données : chaîne
    closed_by Le sys_id de l’utilisateur qui a fermé l’interaction.

    Type de données : chaîne
    contextDocument Le sys_id du document de contexte associé à l’interaction.

    Type de données : chaîne
    contextTable Le nom de la table associée à l’interaction.

    Type de données : chaîne
    Numéro Numéro de la nouvelle interaction.

    Type de données : chaîne
    opened_for Le sys_id de l’utilisateur pour lequel l’interaction a été ouverte.

    Type de données : chaîne
    queue Le sys_id de la file d’attente pour laquelle vous créez l’interaction.

    Type de données : chaîne
    État L’état de l’interaction. Si vous affectez une file d’attente, l’état passe automatiquement à Mis en file d’attente, sinon la valeur par défaut est Nouveau.

    Type de données : chaîne
    sys_id Le sys_id de l’interaction.

    Type de données : chaîne

    Exemple de demande cURL

    curl "http://instance.servicenow.com/api/now/interaction/b243cde4208f1700964f959e0488dee8/close" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"

    {
  "result": {
    "channel": "28a59893873103002ae97e2526cb0b5d",
    "context": {
      "present": true
    },
    "queue": "f3a50867b30303002186a72256a8dcb7",
    "state": "closed_complete",
    "number": "IMS0000060",
    "contextDocument": "3a43cde4208f1700964f959e0488dee7",
    "contextTable": "interaction_json_blob",
    "channelMetadataDocument": "fa43cde4208f1700964f959e0488dee8",
    "channelMetadataTable": "live_group_profile",
    "channel_metadata": {
      "present": true
    },
    "sys_id": "b243cde4208f1700964f959e0488dee8",
    "assigned_to": "",
    "closed_by": "6816f79cc0a8016401c5a33be04be441",
    "opened_for": "46d44a23a9fe19810012d100cca80666"
  }
}