Contact API

Référence de l’API Xanadu

Release

xanadu

ft:locale

fr-FR

ft:publication_title

Référence de l’API Xanadu

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Contact API

Rversion finale: Xanadu

Mis à jour 1 août 2024

27 minutes de lecture

L’API Contact fournit des points de terminaison qui vous permettent de récupérer et de mettre à jour Gestion du service client (CSM) des enregistrements de contact.

De plus, vous pouvez générer de nouveaux enregistrements de profil de médias sociaux lors de la création d’un contact.

L’API Contact nécessite le module d’extension Service clientèle (com.sn_customerservice) et est fournie dans l’espace de noms Now .

Les utilisateurs ont besoin du rôle csm_ws_integration pour bénéficier d’un accès complet à l’API.

Contact : GET /now/contact

Récupère un ensemble spécifié de Gestion du service client (CSM) contacts.

Format d'URL

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

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

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
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Dans la réponse, le paramètre hasMore booléen est renvoyé. Il indique s’il existe d’autres enregistrements à renvoyer qui répondent aux critères de filtre. Type de données : nombre Par défaut : 10
sysparm_offset	Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre `sysparm_offset=sysparm_offset+sysparm_limit`, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le paramètre sysparm_offset. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l'ensemble de résultats. Par exemple : `sysparm_query=caller_id=javascript :gs.getUserID()^active=true` La requête codée prend en charge le tri par. Pour trier les réponses en fonction de certains champs, utilisez les clauses ORDERBY et ORDERBYDESC dans sysparm_query. Par exemple, `sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` filtre tous les enregistrements actifs et trie les résultats par ordre croissant par numéro d’abord, puis par ordre décroissant par catégorie. Si une partie de la requête n'est pas valide (par exemple, un nom de champ non valide a été spécifié), l'instance ignore la partie non valide. Puis, elle renvoie les lignes en utilisant uniquement la partie valide de la requête. Vous pouvez contrôler ce comportement à l'aide de la propriété glide.invalid_query.returns_no_rows. Définissez cette propriété sur true pour ne renvoyer aucune ligne dans une requête non valide. Remarque : La propriété glide.invalid_query.returns_no_rows contrôle le comportement de toutes les requêtes dans l'instance, par exemple dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne

Tableau 3. 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 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

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	Réussi. La demande a été correctement traitée.
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.
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)

Le point de terminaison peut renvoyer les éléments JSON ou XML suivants dans le corps de la réponse. En plus de la liste des éléments définis ci-dessous (qui définissent les éléments d’un système de base), le point de terminaison renvoie également tous les champs personnalisés ajoutés à la table Contact [customer_contact]. Pour plus d’informations sur ces éléments, reportez-vous à la définition de table spécifique [Définition du système > Tables].


