API de mappage d’agent

  • Rversion finale: Yokohama
  • Mis à jour 10 févr. 2025
  • 3 minutes de lecture

    • L’API de mappage d’agent fournit un point de terminaison pour mapper les ID d’agents externes des systèmes CCaaS (Contact Center as a Service) aux ID d’agents internes dans le Now Platform.

    Cette API nécessite le module d’extension External Agent Management Util Pack (sn_external_agent). Pour appeler cette API, vous devez disposer du rôle interaction_agent.

    Pour plus d’informations sur l’intégration aux systèmes CCaaS, reportez-vous à la section Integrating with contact centers.

    Mappage de l’agent : PUT /sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

    Mappe un ID d’agent externe d’un système CCaaS (Contact Center as a Service) à un ID d’agent interne dans le Now Platform.

    Appelez ce point de terminaison lorsqu’un agent se connecte ou se déconnecte du système CCaaS pour mettre à jour son statut actif. Ce point de terminaison crée ou met à jour des enregistrements dans la table Mappage d’agent externe [external_agent_mapping] avec les données suivantes :
    • ID de l’agent CCaaS externe
    • Identité du canal du fournisseur associée à l’ID entrant
    • État actif de l’agent dans le système CCaaS
    • Référence à l’enregistrement Utilisateur [sys_user] pour l’agent

    Format d'URL

    URL par défaut : /api/sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    agentId Sys_id de l’agent interne.

    Type de données : chaîne

    Table : Utilisateur [sys_user]
    inboundId ID entrante à partir de l’enregistrement d’identité du canal du fournisseur pour le système CCaaS.

    Type de données : chaîne

    Table : Identité du canal du fournisseur [sys_cs_provider_application]

    Champ : ID entrante
    Tableau 2. Paramètres de requête
    Nom Description
    Néant
    Tableau 3. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si l’agent est actuellement connecté au système CCaaS.
    Valeurs valides :
    • vrai : l’agent est connecté.
    • faux : l’agent est déconnecté.

    Par défaut : true

    Type de données : booléennes
    external_agent_id Requis. ID de l’agent externe du système CCaaS.

    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. Prend uniquement en charge application/json.
    Content-Type Format de données du corps de la demande. Prend uniquement en charge 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
    200 OK.

    Enregistrement de mappage d’agent existant mis à jour.
    201 Créé.

    Nouvel enregistrement de mappage d’agent créé.
    400 Demande incorrecte.

    L’ID de l’agent ou l’ID entrant fourni dans la demande n’est pas valide.

    Paramètres de corps de réponse (JSON)

    Nom Description
    résultat Objet de résultat contenant des informations sur la demande.

    Type de données : objet
    result.mappingIds Sys_ids de tout enregistrement créé ou mis à jour dans la table Mappage d’agent externe [external_agent_mapping].

    Type de données : tableau de chaînes
    résultat.message Message expliquant le résultat de la demande.

    Type de données : chaîne
    résultat.état État de la demande.
    Valeurs possibles :
    • Réussite
    • Échec

    Type de données : chaîne

    Demande cURL

    Cet exemple mappe un agent interne avec sys_id da419c1fc312310015519f2974d3ae15 à l’ID correspondant 12345 du système CCaaS externe.

    curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"external_agent_id\":\"12345\"}" \ 
--user 'username':'password'

    Corps de la réponse :

    {
  "result": { 
    "message": "Agent Id mapping record inserted", 
    "status": "success", 
    "mappingIds": [ 
      "128b74fcc3931a50325a4ad9d00131c3" 
    ] 
  } 
}

    Demande cURL

    Cet exemple définit le active paramètre sur false pour indiquer que l’agent est déconnecté du système CCaaS.

    curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{"external_agent_id":"12345", "active":"false"}" \ 
--user 'username':'password'

    Corps de la réponse :

    { 
  "result": { 
    "message": "Agent Id mapping record updated", 
    "status": "success", 
    "mappingIds": [ 
      "cea77cebebef9e10a341fc7acad0cdc2" 
    ] 
  } 
}