Kontakt-API
Die Kontakt- API bietet Endpunkte, mit denen Sie Kundenservice-Management (Customer Service Management, CSM) Kontaktdatensätze abrufen und aktualisieren können.
Darüber hinaus können Sie beim Erstellen eines Kontakts neue Social Media-Profildatensätze generieren.
Die Kontakt -API erfordert das Plugin „Customer Service“ (com.sn_customerservice) und wird im Now-Namespace bereitgestellt.
Benutzer benötigen die Rolle csm_ws_integration für vollständigen API-Zugriff.
Kontakt: GET /now/contact
Ruft einen angegebenen Satz von Kundenservice-Management (Customer Service Management, CSM) Kontakten ab.
URL-Format
Versionierte URL: /api/now/{api_version}/contact
Standard-URL: /api/now/contact
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| sysparm_limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. In der Antwort wird der boolesche Parameter hasMore zurückgegeben. Gibt an, ob weitere Datensätze zurückzugeben sind, die die Filterkriterien erfüllen. Datentyp: Zahl Standard: 10 |
| sysparm_offset | Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie Übergeben Sie keine negative Zahl im Parameter sysparm_offset. Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage zum Filtern der Ergebnismenge. Beispiel:
Die codierte Abfrage unterstützt Sortieren nach. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Zum Beispiel filtert Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle benutzerdefinierten Felder zurück, die der Kontakttabelle [customer_contact] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition [].
| Element | Beschreibung |
|---|---|
| Account | Sys_id des Account-Datensatzes, dem der Kontakt zugeordnet ist; Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: true |
| agent_status | Status des Service Desk-Mitarbeiters. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Gebäude | Sys_id des Datensatzes, der das Gebäude beschreibt, in dem sich der Kontakt befindet; Tabelle „Gebäude“ [cmn_building]. Datentyp: Zeichenfolge |
| calendar_integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Integer) Standard: 1 |
| city | Stadt, in der sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Unternehmen | Sys_id des Unternehmensdatensatzes, dem der Kontakt zugeordnet ist; Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| cost_center | Sys_id der Kostenstelle, die dem Kontakt zugeordnet ist; Tabelle „Kostenstelle“ [cmn_cost_center]. Datentyp: Zeichenfolge |
| country | Ländercode des Landes, in dem sich der Kontakt befindet. Datentyp: Zeichenfolge Maximale Länge: 3 |
| date_format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) |
| default_perpektive | Sys_id der Standardperspektive für den Kontakt. Befindet sich in der Tabelle „Menüliste“ [sys_perpektive]. Datentyp: Zeichenfolge |
| department | Sys_id der Abteilung, die dem Kontakt zugeordnet ist. Befindet sich in der Tabelle „Abteilung“ [cmn_department]. Datentyp: Zeichenfolge |
| edu_status | Bildungsstatus des zugeordneten Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fachbereich |
| Kontakt-E-Mail-Adresse. Datentyp: Zeichenfolge |
|
| employee_number | Mitarbeiternummer des Kontakts. Datentyp: Zeichenfolge |
| enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Service Portal anmelden kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Integer) |
| first_name | Kontaktvorname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| geolocation_tracked | Kennzeichnung, die angibt, ob der Kontaktstandort durch Geotracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Private Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| „internal_integration_user“ | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsbenutzer ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Einführung | Einführung Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login | Datum, an dem sich der Kontakt zuletzt beim System angemeldet hat. Datentyp: Zeichenfolge (Datum) |
| last_login_device | Gerät, das der Verbraucher bei der letzten Anmeldung beim System verwendet hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login_time | Datum und Uhrzeit, zu der sich der Kontakt beim System angemeldet hat. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Kontaktnachname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| last_position_update | Datum und Uhrzeit der Aktualisierung der letzten Position. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| latitude | Breitengradkoordinate des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| ldap_server | Sys_id des LDAP-Servers, der vom Kontakt für die letzte Anmeldung beim System verwendet wurde; Tabelle „LDAP-Server“ [ldap_server_config]. Datentyp: Zeichenfolge |
| location | Sys_id des Datensatzes, der den Standort des Kontakts beschreibt; Standorttabelle [cmn_location]. Datentyp: Zeichenfolge |
| locked_out | Kennzeichnung, die angibt, ob der Kontakt ausgesperrt ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| longitude | Längengradkoordinate des Kontakts. Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| Manager | Sys_id des Datensatzes, der den direkten Vorgesetzten des Kontakts beschreibt; Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| Middle_name | Zweiter Vorname des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Name | Vollständiger Name des Kontakts Datentyp: Zeichenfolge Maximale Länge: 151 |
| Benachrichtigung | Gibt an, ob der Kontakt Benachrichtigungen erhalten soll. Gültige Werte:
Datentyp: Zahl (Integer) Standardwert: 2 |
| on_schedule | Gibt die Pünktlichkeit des entsandten Servicepersonals an. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Telefon | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Foto | Foto des Kontakts. Datentyp: Bild |
| preferred_language | Ländercode der primären Kontaktsprache. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Benutzerrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | Sys_id des Datensatzes, der den Arbeitszeitplan für den zugeordneten Kontakt beschreibt; Zeitplantabelle [cmn_schedule]. Datentyp: Zeichenfolge |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Bundesstaat, in dem sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Straße | Straße und Hausnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| sys_class_name | Tabelle, die den Kontaktdatensatz enthält. Datentyp: Zeichenfolge Maximale Länge: 80 |
| sys_created_by | Benutzer, der den zugeordneten Kontaktdatensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit, zu der der zugeordnete Kontakt ursprünglich erstellt wurde. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| sys_domain | ServiceNow Instanzdomäne des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge |
| sys_domain_path | Domänenpfad des Kontaktdatensatzes Datentyp: Zeichenfolge Maximale Länge: 255 Standard: / (global) |
| sys_id | Eindeutiger Bezeichner für den zugeordneten Kontaktdatensatz. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Änderungen des zugeordneten Kontaktdatensatzes. Datentyp: Zahl (Integer) |
| sys_tags | System-Tags. Datentyp: Zeichenfolge |
| sys_updated_by | Benutzer, der die zugeordneten Kontaktinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der Aktualisierung der zugeordneten Kontaktinformationen. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| [time_sheet_policy] | Sys_id des Datensatzes, der die Stundennachweisrichtlinie für den zugeordneten Kontakt enthält; Tabelle „Stundennachweisrichtlinie“ [time_sheet_policy]. Datentyp: Zeichenfolge |
| time_zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftsbezeichnung des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Anwender-ID des Kontakts Datentyp: Zeichenfolge Maximale Länge: 40 |
| VIP | Kennzeichnung, die angibt, ob der zugeordnete Kontakt den VIP-Status hat. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| web_service_access_only | Kennzeichnung, die angibt, ob der Kontakt nur über das Internet auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Kontakt-Postleitzahl. Datentyp: Zeichenfolge Maximale Länge: 40 |
cURL-Anforderung
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"
}
]
}
Kontakt – GET /now/contact/{id}
Ruft den angegebenen Kundenservice-Management (Customer Service Management, CSM) Kontakt ab.
URL-Format
Versionierte URL: /api/now/{api_version}/contact/{id}
Standard-URL: /api/now/contact/{id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| id | Sys_id des abzurufenden Kontakts. Befindet sich in der Kontakttabelle [customer_contact]. |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Gibt an, dass die Anforderung ungültig ist. Möglicherweise liegt einer der folgenden Gründe vor:
|
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
Der Endpunkt kann die folgenden JSON- oder XML-Elemente im Antworttext zurückgeben. Zusätzlich zur Liste der unten definierten Elemente (die die Elemente in einem Basissystem definieren) gibt der Endpunkt auch alle benutzerdefinierten Felder zurück, die der Kontakttabelle [customer_contact] hinzugefügt wurden. Weitere Informationen zu diesen Elementen finden Sie in Ihrer spezifischen Tabellendefinition [].
| Element | Beschreibung |
|---|---|
| Account | Sys_id des Account-Datensatzes, dem der Kontakt zugeordnet ist; Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: true |
| agent_status | Status des Service Desk-Mitarbeiters. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Gebäude | Sys_id des Datensatzes, der das Gebäude beschreibt, in dem sich der Kontakt befindet; Tabelle „Gebäude“ [cmn_building]. Datentyp: Zeichenfolge |
| calendar_integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Integer) Standard: 1 |
| city | Stadt, in der sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Unternehmen | Sys_id des Unternehmensdatensatzes, dem der Kontakt zugeordnet ist; Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| cost_center | Sys_id der Kostenstelle, die dem Kontakt zugeordnet ist; Tabelle „Kostenstelle“ [cmn_cost_center]. Datentyp: Zeichenfolge |
| country | Ländercode des Landes, in dem sich der Kontakt befindet. Datentyp: Zeichenfolge Maximale Länge: 3 |
| date_format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) |
| default_perpektive | Sys_id der Standardperspektive für den Kontakt. Befindet sich in der Tabelle „Menüliste“ [sys_perpektive]. Datentyp: Zeichenfolge |
| department | Sys_id der Abteilung, die dem Kontakt zugeordnet ist. Befindet sich in der Tabelle „Abteilung“ [cmn_department]. Datentyp: Zeichenfolge |
| edu_status | Bildungsstatus des zugeordneten Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fachbereich |
| Kontakt-E-Mail-Adresse. Datentyp: Zeichenfolge |
|
| employee_number | Mitarbeiternummer des Kontakts. Datentyp: Zeichenfolge |
| enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Service Portal anmelden kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Integer) |
| first_name | Kontaktvorname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| geolocation_tracked | Kennzeichnung, die angibt, ob der Kontaktstandort durch Geotracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Private Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| „internal_integration_user“ | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsbenutzer ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Einführung | Einführung Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login | Datum, an dem sich der Kontakt zuletzt beim System angemeldet hat. Datentyp: Zeichenfolge (Datum) |
| last_login_device | Gerät, das der Verbraucher bei der letzten Anmeldung beim System verwendet hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login_time | Datum und Uhrzeit, zu der sich der Kontakt beim System angemeldet hat. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Kontaktnachname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| last_position_update | Datum und Uhrzeit der Aktualisierung der letzten Position. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| latitude | Breitengradkoordinate des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| ldap_server | Sys_id des LDAP-Servers, der vom Kontakt für die letzte Anmeldung beim System verwendet wurde; Tabelle „LDAP-Server“ [ldap_server_config]. Datentyp: Zeichenfolge |
| location | Sys_id des Datensatzes, der den Standort des Kontakts beschreibt; Standorttabelle [cmn_location]. Datentyp: Zeichenfolge |
| locked_out | Kennzeichnung, die angibt, ob der Kontakt ausgesperrt ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| longitude | Längengradkoordinate des Kontakts. Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| Manager | Sys_id des Datensatzes, der den direkten Vorgesetzten des Kontakts beschreibt; Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| Middle_name | Zweiter Vorname des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Name | Vollständiger Name des Kontakts Datentyp: Zeichenfolge Maximale Länge: 151 |
| Benachrichtigung | Gibt an, ob der Kontakt Benachrichtigungen erhalten soll. Gültige Werte:
Datentyp: Zahl (Integer) Standardwert: 2 |
| on_schedule | Gibt die Pünktlichkeit des entsandten Servicepersonals an. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Telefon | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Foto | Foto des Kontakts. Datentyp: Bild |
| preferred_language | Ländercode der primären Kontaktsprache. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Benutzerrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | Sys_id des Datensatzes, der den Arbeitszeitplan für den zugeordneten Kontakt beschreibt; Zeitplantabelle [cmn_schedule]. Datentyp: Zeichenfolge |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Bundesstaat, in dem sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Straße | Straße und Hausnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| sys_class_name | Tabelle, die den Kontaktdatensatz enthält. Datentyp: Zeichenfolge Maximale Länge: 80 |
| sys_created_by | Benutzer, der den zugeordneten Kontaktdatensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit, zu der der zugeordnete Kontakt ursprünglich erstellt wurde. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| sys_domain | ServiceNow Instanzdomäne des zugeordneten Kontaktdatensatzes. Datentyp: Zeichenfolge |
| sys_domain_path | Domänenpfad des Kontaktdatensatzes Datentyp: Zeichenfolge Maximale Länge: 255 Standard: / (global) |
| sys_id | Eindeutiger Bezeichner für den zugeordneten Kontaktdatensatz. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Änderungen des zugeordneten Kontaktdatensatzes. Datentyp: Zahl (Integer) |
| sys_updated_by | Benutzer, der die zugeordneten Kontaktinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der Aktualisierung der zugeordneten Kontaktinformationen. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| [time_sheet_policy] | Sys_id des Datensatzes, der die Stundennachweisrichtlinie für den zugeordneten Kontakt enthält; Tabelle „Stundennachweisrichtlinie“ [time_sheet_policy]. Datentyp: Zeichenfolge |
| time_zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftsbezeichnung des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Anwender-ID des Kontakts Datentyp: Zeichenfolge Maximale Länge: 40 |
| VIP | Kennzeichnung, die angibt, ob der zugeordnete Kontakt den VIP-Status hat. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| web_service_access_only | Kennzeichnung, die angibt, ob der Kontakt nur über das Internet auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Kontakt-Postleitzahl. Datentyp: Zeichenfolge Maximale Länge: 40 |
cURL-Anforderung
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"
}
}
Kontakt: POST /now/contact
Erstellt einen neuen Kundenservice-Management (Customer Service Management, CSM) Kontakt.
- social_channel
- social_handle
- social_handle_url
URL-Format
Versionierte URL: /api/now/{api_version}/contact
Standard-URL: /api/now/contact
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Element | Beschreibung |
|---|---|
| Account | Sys_id des Account-Datensatzes, dem der Kontakt zugeordnet ist; Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: true |
| agent_status | Status des Service Desk-Mitarbeiters. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Gebäude | Sys_id des Datensatzes, der das Gebäude beschreibt, in dem sich der Kontakt befindet; Tabelle „Gebäude“ [cmn_building]. Datentyp: Zeichenfolge |
| calendar_integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Integer) Standard: 1 |
| city | Stadt, in der sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Unternehmen | Sys_id des Unternehmensdatensatzes, dem der Kontakt zugeordnet ist; Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| cost_center | Sys_id der Kostenstelle, die dem Kontakt zugeordnet ist; Tabelle „Kostenstelle“ [cmn_cost_center]. Datentyp: Zeichenfolge |
| country | Ländercode des Landes, in dem sich der Kontakt befindet. Datentyp: Zeichenfolge Maximale Länge: 3 |
| date_format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: leer (Systemdatumsformat) |
| default_perpektive | Sys_id der Standardperspektive für den Kontakt. Befindet sich in der Tabelle „Menüliste“ [sys_perpektive]. Datentyp: Zeichenfolge |
| department | Sys_id der Abteilung, die dem Kontakt zugeordnet ist. Befindet sich in der Tabelle „Abteilung“ [cmn_department]. Datentyp: Zeichenfolge |
| edu_status | Bildungsstatus des zugeordneten Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fachbereich |
| Kontakt-E-Mail-Adresse. Datentyp: Zeichenfolge |
|
| employee_number | Mitarbeiternummer des Kontakts. Datentyp: Zeichenfolge |
| enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Service Portal anmelden kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Integer) |
| first_name | Kontaktvorname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| geolocation_tracked | Kennzeichnung, die angibt, ob der Kontaktstandort durch Geotracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Private Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| „internal_integration_user“ | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsbenutzer ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Einführung | Einführung Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login_device | Gerät, das der Verbraucher bei der letzten Anmeldung beim System verwendet hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| last_login_time | Datum und Uhrzeit, zu der sich der Kontakt beim System angemeldet hat. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Kontaktnachname. Datentyp: Zeichenfolge Maximale Länge: 50 |
| latitude | Breitengradkoordinate des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| ldap_server | Sys_id des LDAP-Servers, der vom Kontakt für die letzte Anmeldung beim System verwendet wurde; Tabelle „LDAP-Server“ [ldap_server_config]. Datentyp: Zeichenfolge |
| location | Sys_id des Datensatzes, der den Standort des Kontakts beschreibt; Standorttabelle [cmn_location]. Datentyp: Zeichenfolge |
| locked_out | Kennzeichnung, die angibt, ob der Kontakt ausgesperrt ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| longitude | Längengradkoordinate des Kontakts. Datentyp: Zahl (Gleitkomma) Maximale Länge: 40 |
| Manager | Sys_id des Datensatzes, der den direkten Vorgesetzten des Kontakts beschreibt; Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| Middle_name | Zweiter Vorname des Kontakts Datentyp: Zahl (Gleitkomma) Maximale Länge: 50 |
| mobile_phone | Mobiltelefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Name | Vollständiger Name des Kontakts Datentyp: Zeichenfolge Maximale Länge: 151 |
| Benachrichtigung | Gibt an, ob der Kontakt Benachrichtigungen erhalten soll. Gültige Werte:
Datentyp: Zahl (Integer) Standardwert: 2 |
| on_schedule | Gibt die Pünktlichkeit des entsandten Servicepersonals an. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| Telefon | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Foto | Foto des Kontakts. Datentyp: Bild |
| preferred_language | Ländercode der primären Kontaktsprache. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Benutzerrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | Sys_id des Datensatzes, der den Arbeitszeitplan für den zugeordneten Kontakt beschreibt; Zeitplantabelle [cmn_schedule]. Datentyp: Zeichenfolge |
| Social_Channel | Social Media-Kanal, dem der Kontakt zugeordnet ist, z. B. Twitter, Facebook oder Instagram. Datentyp: Zeichenfolge |
| „social_handle“. | Benutzer-Handle im Social Media-Kanal. Datentyp: Zeichenfolge |
| „social_handle_url“. | URL zum Social-Media-Kanalprofil des Kontakts. Datentyp: Zeichenfolge |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Bundesstaat, in dem sich der Kontakt befindet Datentyp: Zeichenfolge Maximale Länge: 40 |
| Straße | Straße und Hausnummer des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| time_format | Format, in dem die Zeit angezeigt werden soll. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemzeitformat) |
| [time_sheet_policy] | Sys_id des Datensatzes, der die Stundennachweisrichtlinie für den zugeordneten Kontakt enthält; Tabelle „Stundennachweisrichtlinie“ [time_sheet_policy]. Datentyp: Zeichenfolge |
| time_zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftsbezeichnung des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Anwender-ID des Kontakts Datentyp: Zeichenfolge Maximale Länge: 40 |
| VIP | Kennzeichnung, die angibt, ob der zugeordnete Kontakt den VIP-Status hat. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| web_service_access_only | Kennzeichnung, die angibt, ob der Kontakt nur über das Internet auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Kontakt-Postleitzahl. Datentyp: Zeichenfolge Maximale Länge: 40 |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 201 | Neuer Kontaktdatensatz wurde erfolgreich erstellt. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten. |
Antworttextparameter (JSON oder XML)
| Element | Beschreibung |
|---|---|
| Ergebnis | Sys_id des neu erstellten Kontaktdatensatzes. Datentyp: Zeichenfolge |
cURL-Anforderung
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"