Élément	Description
compte	Sys_id de l’enregistrement de compte auquel le contact est associé ; Table de compte [customer_account]. Type de données : chaîne
Actif	Marqueur indiquant si le contact est actif dans le système. Valeurs possibles : true : le contact est actif false : le contact est inactif Type de données : booléennes Valeur par défaut : true
agent_status	État de l’agent. Valeurs possibles : Absent du bureau En pause En déplacement Sur site Type de données : chaîne Longueur maximale : 40
génération	Sys_id du dossier qui décrit l’immeuble dans lequel réside la personne-ressource ; Table de bâtiment [cmn_building]. Type de données : chaîne
calendar_integration	Application de calendrier que le contact utilise. 1 : Perspectives Type de données : nombre (entier) Valeur par défaut : 1
city	Ville dans laquelle réside la personne à contacter. Type de données : chaîne Longueur maximale : 40
company	Sys_id de l’enregistrement de la société auquel le contact est associé ; Table de société [core_company]. Type de données : chaîne
cost_center	Sys_id du centre de coûts associé au contact ; Table Centre de coûts [cmn_cost_center]. Type de données : chaîne
pays	Code pays du pays dans lequel le contact réside. Type de données : chaîne Longueur maximale : 3
date_format	Format dans lequel afficher les dates aux contacts. Valeurs valides : jj/mm/aaaa jj-mm-aaaa jj.mm.aaaa mm-jj-aaaa aaaa-mm-jj Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système)
default_perspective	Sys_id de la perspective par défaut pour le contact. Situé dans la table Liste des menus [sys_perspective]. Type de données : chaîne
département	Sys_id du département associé au contact. Situé dans la table Département [cmn_department]. Type de données : chaîne
edu_status	État de formation du contact associé. Type de données : chaîne Longueur maximale : 40 Par défaut : faculty
E-mail	Adresse e-mail du contact. Type de données : chaîne
employee_number	Numéro d’employé du contact. Type de données : chaîne
enable_multifactor_authn	Marqueur indiquant si l’autorisation multifacteur est requise pour que le contact se connecte au portail de services. Valeurs possibles : true : autorisation multifacteur activée false : autorisation multifacteur désactivée Type de données : booléennes Valeur par défaut : false
failed_attempts	Nombre d’échecs de tentatives de connexion. Type de données : nombre (entier)
first_name	Prénom du contact. Type de données : chaîne Longueur maximale : 50
sexe	Sexe de contact. Type de données : chaîne Longueur maximale : 40
geolocation_tracked	Marqueur indiquant si l’emplacement du contact est obtenu par géolocalisation. Valeurs possibles : true : emplacement du contact obtenu grâce à la géolocalisation false : emplacement du contact non obtenu par géolocalisation Type de données : booléennes Valeur par défaut : faux
home_phone	Numéro de téléphone du domicile du contact. Type de données : chaîne Longueur maximale : 40
internal_integration_user	Marqueur indiquant si le contact est un utilisateur d’intégration interne. Valeurs possibles : true : utilisateur d’intégration interne false : autre type d’utilisateur Type de données : booléennes Valeur par défaut : false
Introduction	Introduction Type de données : chaîne Longueur maximale : 40
last_login	Date à laquelle le contact s’est connecté pour la dernière fois au système. Type de données : chaîne (date)
last_login_device	Appareil que le consommateur a utilisé la dernière fois qu’il s’est connecté au système. Type de données : chaîne Longueur maximale : 40
last_login_time	Date et heure auxquelles le contact s’est connecté au système. Type de données : chaîne (date/heure)
last_name	Nom de famille du contact. Type de données : chaîne Longueur maximale : 50
last_position_update	Date et heure de mise à jour de la dernière position. Type de données : chaîne (date/heure)
latitude	Coordonnées de latitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
ldap_server	Sys_id du serveur LDAP utilisé par le contact pour la dernière connexion au système ; Table de serveur LDAP [ldap_server_config]. Type de données : chaîne
emplacement	Sys_id de l’enregistrement qui décrit l’emplacement de la personne-ressource ; Table d’emplacement [cmn_location]. Type de données : chaîne
locked_out	Marqueur indiquant si le contact est verrouillé. Valeurs possibles : true : contact verrouillé false : contact non verrouillé Type de données : booléennes Valeur par défaut : false
longitude	Coordonnées de longitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
responsable	Sys_id du dossier qui décrit le superviseur direct de la personne-ressource ; Table Utilisateur [sys_user]. Type de données : chaîne
middle_name	Deuxième prénom du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 50
mobile_phone	Numéro de téléphone mobile du contact. Type de données : chaîne Longueur maximale : 40
nom	Nom complet du contact. Type de données : chaîne Longueur maximale : 151
Notification	Indique si le contact doit recevoir des notifications. Valeurs valides : 1 : désactivé 2 : Activé Type de données : nombre (entier) Valeur par défaut : 2
on_schedule	Indique la ponctualité du personnel de service dépêché. Valeurs valides : En avance : en avance sur le calendrier. behind_less30 : En retard, mais moins de 30 minutes. behind_30to60 : En retard entre 30 et 60 minutes. behind_more60 : Plus de 60 minutes de retard. on_time : Comme prévu. Type de données : chaîne Longueur maximale : 40
Téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne Longueur maximale : 40
photo	Image photo du contact. Type de données : Image
preferred_language	Code du pays de la langue principale du contact. Type de données : chaîne Longueur maximale : 3
roles	Liste des rôles d’utilisateur associés au contact. Type de données : chaîne Longueur maximale : 40
schedule	Sys_id de l’enregistrement qui décrit l’horaire de travail de la personne-ressource associée ; Table de calendrier [cmn_schedule]. Type de données : chaîne
source	Source du contact. Type de données : chaîne Longueur maximale : 255
État	État dans lequel le contact réside. Type de données : chaîne Longueur maximale : 40
rue	Adresse postale du contact. Type de données : chaîne Longueur maximale : 255
sys_class_name	Table contenant l’enregistrement du contact. Type de données : chaîne Longueur maximale : 80
sys_created_by	Utilisateur ayant initialement créé l’enregistrement de contact associé. Type de données : chaîne Longueur maximale : 40
sys_created_on	Les données et l’heure auxquelles le contact associé a été créé à l’origine. Type de données : chaîne (date/heure)
sys_domain	ServiceNow Domaine d’instance de l’enregistrement de contact associé. Type de données : chaîne
sys_domain_path	Chemin de domaine de l’enregistrement du contact. Type de données : chaîne Longueur maximale : 255 Par défaut : / (global)
sys_id	Identificateur unique pour l’enregistrement de contact associé. Type de données : chaîne
sys_mod_count	Nombre de fois où l’enregistrement de contact associé a été modifié. Type de données : nombre (entier)
sys_tags	Balises système. Type de données : chaîne
sys_updated_by	Utilisateur qui a mis à jour les informations de contact associées en dernier. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Données et heure auxquelles les informations de contact associées ont été mises à jour. Type de données : chaîne (date/heure)
time_format	Format dans lequel afficher l’heure. Valeurs valides : hh.mm.ss : hh.mm.ss (12 heures) hh :mm :ss a : hh :mm :ss (12 heures) HH.mm.ss : hh.mm.ss (24 heures) HH :mm :ss : hh :mm :ss (24 heures) Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d’heure système)
time_sheet_policy	Sys_id de l’enregistrement qui contient la politique de feuille de temps pour le contact associé ; Table de la politique de feuille de temps [time_sheet_policy]. Type de données : chaîne
time_zone	Fuseau horaire dans lequel la personne à contacter réside, par exemple Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du contact tel que Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60
user_name	ID de l’utilisateur du contact. Type de données : chaîne Longueur maximale : 40
Vip	Marqueur indiquant si le contact associé a le statut VIP. Valeurs possibles : vrai : VIP faux : pas VIP Type de données : booléennes Valeur par défaut : false
web_service_access_only	Marqueur indiquant si le contact peut accéder aux services uniquement via le Web. Valeurs possibles : true : accès Web uniquement false : accès via toutes les méthodes disponibles Type de données : booléennes Valeur par défaut : false
code postal	Code postal du contact. Type de données : chaîne Longueur maximale : 40

