Kontakt-API
Die Kontakt Die API stellt Endpunkte bereit, mit denen Sie sie abrufen und aktualisieren können Kundenservice-Management (CSM) Kontaktdatensätze.
Darüber hinaus können Sie beim Erstellen eines Kontakts neue Social Media-Profildatensätze generieren.
Die Kontakt API erfordert das Kundenservice-Plugin (com.sn_customerservice) und wird in bereitgestellt Jetzt Namespace.
Anwender benötigen die Rolle „csm_WS_Integration“ für vollständigen API-Zugriff.
Kontakt – GET /now/contact
Ruft einen angegebenen Satz von ab Kundenservice-Management (CSM) Kontakte.
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. 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 zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. In der Antwort der boolesche Parameter hasMoreWird zurückgegeben. Gibt an, ob weitere zurückzugebende Datensätze vorhanden sind, die die Filterkriterien erfüllen. Datentyp: Zahl Standard: 10 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage, die zum Filtern des Ergebnissatzes verwendet wird. Zum Beispiel:
Die codierte Abfrage unterstützt Sortieren nach . Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie SORTIEREN NACH Und ORDERBYDESC Klauseln in sysparm_query. Beispiel: Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Sie können dieses Verhalten mithilfe der Eigenschaft steuern glide.invalid_query.returns_no_rows. Legen Sie diese Eigenschaft auf „wahr“ fest, um keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (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 anwenderdefinierten Felder zurück, die der Tabelle „Kontakt“ [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. Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| 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. Datentyp: Zeichenfolge Tabelle: Gebäude [cmn_Building] |
| Calendar_Integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Ganzzahl) 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. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Kostenstelle | SYS_ID der Kostenstelle, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Kostenstelle [cmn_Cost_Center] |
| country | Ländercode des Landes, in dem der Kontakt ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Datum_Format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| Default_perspective | SYS_ID der Standardperspektive für den Kontakt. Datentyp: Zeichenfolge Tabelle: Menüliste [sys_perspective] |
| department | SYS_ID der Abteilung, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Abteilung [cmn_Department] |
| edu_Status | Bildungsstatus des zugehörigen Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fakultät |
| E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge |
|
| Employee_number | Kontaktmitarbeiternummer. Datentyp: Zeichenfolge |
| Enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Serviceportal anmeldet. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Ganzzahl) |
| first_name | Vorname des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Positionsbestimmung_nachverfolgt | Kennzeichnung, die angibt, ob der Kontaktstandort über GeoTracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Telefonnummer des Kontakts (privat). Datentyp: Zeichenfolge Maximale Länge: 40 |
| Internal_Integration_user | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsanwender 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 der Anmeldung des Kontakts beim System. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Nachname des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Last_Position_Update | Datum und Uhrzeit der letzten Aktualisierung der 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 verwendet wurde, um sich zuletzt beim System anzumelden. Datentyp: Zeichenfolge Tabelle: LDAP-Server [ldap_Server_config] |
| location | SYS_ID des Datensatzes, der den Standort des Kontakts beschreibt Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] |
| Gesperrt_out | Kennzeichnung, die angibt, ob der Kontakt gesperrt 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. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| 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 (Ganzzahl) Standard: 2 |
| On_schedule | Gibt die Aktualität 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: Zeichenfolge |
| Preferred_language | Ländercode der primären Sprache des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Anwenderrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | SYS_ID des Datensatzes, der den Arbeitszeitplan für den zugehörigen Kontakt beschreibt. Datentyp: Zeichenfolge Tabelle: Zeitplan [cmn_schedule] |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Status, 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 | Anwender, der ursprünglich den zugehörigen Kontaktdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Daten und Uhrzeit der ursprünglichen Erstellung des zugehörigen Kontakts. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| sys_Domain | ServiceNow Instanzdomäne des zugehörigen 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 zugehörigen Kontaktdatensatz. Datentyp: Zeichenfolge |
| sys_mod_count | Gibt an, wie oft der zugeordnete Kontaktdatensatz geändert wurde. Datentyp: Zahl (Ganzzahl) |
| sys_Tags | System-Tags. Datentyp: Zeichenfolge |
| sys_updated_by | Anwender, der die zugehörigen Kontaktinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Daten und Uhrzeit der Aktualisierung der zugehörigen 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 Zeitnachweisrichtlinie für den zugehörigen Kontakt enthält. Datentyp: Zeichenfolge Tabelle: Zeitnachweisrichtlinie [time_sheet_Policy] |
| Time_Zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Kontaktanwender-ID. 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 Web auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Postleitzahl des Kontakts. 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 die angegebene ab Kundenservice-Management (CSM) Kontakt.
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. 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. Datentyp: Zeichenfolge Tabelle: Kontakt [Customer_contact] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Gibt an, dass die Anforderung ungültig ist. Dies kann aus einem der folgenden Gründe liegen:
|
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (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 anwenderdefinierten Felder zurück, die der Tabelle „Kontakt“ [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. Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| 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. Datentyp: Zeichenfolge Tabelle: Gebäude [cmn_Building] |
| Calendar_Integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Ganzzahl) 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. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Kostenstelle | SYS_ID der Kostenstelle, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Kostenstelle [cmn_Cost_Center] |
| country | Ländercode des Landes, in dem der Kontakt ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Datum_Format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| Default_perspective | SYS_ID der Standardperspektive für den Kontakt. Datentyp: Zeichenfolge Tabelle: Menüliste [sys_perspective] |
| department | SYS_ID der Abteilung, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Abteilung [cmn_Department] |
| edu_Status | Bildungsstatus des zugehörigen Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fakultät |
| E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge |
|
| Employee_number | Kontaktmitarbeiternummer. Datentyp: Zeichenfolge |
| Enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Serviceportal anmeldet. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Ganzzahl) |
| first_name | Vorname des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Positionsbestimmung_nachverfolgt | Kennzeichnung, die angibt, ob der Kontaktstandort über GeoTracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Telefonnummer des Kontakts (privat). Datentyp: Zeichenfolge Maximale Länge: 40 |
| Internal_Integration_user | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsanwender 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 der Anmeldung des Kontakts beim System. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Nachname des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Last_Position_Update | Datum und Uhrzeit der letzten Aktualisierung der 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 verwendet wurde, um sich zuletzt beim System anzumelden. Datentyp: Zeichenfolge Tabelle: LDAP-Server [ldap_Server_config] |
| location | SYS_ID des Datensatzes, der den Standort des Kontakts beschreibt Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] |
| Gesperrt_out | Kennzeichnung, die angibt, ob der Kontakt gesperrt 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. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| 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 (Ganzzahl) Standard: 2 |
| On_schedule | Gibt die Aktualität 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: Zeichenfolge |
| Preferred_language | Ländercode der primären Sprache des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Anwenderrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | SYS_ID des Datensatzes, der den Arbeitszeitplan für den zugehörigen Kontakt beschreibt. Datentyp: Zeichenfolge Tabelle: Zeitplan [cmn_schedule] |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Status, 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 | Anwender, der ursprünglich den zugehörigen Kontaktdatensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Daten und Uhrzeit der ursprünglichen Erstellung des zugehörigen Kontakts. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| sys_Domain | ServiceNow Instanzdomäne des zugehörigen 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 zugehörigen Kontaktdatensatz. Datentyp: Zeichenfolge |
| sys_mod_count | Gibt an, wie oft der zugeordnete Kontaktdatensatz geändert wurde. Datentyp: Zahl (Ganzzahl) |
| sys_updated_by | Anwender, der die zugehörigen Kontaktinformationen zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Daten und Uhrzeit der Aktualisierung der zugehörigen 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 Zeitnachweisrichtlinie für den zugehörigen Kontakt enthält. Datentyp: Zeichenfolge Tabelle: Zeitnachweisrichtlinie [time_sheet_Policy] |
| Time_Zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Kontaktanwender-ID. 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 Web auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Postleitzahl des Kontakts. 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: VERÖFFENTLICHEN SIE /now/contact
Erstellt eine neue Kundenservice-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. 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. Datentyp: Zeichenfolge Tabelle: Account [Customer_Account] |
| aktiv | Kennzeichnung, die angibt, ob der Kontakt im System aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| 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. Datentyp: Zeichenfolge Tabelle: Gebäude [cmn_Building] |
| Calendar_Integration | Kalenderanwendung, die der Kontakt verwendet. 1: Outlook Datentyp: Zahl (Ganzzahl) 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. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Kostenstelle | SYS_ID der Kostenstelle, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Kostenstelle [cmn_Cost_Center] |
| country | Ländercode des Landes, in dem der Kontakt ansässig ist. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Datum_Format | Format, in dem Daten für Kontakte angezeigt werden sollen. Gültige Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Leer (Systemdatumsformat) |
| Default_perspective | SYS_ID der Standardperspektive für den Kontakt. Datentyp: Zeichenfolge Tabelle: Menüliste [sys_perspective] |
| department | SYS_ID der Abteilung, die dem Kontakt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Abteilung [cmn_Department] |
| edu_Status | Bildungsstatus des zugehörigen Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fakultät |
| E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge |
|
| Employee_number | Kontaktmitarbeiternummer. Datentyp: Zeichenfolge |
| Enable_multifactor_authn | Kennzeichnung, die angibt, ob eine Multifaktor-Autorisierung erforderlich ist, damit sich der Kontakt beim Serviceportal anmeldet. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Failed_attempts | Anzahl der fehlgeschlagenen Anmeldeversuche. Datentyp: Zahl (Ganzzahl) |
| first_name | Vorname des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 50 |
| Geschlecht | Kontaktgeschlecht. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Positionsbestimmung_nachverfolgt | Kennzeichnung, die angibt, ob der Kontaktstandort über GeoTracking abgerufen wird. Mögliche Werte:
Datentyp: Boolesch Standardwert: falsch |
| home_phone | Telefonnummer des Kontakts (privat). Datentyp: Zeichenfolge Maximale Länge: 40 |
| Internal_Integration_user | Kennzeichnung, die angibt, ob der Kontakt ein interner Integrationsanwender 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 der Anmeldung des Kontakts beim System. Datentyp: Zeichenfolge (Datum/Uhrzeit) |
| last_name | Nachname des Kontakts. 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 verwendet wurde, um sich zuletzt beim System anzumelden. Datentyp: Zeichenfolge Tabelle: LDAP-Server [ldap_Server_config] |
| location | SYS_ID des Datensatzes, der den Standort des Kontakts beschreibt Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] |
| Gesperrt_out | Kennzeichnung, die angibt, ob der Kontakt gesperrt 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. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| 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 (Ganzzahl) Standard: 2 |
| On_schedule | Gibt die Aktualität 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: Zeichenfolge |
| Preferred_language | Ländercode der primären Sprache des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 3 |
| Rollen | Liste der Anwenderrollen, die dem Kontakt zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Zeitplan | SYS_ID des Datensatzes, der den Arbeitszeitplan für den zugehörigen Kontakt beschreibt. Datentyp: Zeichenfolge Tabelle: Zeitplan [cmn_schedule] |
| Social_Channel | Social Media-Kanal, dem der Kontakt zugeordnet ist, z. B. Twitter, Facebook oder Instagram. Datentyp: Zeichenfolge |
| Social_Handle | Anwender-Handle im Social Media-Kanal. Datentyp: Zeichenfolge |
| Social_Handle_url | URL zum Profil des sozialen Kanals des Kontakts. Datentyp: Zeichenfolge |
| Quelle | Quelle des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Status | Status, 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 Zeitnachweisrichtlinie für den zugehörigen Kontakt enthält. Datentyp: Zeichenfolge Tabelle: Zeitnachweisrichtlinie [time_sheet_Policy] |
| Time_Zone | Zeitzone, in der sich der Kontakt befindet, z. B. Kanada/Zentral oder USA/Ost. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Titel | Geschäftstitel des Kontakts, z. B. Manager, Softwareentwickler oder Auftragnehmer. Datentyp: Zeichenfolge Maximale Länge: 60 |
| user_name | Kontaktanwender-ID. 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 Web auf Services zugreifen kann. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Postleitzahl | Postleitzahl des Kontakts. Datentyp: Zeichenfolge Maximale Länge: 40 |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Header | 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 REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Neuer Kontaktdatensatz wurde erfolgreich erstellt. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (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"