Demande cURL

curl "https://instance.servicenow.com/api/now/contact?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "country": "",
      "calendar_integration": "1",
      "last_position_update": "",
      "last_login_time": "2018-03-10 21:48:11",
      "last_login_device": "",
      "source": "",
      "sys_updated_on": "2019-01-03 05:49:34",
      "building": "",
      "web_service_access_only": "false",
      "notification": "2",
      "sys_updated_by": "system",
      "enable_multifactor_authn": "false",
      "sys_created_on": "2018-03-04 20:26:32",
      "sys_domain": "global",
      "agent_status": "",
      "state": "",
      "vip": "false",
      "sys_created_by": "admin",
      "longitude": "",
      "zip": "",
      "home_phone": "",
      "time_format": "",
      "last_login": "",
      "default_perspective": "",
      "geolocation_tracked": "false",
      "active": "true",
      "time_sheet_policy": "",
      "sys_domain_path": "/",
      "phone": "+1 858 287 7834",
      "cost_center": "",
      "name": "George Warren",
      "employee_number": "",
      "gender": "",
      "city": "",
      "user_name": "george.warren",
      "failed_attempts": "",
      "edu_status": "",
      "latitude": "",
      "roles": "",
      "title": "Network Administrator",
      "sys_class_name": "customer_contact",
      "sys_id": "ddce70866f9331003b3c498f5d3ee417",
      "internal_integration_user": "false",
      "ldap_server": "",
      "mobile_phone": "+1 858 867 7857",
      "street": "",
      "company": "86837a386f0331003b3c498f5d3ee4ca",
      "department": "",
      "first_name": "George",
      "preferred_language": "",
      "introduction": "",
      "email": "geo.warren@mailinator.com",
      "manager": "",
      "locked_out": "false",
      "sys_mod_count": "3",
      "last_name": "Warren",
      "photo": "",
      "sys_tags": "",
      "middle_name": "",
      "time_zone": "",
      "schedule": "",
      "on_schedule": "",
      "date_format": "",
      "location": "25ab8e460a0a0bb300857304ff811af5",
      "account": "86837a386f0331003b3c498f5d3ee4ca"
    },
    {
      "country": "",
      "calendar_integration": "1",
      "last_position_update": "",
      "last_login_time": "2019-01-03 15:08:57",
      "last_login_device": "73.71.157.241",
      "source": "",
      "sys_updated_on": "2019-01-03 23:26:12",
      "building": "",
      "web_service_access_only": "false",
      "notification": "2",
      "sys_updated_by": "admin",
      "enable_multifactor_authn": "false",
      "sys_created_on": "2019-01-03 15:07:25",
      "sys_domain": "global",
      "agent_status": "",
      "state": "",
      "vip": "false",
      "sys_created_by": "carl.customer",
      "longitude": "",
      "zip": "",
      "home_phone": "",
      "time_format": "",
      "last_login": "",
      "default_perspective": "",
      "geolocation_tracked": "false",
      "active": "true",
      "time_sheet_policy": "",
      "sys_domain_path": "/",
      "phone": "+16692627777",
      "cost_center": "",
      "name": "Jane Contact",
      "employee_number": "",
      "gender": "",
      "city": "",
      "user_name": "Jane.Contact",
      "failed_attempts": "",
      "edu_status": "faculty",
      "latitude": "",
      "roles": "",
      "title": "",
      "sys_class_name": "customer_contact",
      "sys_id": "0a232a0013691200042ab3173244b075",
      "internal_integration_user": "false",
      "ldap_server": "",
      "mobile_phone": "",
      "street": "",
      "company": "86837a386f0331003b3c498f5d3ee4ca",
      "department": "",
      "first_name": "Jane",
      "preferred_language": "",
      "introduction": "",
      "email": "jane.contact@mailinator.com",
      "manager": "",
      "locked_out": "false",
      "sys_mod_count": "3",
      "last_name": "Contact",
      "photo": "",
      "sys_tags": "",
      "middle_name": "",
      "time_zone": "",
      "schedule": "",
      "on_schedule": "",
      "date_format": "",
      "location": "",
      "account": "86837a386f0331003b3c498f5d3ee4ca"
    }
  ]
}

Contact : GET /now/contact/{id}

Récupère le contact spécifié Gestion du service client (CSM) .

Format d'URL

URL versionnée : /api/now/{api_version}/contact/{id}

URL par défaut : /api/now/contact/{id}

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
id	Sys_id du contact à récupérer. Situé dans la table Contact [customer_contact].

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

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

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.
404	Indique que la demande n’est pas valide. Cela peut être dû à l’une des raisons suivantes : Le ticket demandé n’existe pas. L’utilisateur n’a pas accès au ticket.
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
compte	Sys_id de l’enregistrement de compte auquel le contact est associé ; Table de compte [customer_account]. Type de données : chaîne
Actif	Marqueur indiquant si le contact est actif dans le système. Valeurs possibles : true : le contact est actif false : le contact est inactif Type de données : booléennes Valeur par défaut : true
agent_status	État de l’agent. Valeurs possibles : Absent du bureau En pause En déplacement Sur site Type de données : chaîne Longueur maximale : 40
génération	Sys_id du dossier qui décrit l’immeuble dans lequel réside la personne-ressource ; Table de bâtiment [cmn_building]. Type de données : chaîne
calendar_integration	Application de calendrier que le contact utilise. 1 : Perspectives Type de données : nombre (entier) Valeur par défaut : 1
city	Ville dans laquelle réside la personne à contacter. Type de données : chaîne Longueur maximale : 40
company	Sys_id de l’enregistrement de la société auquel le contact est associé ; Table de société [core_company]. Type de données : chaîne
cost_center	Sys_id du centre de coûts associé au contact ; Table Centre de coûts [cmn_cost_center]. Type de données : chaîne
pays	Code pays du pays dans lequel le contact réside. Type de données : chaîne Longueur maximale : 3
date_format	Format dans lequel afficher les dates aux contacts. Valeurs valides : jj/mm/aaaa jj-mm-aaaa jj.mm.aaaa mm-jj-aaaa aaaa-mm-jj Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système)
default_perspective	Sys_id de la perspective par défaut pour le contact. Situé dans la table Liste des menus [sys_perspective]. Type de données : chaîne
département	Sys_id du département associé au contact. Situé dans la table Département [cmn_department]. Type de données : chaîne
edu_status	État de formation du contact associé. Type de données : chaîne Longueur maximale : 40 Par défaut : faculty
E-mail	Adresse e-mail du contact. Type de données : chaîne
employee_number	Numéro d’employé du contact. Type de données : chaîne
enable_multifactor_authn	Marqueur indiquant si l’autorisation multifacteur est requise pour que le contact se connecte au portail de services. Valeurs possibles : true : autorisation multifacteur activée false : autorisation multifacteur désactivée Type de données : booléennes Valeur par défaut : false
failed_attempts	Nombre d’échecs de tentatives de connexion. Type de données : nombre (entier)
first_name	Prénom du contact. Type de données : chaîne Longueur maximale : 50
sexe	Sexe de contact. Type de données : chaîne Longueur maximale : 40
geolocation_tracked	Marqueur indiquant si l’emplacement du contact est obtenu par géolocalisation. Valeurs possibles : true : emplacement du contact obtenu grâce à la géolocalisation false : emplacement du contact non obtenu par géolocalisation Type de données : booléennes Valeur par défaut : faux
home_phone	Numéro de téléphone du domicile du contact. Type de données : chaîne Longueur maximale : 40
internal_integration_user	Marqueur indiquant si le contact est un utilisateur d’intégration interne. Valeurs possibles : true : utilisateur d’intégration interne false : autre type d’utilisateur Type de données : booléennes Valeur par défaut : false
Introduction	Introduction Type de données : chaîne Longueur maximale : 40
last_login	Date à laquelle le contact s’est connecté pour la dernière fois au système. Type de données : chaîne (date)
last_login_device	Appareil que le consommateur a utilisé la dernière fois qu’il s’est connecté au système. Type de données : chaîne Longueur maximale : 40
last_login_time	Date et heure auxquelles le contact s’est connecté au système. Type de données : chaîne (date/heure)
last_name	Nom de famille du contact. Type de données : chaîne Longueur maximale : 50
last_position_update	Date et heure de mise à jour de la dernière position. Type de données : chaîne (date/heure)
latitude	Coordonnées de latitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
ldap_server	Sys_id du serveur LDAP utilisé par le contact pour la dernière connexion au système ; Table de serveur LDAP [ldap_server_config]. Type de données : chaîne
emplacement	Sys_id de l’enregistrement qui décrit l’emplacement de la personne-ressource ; Table d’emplacement [cmn_location]. Type de données : chaîne
locked_out	Marqueur indiquant si le contact est verrouillé. Valeurs possibles : true : contact verrouillé false : contact non verrouillé Type de données : booléennes Valeur par défaut : false
longitude	Coordonnées de longitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
responsable	Sys_id du dossier qui décrit le superviseur direct de la personne-ressource ; Table Utilisateur [sys_user]. Type de données : chaîne
middle_name	Deuxième prénom du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 50
mobile_phone	Numéro de téléphone mobile du contact. Type de données : chaîne Longueur maximale : 40
nom	Nom complet du contact. Type de données : chaîne Longueur maximale : 151
Notification	Indique si le contact doit recevoir des notifications. Valeurs valides : 1 : désactivé 2 : Activé Type de données : nombre (entier) Valeur par défaut : 2
on_schedule	Indique la ponctualité du personnel de service dépêché. Valeurs valides : En avance : en avance sur le calendrier. behind_less30 : En retard, mais moins de 30 minutes. behind_30to60 : En retard entre 30 et 60 minutes. behind_more60 : Plus de 60 minutes de retard. on_time : Comme prévu. Type de données : chaîne Longueur maximale : 40
Téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne Longueur maximale : 40
photo	Image photo du contact. Type de données : Image
preferred_language	Code du pays de la langue principale du contact. Type de données : chaîne Longueur maximale : 3
roles	Liste des rôles d’utilisateur associés au contact. Type de données : chaîne Longueur maximale : 40
schedule	Sys_id de l’enregistrement qui décrit l’horaire de travail de la personne-ressource associée ; Table de calendrier [cmn_schedule]. Type de données : chaîne
source	Source du contact. Type de données : chaîne Longueur maximale : 255
État	État dans lequel le contact réside. Type de données : chaîne Longueur maximale : 40
rue	Adresse postale du contact. Type de données : chaîne Longueur maximale : 255
sys_class_name	Table contenant l’enregistrement du contact. Type de données : chaîne Longueur maximale : 80
sys_created_by	Utilisateur ayant initialement créé l’enregistrement de contact associé. Type de données : chaîne Longueur maximale : 40
sys_created_on	Les données et l’heure auxquelles le contact associé a été créé à l’origine. Type de données : chaîne (date/heure)
sys_domain	ServiceNow Domaine d’instance de l’enregistrement de contact associé. Type de données : chaîne
sys_domain_path	Chemin de domaine de l’enregistrement du contact. Type de données : chaîne Longueur maximale : 255 Par défaut : / (global)
sys_id	Identificateur unique pour l’enregistrement de contact associé. Type de données : chaîne
sys_mod_count	Nombre de fois où l’enregistrement de contact associé a été modifié. Type de données : nombre (entier)
sys_updated_by	Utilisateur qui a mis à jour les informations de contact associées en dernier. Type de données : chaîne Longueur maximale : 40
sys_updated_on	Données et heure auxquelles les informations de contact associées ont été mises à jour. Type de données : chaîne (date/heure)
time_format	Format dans lequel afficher l’heure. Valeurs valides : hh.mm.ss : hh.mm.ss (12 heures) hh :mm :ss a : hh :mm :ss (12 heures) HH.mm.ss : hh.mm.ss (24 heures) HH :mm :ss : hh :mm :ss (24 heures) Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d’heure système)
time_sheet_policy	Sys_id de l’enregistrement qui contient la politique de feuille de temps pour le contact associé ; Table de la politique de feuille de temps [time_sheet_policy]. Type de données : chaîne
time_zone	Fuseau horaire dans lequel la personne à contacter réside, par exemple Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du contact tel que Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60
user_name	ID de l’utilisateur du contact. Type de données : chaîne Longueur maximale : 40
Vip	Marqueur indiquant si le contact associé a le statut VIP. Valeurs possibles : vrai : VIP faux : pas VIP Type de données : booléennes Valeur par défaut : false
web_service_access_only	Marqueur indiquant si le contact peut accéder aux services uniquement via le Web. Valeurs possibles : true : accès Web uniquement false : accès via toutes les méthodes disponibles Type de données : booléennes Valeur par défaut : false
code postal	Code postal du contact. Type de données : chaîne Longueur maximale : 40

Demande cURL

curl "https://instance.servicenow.com/api/now/contact/ddce70866f9331003b3c498f5d3ee417 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "country": "",
    "calendar_integration": "1",
    "last_position_update": "",
    "last_login_time": "2018-03-10 21:48:11",
    "last_login_device": "",
    "source": "",
    "sys_updated_on": "2019-01-03 05:49:34",
    "building": "",
    "web_service_access_only": "false",
    "notification": "2",
    "sys_updated_by": "system",
    "enable_multifactor_authn": "false",
    "sys_created_on": "2018-03-04 20:26:32",
    "sys_domain": "global",
    "agent_status": "",
    "state": "",
    "vip": "false",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "",
    "home_phone": "",
    "time_format": "",
    "last_login": "",
    "default_perspective": "",
    "geolocation_tracked": "false",
    "active": "true",
    "time_sheet_policy": "",
    "sys_domain_path": "/",
    "phone": "+1 858 287 7834",
    "cost_center": "",
    "name": "George Warren",
    "employee_number": "",
    "gender": "",
    "city": "",
    "user_name": "george.warren",
    "failed_attempts": "",
    "edu_status": "",
    "latitude": "",
    "roles": "",
    "title": "Network Administrator",
    "sys_class_name": "customer_contact",
    "sys_id": "ddce70866f9331003b3c498f5d3ee417",
    "internal_integration_user": "false",
    "ldap_server": "",
    "mobile_phone": "+1 858 867 7857",
    "street": "",
    "company": "86837a386f0331003b3c498f5d3ee4ca",
    "department": "",
    "first_name": "George",
    "preferred_language": "",
    "introduction": "",
    "email": "geo.warren@mailinator.com",
    "manager": "",
    "locked_out": "false",
    "sys_mod_count": "3",
    "last_name": "Warren",
    "photo": "",
    "sys_tags": "",
    "middle_name": "",
    "time_zone": "",
    "schedule": "",
    "on_schedule": "",
    "date_format": "",
    "location": "25ab8e460a0a0bb300857304ff811af5",
    "account": "86837a386f0331003b3c498f5d3ee4ca"
  }
}

Contact : POST /now/contact

Crée un nouveau Gestion du service client (CSM) contact.

En outre, vous pouvez créer un profil de réseau social pour le contact à l’aide de ce point de terminaison. Pour créer le profil, vous devez spécifier les paramètres suivants dans le corps de la demande :

social_channel
social_handle
social_handle_url

Avertissement :

Ce point de terminaison n’effectue pas la validation des paramètres, car cela peut créer une surcharge excessive. Si un paramètre de demande est mal orthographié, n’est pas valide ou n’est pas pris en charge par le point de terminaison, il est ignoré sans avertissement.

Format d'URL

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

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

Paramètres de demande pris en charge

Tableau 13. 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 14. Paramètres de requête
Nom	Description
Aucun

Tableau 15. Paramètres de corps de demande (XML ou JSON)
Élément	Description
compte	Sys_id de l’enregistrement de compte auquel le contact est associé ; Table de compte [customer_account]. Type de données : chaîne
Actif	Marqueur indiquant si le contact est actif dans le système. Valeurs possibles : true : le contact est actif false : le contact est inactif Type de données : booléennes Valeur par défaut : true
agent_status	État de l’agent. Valeurs possibles : Absent du bureau En pause En déplacement Sur site Type de données : chaîne Longueur maximale : 40
génération	Sys_id du dossier qui décrit l’immeuble dans lequel réside la personne-ressource ; Table de bâtiment [cmn_building]. Type de données : chaîne
calendar_integration	Application de calendrier que le contact utilise. 1 : Perspectives Type de données : nombre (entier) Valeur par défaut : 1
city	Ville dans laquelle réside la personne à contacter. Type de données : chaîne Longueur maximale : 40
company	Sys_id de l’enregistrement de la société auquel le contact est associé ; Table de société [core_company]. Type de données : chaîne
cost_center	Sys_id du centre de coûts associé au contact ; Table Centre de coûts [cmn_cost_center]. Type de données : chaîne
pays	Code pays du pays dans lequel le contact réside. Type de données : chaîne Longueur maximale : 3
date_format	Format dans lequel afficher les dates aux contacts. Valeurs valides : jj/mm/aaaa jj-mm-aaaa jj.mm.aaaa mm-jj-aaaa aaaa-mm-jj Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format de date système)
default_perspective	Sys_id de la perspective par défaut pour le contact. Situé dans la table Liste des menus [sys_perspective]. Type de données : chaîne
département	Sys_id du département associé au contact. Situé dans la table Département [cmn_department]. Type de données : chaîne
edu_status	État de formation du contact associé. Type de données : chaîne Longueur maximale : 40 Par défaut : faculty
E-mail	Adresse e-mail du contact. Type de données : chaîne
employee_number	Numéro d’employé du contact. Type de données : chaîne
enable_multifactor_authn	Marqueur indiquant si l’autorisation multifacteur est requise pour que le contact se connecte au portail de services. Valeurs possibles : true : autorisation multifacteur activée false : autorisation multifacteur désactivée Type de données : booléennes Valeur par défaut : false
failed_attempts	Nombre d’échecs de tentatives de connexion. Type de données : nombre (entier)
first_name	Prénom du contact. Type de données : chaîne Longueur maximale : 50
sexe	Sexe de contact. Type de données : chaîne Longueur maximale : 40
geolocation_tracked	Marqueur indiquant si l’emplacement du contact est obtenu par géolocalisation. Valeurs possibles : true : emplacement du contact obtenu grâce à la géolocalisation false : emplacement du contact non obtenu par géolocalisation Type de données : booléennes Valeur par défaut : faux
home_phone	Numéro de téléphone du domicile du contact. Type de données : chaîne Longueur maximale : 40
internal_integration_user	Marqueur indiquant si le contact est un utilisateur d’intégration interne. Valeurs possibles : true : utilisateur d’intégration interne false : autre type d’utilisateur Type de données : booléennes Valeur par défaut : false
Introduction	Introduction Type de données : chaîne Longueur maximale : 40
last_login_device	Appareil que le consommateur a utilisé la dernière fois qu’il s’est connecté au système. Type de données : chaîne Longueur maximale : 40
last_login_time	Date et heure auxquelles le contact s’est connecté au système. Type de données : chaîne (date/heure)
last_name	Nom de famille du contact. Type de données : chaîne Longueur maximale : 50
latitude	Coordonnées de latitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
ldap_server	Sys_id du serveur LDAP utilisé par le contact pour la dernière connexion au système ; Table de serveur LDAP [ldap_server_config]. Type de données : chaîne
emplacement	Sys_id de l’enregistrement qui décrit l’emplacement de la personne-ressource ; Table d’emplacement [cmn_location]. Type de données : chaîne
locked_out	Marqueur indiquant si le contact est verrouillé. Valeurs possibles : true : contact verrouillé false : contact non verrouillé Type de données : booléennes Valeur par défaut : false
longitude	Coordonnées de longitude du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 40
responsable	Sys_id du dossier qui décrit le superviseur direct de la personne-ressource ; Table Utilisateur [sys_user]. Type de données : chaîne
middle_name	Deuxième prénom du contact. Type de données : Nombre (virgule flottante) Longueur maximale : 50
mobile_phone	Numéro de téléphone mobile du contact. Type de données : chaîne Longueur maximale : 40
nom	Nom complet du contact. Type de données : chaîne Longueur maximale : 151
Notification	Indique si le contact doit recevoir des notifications. Valeurs valides : 1 : désactivé 2 : Activé Type de données : nombre (entier) Valeur par défaut : 2
on_schedule	Indique la ponctualité du personnel de service dépêché. Valeurs valides : En avance : en avance sur le calendrier. behind_less30 : En retard, mais moins de 30 minutes. behind_30to60 : En retard entre 30 et 60 minutes. behind_more60 : Plus de 60 minutes de retard. on_time : Comme prévu. Type de données : chaîne Longueur maximale : 40
Téléphone	Numéro de téléphone professionnel du contact. Type de données : chaîne Longueur maximale : 40
photo	Image photo du contact. Type de données : Image
preferred_language	Code du pays de la langue principale du contact. Type de données : chaîne Longueur maximale : 3
roles	Liste des rôles d’utilisateur associés au contact. Type de données : chaîne Longueur maximale : 40
schedule	Sys_id de l’enregistrement qui décrit l’horaire de travail de la personne-ressource associée ; Table de calendrier [cmn_schedule]. Type de données : chaîne
social_channel	Canal de médias sociaux auquel le contact est associé, tel que Twitter, Facebook ou Instagram. Type de données : chaîne
social_handle	Descripteur de l’utilisateur sur le canal de médias sociaux. Type de données : chaîne
social_handle_url	URL du profil de canal social du contact. Type de données : chaîne
source	Source du contact. Type de données : chaîne Longueur maximale : 255
État	État dans lequel le contact réside. Type de données : chaîne Longueur maximale : 40
rue	Adresse postale du contact. Type de données : chaîne Longueur maximale : 255
time_format	Format dans lequel afficher l’heure. Valeurs valides : hh.mm.ss : hh.mm.ss (12 heures) hh :mm :ss a : hh :mm :ss (12 heures) HH.mm.ss : hh.mm.ss (24 heures) HH :mm :ss : hh :mm :ss (24 heures) Type de données : chaîne Longueur maximale : 40 Par défaut : vide (format d’heure système)
time_sheet_policy	Sys_id de l’enregistrement qui contient la politique de feuille de temps pour le contact associé ; Table de la politique de feuille de temps [time_sheet_policy]. Type de données : chaîne
time_zone	Fuseau horaire dans lequel la personne à contacter réside, par exemple Canada/Centre ou États-Unis/Est. Type de données : chaîne Longueur maximale : 40
Titre	Titre de l’entreprise du contact tel que Gestionnaire, Développeur de logiciels ou Prestataire. Type de données : chaîne Longueur maximale : 60
user_name	ID de l’utilisateur du contact. Type de données : chaîne Longueur maximale : 40
Vip	Marqueur indiquant si le contact associé a le statut VIP. Valeurs possibles : vrai : VIP faux : pas VIP Type de données : booléennes Valeur par défaut : false
web_service_access_only	Marqueur indiquant si le contact peut accéder aux services uniquement via le Web. Valeurs possibles : true : accès Web uniquement false : accès via toutes les méthodes disponibles Type de données : booléennes Valeur par défaut : false
code postal	Code postal du contact. Type de données : chaîne Longueur maximale : 40

En-têtes

Tableau 16. 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 17. 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 18. Codes d'état
Code d'état	Description
201	Un nouvel enregistrement de contact a été créé 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 de logique s’est produite sur le code côté serveur.

Paramètres du corps de réponse (JSON ou XML)


Élément	Description
résultat	Sys_id de l’enregistrement de contact nouvellement créé. Type de données : chaîne

Demande cURL

curl -X POST "https://instance.servicenow.com/api/now/contact" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{ \
  "country": "USA", \
  "calendar_integration": "1", \
  "last_login_time": "2018-03-10 21:48:11", \
  "last_login_device": "tablet", \
  "building": "Cardinal West", \
  "web_service_access_only": "false", \
  "notification": "1", \
  "enable_multifactor_authn": "true", \
  "agent_status": "Travelling", \
  "state": "CA", \
  "vip": "false", \
  "longitude": "123.76", \
  "zip": "92069", \
  "home_phone": "(555)555-1234", \
  "time_format": "hh:mm:ss", \
  "geolocation_tracked": "false", \
  "active": "true", \
  "phone": "+1 858 287 7834", \
  "cost_center": "1345", \
  "name": "Dora Warren", \
  "employee_number": "546", \
  "gender": "Female", \
  "city": "Orlando", \
  "user_name": "dora.warren", \
  "failed_attempts": "2", \
  "edu_status": "current", \
  "latitude": "57.6", \
  "title": "Network Administrator", \
  "internal_integration_user": "false", \
  "ldap_server": "10.24.23.123", \
  "mobile_phone": "+1 858 867 7857", \
  "street": "123 Lagume", \
  "company": "86837a386f0331003b3c498f5d3ee4ca", \
  "department": "IT", \
  "first_name": "Dora", \
  "preferred_language": "Spanish", \
  "email": "dora.warren@mailinator.com", \
  "manager": "ddce70866f9331003b3c498f5d3ee417", \
  "locked_out": "false", \
  "last_name": "Warren", \
  "middle_name": "Dell", \
  "time_zone": "PST", \
  "schedule": "9-5", \
  "date_format": "MM/DD/YY", \
  "location": "25ab8e460a0a0bb300857304ff811af5", \
  "account": "86837a386f0331003b3c498f5d3ee4ca" \
}'
--user 'username':'password'

"result": "62fe1c97db76c3006b7a9646db961999"