連絡先 API

リリースバージョン: Zurich

更新日 2025年07月31日

所要時間：44分

連絡先 API は、カスタマーサービス管理 (CSM) 連絡先レコードの取得と更新を可能にするエンドポイントを提供します。

さらに、連絡先の作成時に新しいソーシャルメディアプロファイルレコードを生成できます。

連絡先 API には、カスタマーサービスプラグイン (com.sn_customerservice) が必要であり、now 名前空間内で提供されます。

ユーザーが API にフルアクセスするためには、csm_ws_integration ロールが必要です。

連絡先 - GET /now/contact

指定されたカスタマーサービス管理 (CSM) 連絡先セットを取得します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/contact

デフォルトの URL：/api/now/contact

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。応答では、ブールパラメーター hasMore が返されます。フィルター基準を満たす、返されるレコードが他にもあるかどうかを示します。データタイプ：数値デフォルト：10
sysparm_offset	レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターには負数を指定しないでください。データタイプ：数値デフォルト：0
sysparm_query	結果セットのフィルタリングに使用されるエンコードされたクエリ。例： `sysparm_query=caller_id=javascript:gs.getUserID()^active=true` エンコードされたクエリは、順序をサポートしています。特定のフィールドに基づいて回答を並べ替えるには、ORDERBY と ORDERBYDESC の句を sysparm_query で使用します。たとえば、`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` はすべてのアクティブなレコードをフィルタリングし、最初に番号によって昇順に、次にカテゴリによって降順に結果を並び替えます。フィールド名が無効というようにクエリの一部が無効であると、インスタンスは無効な部分を無視します。次に、クエリの有効部分のみを使用して行を返します。この動作は glide.invalid_query.returns_no_rows プロパティを使用してコントロールできます。無効なクエリに行を返さないようにするには、このプロパティを true に設定します。注: glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンスのすべてのクエリの動作を管理します。データタイプ：文字列

表 : 3. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

エンドポイントでは、次の JSON または XML 要素を応答本文で返すことができます。以下で定義する (ベースシステムにある要素を定義する) 要素のリストに加えて、エンドポイントでは、連絡先 [customer_contact] テーブルに追加されたカスタムフィールドも返します。これらの要素の詳細については、特定のテーブル定義 [システム定義 > テーブル].


要素	説明
アカウント	連絡先が関連付けられているアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
active	システム内で連絡先がアクティブかどうかを示すフラグ。可能な値： true：連絡先はアクティブです。 false：連絡先は非アクティブです。データタイプ：ブールデフォルト：true
agent_status	エージェントのステータス。可能な値：業務時間外休憩中ルーティング時現地データタイプ：文字列最大長：40
建物	連絡先が所在する建物を説明するレコードのSys_id。データタイプ：文字列テーブル:建物 [cmn_building]
calendar_integration	連絡先が使用するカレンダーアプリケーション。 1：Outlook データタイプ：数値 (整数) デフォルト値：1
city	連絡先が居住する市区町村。データタイプ：文字列最大長：40
会社	連絡先が関連付けられている会社レコードのSys_id。データタイプ：文字列テーブル:会社 [core_company]
cost_center	連絡先に関連付けられたコストセンターのSys_id。データタイプ：文字列テーブル:コストセンター [cmn_cost_center]
国	連絡先が居住する国の国コード。データタイプ：文字列最大長：3
date_format	連絡先に日付を表示する形式。有効な値： dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式)
default_perspective	連絡先のデフォルトの視点の sys_id。データタイプ：文字列テーブル:メニューリスト [sys_perspective]
部門	連絡先に関連付けられた部門の sys_id。データタイプ：文字列テーブル:部門 [cmn_department]
edu_status	関連付けられた連絡先の学歴ステータス。データタイプ：文字列最大長：40 デフォルト：faculty
email	連絡先のメールアドレス。データタイプ：文字列
employee_number	連絡先の従業員番号。データタイプ：文字列
enable_multifactor_authn	連絡先がサービスポータルにログインするためにマルチファクター認証が必要かどうかを示すフラグ。可能な値： true：マルチファクター認証が有効 false：マルチファクター認証が無効データタイプ：ブールデフォルト値：false
failed_attempts	失敗したログイン試行回数。データタイプ：数値 (整数)
first_name	連絡先の名。データタイプ：文字列最大長：50
gender	連絡先の性別。データタイプ：文字列最大長：40
geolocation_tracked	連絡先の場所が位置情報追跡によって取得されたかどうかを示すフラグ。可能な値： true：連絡先の場所は位置情報追跡によって取得された false：連絡先の場所は位置情報追跡によって取得されていないデータタイプ：ブールデフォルト値：false
home_phone	連絡先の自宅電話番号。データタイプ：文字列最大長：40
internal_integration_user	連絡先が内部統合ユーザーかどうかを示すフラグ。可能な値： true：内部統合ユーザー false：他のタイプのユーザーデータタイプ：ブールデフォルト値：false
introduction	前書きデータタイプ：文字列最大長：40
last_login	連絡先が最後にシステムにログインした日付。データタイプ：文字列 (日付)
last_login_device	コンシューマーが最後にシステムにログインしたときに使用したデバイス。データタイプ：文字列最大長：40
last_login_time	連絡先がシステムにログインした日時。データタイプ：文字列 (日付/時間)
last_name	連絡先の姓。データタイプ：文字列最大長：50
last_position_update	位置が最後に更新された日時。データタイプ：文字列 (日付/時間)
latitude	連絡先の緯度座標。データタイプ：数値 (浮動小数点) 最大長：40
ldap_server	連絡先がシステムへの最終ログインに使用する LDAP サーバーのSys_id。データタイプ：文字列テーブル:LDAP サーバー [ldap_server_config]
場所	連絡先の場所を説明するレコードのSys_id データタイプ：文字列テーブル:場所 [cmn_location]
locked_out	連絡先がロックアウトされているかどうかを示すフラグ。可能な値： true：連絡先がロックアウトされました false：連絡先はロックアウトされていませんデータタイプ：ブールデフォルト値：false
経度	連絡先の経度座標。データタイプ：数値 (浮動小数点) 最大長：40
マネージャー	連絡先の直属の上司を説明するレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
middle_name	連絡先のミドルネーム。データタイプ：数値 (浮動小数点) 最大長：50
mobile_phone	連絡先の携帯電話番号。データタイプ：文字列最大長：40
name	連絡先のフルネーム。データタイプ：文字列最大長：151
notification	連絡先が通知を受信するかどうかを示します。有効な値： 1：無効 2：有効データタイプ：数値 (整数) デフォルト値：2
on_schedule	ディスパッチされたサービス担当者の適時性を示します。有効な値： Ahead：スケジュールの前倒し。 behind_less30：スケジュール遅延 (ただし 30 分未満)。 behind_30to60：スケジュール遅延 (30 ～ 60 分)。 behind_more60：スケジュール遅延 (60 分超)。 on_time：スケジュールどおり。データタイプ：文字列最大長：40
phone	連絡先の勤務先電話番号。データタイプ：文字列最大長：40
photo	連絡先の写真画像。データタイプ：文字列
preferred_language	連絡先のプライマリ言語の国コード。データタイプ：文字列最大長：3
roles	連絡先に関連付けられているユーザーロールのリスト。データタイプ：文字列最大長：40
schedule	関連付けられた連絡先の作業スケジュールを説明するレコードのSys_id。データタイプ：文字列テーブル:スケジュール [cmn_schedule]
ソース	連絡先のソース。データタイプ：文字列最大長：255
state	連絡先が居住する都道府県。データタイプ：文字列最大長：40
street	連絡先の番地。データタイプ：文字列最大長：255
sys_class_name	連絡先レコードを含むテーブル。データタイプ：文字列最大長：80
sys_created_by	関連付けられた連絡先レコードを最初に作成したユーザー。データタイプ：文字列最大長：40
sys_created_on	関連付けられた連絡先が最初に作成された日時。データタイプ：文字列 (日付/時間)
sys_domain	関連付けられた連絡先レコードの ServiceNow インスタンスドメイン。データタイプ：文字列
sys_domain_path	連絡先レコードのドメインパス。データタイプ：文字列最大長：255 デフォルト：/ (global)
sys_id	関連付けられた連絡先レコードの一意の識別子。データタイプ：文字列
sys_mod_count	関連付けられた連絡先レコードが変更された回数。データタイプ：数値 (整数)
sys_tags	システムタグ。データタイプ：文字列
sys_updated_by	関連付けられた連絡先情報を最後に更新したユーザー。データタイプ：文字列最大長：40
sys_updated_on	関連付けられた連絡先情報が更新された日時。データタイプ：文字列 (日付/時間)
time_format	時間を表示する形式。有効な値： hh.mm.ss a: hh.mm.ss (12 時間制) hh:mm:ss a: hh:mm:ss (12 時間制) HH.mm.ss: hh.mm.ss (24 時間制) HH:mm:ss: hh:mm:ss (24 時間制) データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式)
time_sheet_policy	関連付けられた連絡先のタイムシートポリシーを含むレコードのSys_id。データタイプ：文字列テーブル:タイムシートポリシー [time_sheet_policy]
time_zone	連絡先が居住するタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40
title	マネージャー、ソフトウェア開発者、請負業者などの連絡先のビジネスタイトル。データタイプ：文字列最大長：60
user_name	連絡先のユーザー ID。データタイプ：文字列最大長：40
vip	関連付けられた連絡先が VIP ステータスかどうかを示すフラグ。可能な値： true：VIP false：VIP ではないデータタイプ：ブールデフォルト値：false
web_service_access_only	連絡先が Web 経由でのみサービスにアクセスできるかどうかを示すフラグ。可能な値： true：Web アクセスのみ false：利用可能なすべての方法によるアクセスデータタイプ：ブールデフォルト値：false
zip	連絡先の郵便番号。データタイプ：文字列最大長：40

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"
    }
  ]
}

連絡先 - GET /now/contact/{id}

指定されたカスタマーサービス管理 (CSM) 連絡先を取得します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/contact/{id}

デフォルトの URL：/api/now/contact/{id}

注:

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
id	取得する連絡先の sys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	要求が無効であることを示します。次のいずれかの理由が考えられます。要求されたケースが存在しません。ユーザーにはケースへのアクセス権がありません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


要素	説明
アカウント	連絡先が関連付けられているアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
active	システム内で連絡先がアクティブかどうかを示すフラグ。可能な値： true：連絡先はアクティブです。 false：連絡先は非アクティブです。データタイプ：ブールデフォルト：true
agent_status	エージェントのステータス。可能な値：業務時間外休憩中ルーティング時現地データタイプ：文字列最大長：40
建物	連絡先が所在する建物を説明するレコードのSys_id。データタイプ：文字列テーブル:建物 [cmn_building]
calendar_integration	連絡先が使用するカレンダーアプリケーション。 1：Outlook データタイプ：数値 (整数) デフォルト値：1
city	連絡先が居住する市区町村。データタイプ：文字列最大長：40
会社	連絡先が関連付けられている会社レコードのSys_id。データタイプ：文字列テーブル:会社 [core_company]
cost_center	連絡先に関連付けられたコストセンターのSys_id。データタイプ：文字列テーブル:コストセンター [cmn_cost_center]
国	連絡先が居住する国の国コード。データタイプ：文字列最大長：3
date_format	連絡先に日付を表示する形式。有効な値： dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式)
default_perspective	連絡先のデフォルトの視点の sys_id。データタイプ：文字列テーブル:メニューリスト [sys_perspective]
部門	連絡先に関連付けられた部門の sys_id。データタイプ：文字列テーブル:部門 [cmn_department]
edu_status	関連付けられた連絡先の学歴ステータス。データタイプ：文字列最大長：40 デフォルト：faculty
email	連絡先のメールアドレス。データタイプ：文字列
employee_number	連絡先の従業員番号。データタイプ：文字列
enable_multifactor_authn	連絡先がサービスポータルにログインするためにマルチファクター認証が必要かどうかを示すフラグ。可能な値： true：マルチファクター認証が有効 false：マルチファクター認証が無効データタイプ：ブールデフォルト値：false
failed_attempts	失敗したログイン試行回数。データタイプ：数値 (整数)
first_name	連絡先の名。データタイプ：文字列最大長：50
gender	連絡先の性別。データタイプ：文字列最大長：40
geolocation_tracked	連絡先の場所が位置情報追跡によって取得されたかどうかを示すフラグ。可能な値： true：連絡先の場所は位置情報追跡によって取得された false：連絡先の場所は位置情報追跡によって取得されていないデータタイプ：ブールデフォルト値：false
home_phone	連絡先の自宅電話番号。データタイプ：文字列最大長：40
internal_integration_user	連絡先が内部統合ユーザーかどうかを示すフラグ。可能な値： true：内部統合ユーザー false：他のタイプのユーザーデータタイプ：ブールデフォルト値：false
introduction	前書きデータタイプ：文字列最大長：40
last_login	連絡先が最後にシステムにログインした日付。データタイプ：文字列 (日付)
last_login_device	コンシューマーが最後にシステムにログインしたときに使用したデバイス。データタイプ：文字列最大長：40
last_login_time	連絡先がシステムにログインした日時。データタイプ：文字列 (日付/時間)
last_name	連絡先の姓。データタイプ：文字列最大長：50
last_position_update	位置が最後に更新された日時。データタイプ：文字列 (日付/時間)
latitude	連絡先の緯度座標。データタイプ：数値 (浮動小数点) 最大長：40
ldap_server	連絡先がシステムへの最終ログインに使用する LDAP サーバーのSys_id。データタイプ：文字列テーブル:LDAP サーバー [ldap_server_config]
場所	連絡先の場所を説明するレコードのSys_id データタイプ：文字列テーブル:場所 [cmn_location]
locked_out	連絡先がロックアウトされているかどうかを示すフラグ。可能な値： true：連絡先がロックアウトされました false：連絡先はロックアウトされていませんデータタイプ：ブールデフォルト値：false
経度	連絡先の経度座標。データタイプ：数値 (浮動小数点) 最大長：40
マネージャー	連絡先の直属の上司を説明するレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
middle_name	連絡先のミドルネーム。データタイプ：数値 (浮動小数点) 最大長：50
mobile_phone	連絡先の携帯電話番号。データタイプ：文字列最大長：40
name	連絡先のフルネーム。データタイプ：文字列最大長：151
notification	連絡先が通知を受信するかどうかを示します。有効な値： 1：無効 2：有効データタイプ：数値 (整数) デフォルト値：2
on_schedule	ディスパッチされたサービス担当者の適時性を示します。有効な値： Ahead：スケジュールの前倒し。 behind_less30：スケジュール遅延 (ただし 30 分未満)。 behind_30to60：スケジュール遅延 (30 ～ 60 分)。 behind_more60：スケジュール遅延 (60 分超)。 on_time：スケジュールどおり。データタイプ：文字列最大長：40
phone	連絡先の勤務先電話番号。データタイプ：文字列最大長：40
photo	連絡先の写真画像。データタイプ：文字列
preferred_language	連絡先のプライマリ言語の国コード。データタイプ：文字列最大長：3
roles	連絡先に関連付けられているユーザーロールのリスト。データタイプ：文字列最大長：40
schedule	関連付けられた連絡先の作業スケジュールを説明するレコードのSys_id。データタイプ：文字列テーブル:スケジュール [cmn_schedule]
ソース	連絡先のソース。データタイプ：文字列最大長：255
state	連絡先が居住する都道府県。データタイプ：文字列最大長：40
street	連絡先の番地。データタイプ：文字列最大長：255
sys_class_name	連絡先レコードを含むテーブル。データタイプ：文字列最大長：80
sys_created_by	関連付けられた連絡先レコードを最初に作成したユーザー。データタイプ：文字列最大長：40
sys_created_on	関連付けられた連絡先が最初に作成された日時。データタイプ：文字列 (日付/時間)
sys_domain	関連付けられた連絡先レコードの ServiceNow インスタンスドメイン。データタイプ：文字列
sys_domain_path	連絡先レコードのドメインパス。データタイプ：文字列最大長：255 デフォルト：/ (global)
sys_id	関連付けられた連絡先レコードの一意の識別子。データタイプ：文字列
sys_mod_count	関連付けられた連絡先レコードが変更された回数。データタイプ：数値 (整数)
sys_updated_by	関連付けられた連絡先情報を最後に更新したユーザー。データタイプ：文字列最大長：40
sys_updated_on	関連付けられた連絡先情報が更新された日時。データタイプ：文字列 (日付/時間)
time_format	時間を表示する形式。有効な値： hh.mm.ss a: hh.mm.ss (12 時間制) hh:mm:ss a: hh:mm:ss (12 時間制) HH.mm.ss: hh.mm.ss (24 時間制) HH:mm:ss: hh:mm:ss (24 時間制) データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式)
time_sheet_policy	関連付けられた連絡先のタイムシートポリシーを含むレコードのSys_id。データタイプ：文字列テーブル:タイムシートポリシー [time_sheet_policy]
time_zone	連絡先が居住するタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40
title	マネージャー、ソフトウェア開発者、請負業者などの連絡先のビジネスタイトル。データタイプ：文字列最大長：60
user_name	連絡先のユーザー ID。データタイプ：文字列最大長：40
vip	関連付けられた連絡先が VIP ステータスかどうかを示すフラグ。可能な値： true：VIP false：VIP ではないデータタイプ：ブールデフォルト値：false
web_service_access_only	連絡先が Web 経由でのみサービスにアクセスできるかどうかを示すフラグ。可能な値： true：Web アクセスのみ false：利用可能なすべての方法によるアクセスデータタイプ：ブールデフォルト値：false
zip	連絡先の郵便番号。データタイプ：文字列最大長：40

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"
  }
}

連絡先 - POST /now/contact

新しいカスタマーサービス管理 (CSM) 連絡先を作成します。

さらに、このエンドポイントを使用して、連絡先のソーシャルメディアプロファイルを作成できます。プロファイルを作成するには、要求本文で次のパラメーターを指定する必要があります。

social_channel
social_handle
social_handle_url

警告:

このエンドポイントでパラメーターの検証を実行すると、過度のオーバーヘッドが発生する可能性があるため、パラメーターの検証を実行しません。要求パラメーターが、スペルが間違っている、有効ではない、またはエンドポイントでサポートされていない場合、警告なしで無視されます。

URL 形式

バージョニングされた URL：/api/now/{api_version}/contact

デフォルトの URL：/api/now/contact

注:

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (XML または JSON)
要素	説明
アカウント	連絡先が関連付けられているアカウントレコードのSys_id。データタイプ：文字列テーブル:アカウント [customer_account]
active	システム内で連絡先がアクティブかどうかを示すフラグ。可能な値： true：連絡先はアクティブです。 false：連絡先は非アクティブです。データタイプ：ブールデフォルト：true
agent_status	エージェントのステータス。可能な値：業務時間外休憩中ルーティング時現地データタイプ：文字列最大長：40
建物	連絡先が所在する建物を説明するレコードのSys_id。データタイプ：文字列テーブル:建物 [cmn_building]
calendar_integration	連絡先が使用するカレンダーアプリケーション。 1：Outlook データタイプ：数値 (整数) デフォルト値：1
city	連絡先が居住する市区町村。データタイプ：文字列最大長：40
会社	連絡先が関連付けられている会社レコードのSys_id。データタイプ：文字列テーブル:会社 [core_company]
cost_center	連絡先に関連付けられたコストセンターのSys_id。データタイプ：文字列テーブル:コストセンター [cmn_cost_center]
国	連絡先が居住する国の国コード。データタイプ：文字列最大長：3
date_format	連絡先に日付を表示する形式。有効な値： dd/mm/yyyy dd-mm-yyyy dd.mm.yyyy mm-dd-yyyy yyyy-mm-dd データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式)
default_perspective	連絡先のデフォルトの視点の sys_id。データタイプ：文字列テーブル:メニューリスト [sys_perspective]
部門	連絡先に関連付けられた部門の sys_id。データタイプ：文字列テーブル:部門 [cmn_department]
edu_status	関連付けられた連絡先の学歴ステータス。データタイプ：文字列最大長：40 デフォルト：faculty
email	連絡先のメールアドレス。データタイプ：文字列
employee_number	連絡先の従業員番号。データタイプ：文字列
enable_multifactor_authn	連絡先がサービスポータルにログインするためにマルチファクター認証が必要かどうかを示すフラグ。可能な値： true：マルチファクター認証が有効 false：マルチファクター認証が無効データタイプ：ブールデフォルト値：false
failed_attempts	失敗したログイン試行回数。データタイプ：数値 (整数)
first_name	連絡先の名。データタイプ：文字列最大長：50
gender	連絡先の性別。データタイプ：文字列最大長：40
geolocation_tracked	連絡先の場所が位置情報追跡によって取得されたかどうかを示すフラグ。可能な値： true：連絡先の場所は位置情報追跡によって取得された false：連絡先の場所は位置情報追跡によって取得されていないデータタイプ：ブールデフォルト値：false
home_phone	連絡先の自宅電話番号。データタイプ：文字列最大長：40
internal_integration_user	連絡先が内部統合ユーザーかどうかを示すフラグ。可能な値： true：内部統合ユーザー false：他のタイプのユーザーデータタイプ：ブールデフォルト値：false
introduction	前書きデータタイプ：文字列最大長：40
last_login_device	コンシューマーが最後にシステムにログインしたときに使用したデバイス。データタイプ：文字列最大長：40
last_login_time	連絡先がシステムにログインした日時。データタイプ：文字列 (日付/時間)
last_name	連絡先の姓。データタイプ：文字列最大長：50
latitude	連絡先の緯度座標。データタイプ：数値 (浮動小数点) 最大長：40
ldap_server	連絡先がシステムへの最終ログインに使用する LDAP サーバーのSys_id。データタイプ：文字列テーブル:LDAP サーバー [ldap_server_config]
場所	連絡先の場所を説明するレコードのSys_id データタイプ：文字列テーブル:場所 [cmn_location]
locked_out	連絡先がロックアウトされているかどうかを示すフラグ。可能な値： true：連絡先がロックアウトされました false：連絡先はロックアウトされていませんデータタイプ：ブールデフォルト値：false
経度	連絡先の経度座標。データタイプ：数値 (浮動小数点) 最大長：40
マネージャー	連絡先の直属の上司を説明するレコードのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
middle_name	連絡先のミドルネーム。データタイプ：数値 (浮動小数点) 最大長：50
mobile_phone	連絡先の携帯電話番号。データタイプ：文字列最大長：40
name	連絡先のフルネーム。データタイプ：文字列最大長：151
notification	連絡先が通知を受信するかどうかを示します。有効な値： 1：無効 2：有効データタイプ：数値 (整数) デフォルト値：2
on_schedule	ディスパッチされたサービス担当者の適時性を示します。有効な値： Ahead：スケジュールの前倒し。 behind_less30：スケジュール遅延 (ただし 30 分未満)。 behind_30to60：スケジュール遅延 (30 ～ 60 分)。 behind_more60：スケジュール遅延 (60 分超)。 on_time：スケジュールどおり。データタイプ：文字列最大長：40
phone	連絡先の勤務先電話番号。データタイプ：文字列最大長：40
photo	連絡先の写真画像。データタイプ：文字列
preferred_language	連絡先のプライマリ言語の国コード。データタイプ：文字列最大長：3
roles	連絡先に関連付けられているユーザーロールのリスト。データタイプ：文字列最大長：40
schedule	関連付けられた連絡先の作業スケジュールを説明するレコードのSys_id。データタイプ：文字列テーブル:スケジュール [cmn_schedule]
social_channel	連絡先が関連付けられているソーシャルメディアチャネル (Twitter、Facebook、Instagram など)。データタイプ：文字列
social_handle	ソーシャルメディアチャネルのユーザーハンドル。データタイプ：文字列
social_handle_url	連絡先のソーシャルチャネルプロファイルへの URL。データタイプ：文字列
ソース	連絡先のソース。データタイプ：文字列最大長：255
state	連絡先が居住する都道府県。データタイプ：文字列最大長：40
street	連絡先の番地。データタイプ：文字列最大長：255
time_format	時間を表示する形式。有効な値： hh.mm.ss a: hh.mm.ss (12 時間制) hh:mm:ss a: hh:mm:ss (12 時間制) HH.mm.ss: hh.mm.ss (24 時間制) HH:mm:ss: hh:mm:ss (24 時間制) データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式)
time_sheet_policy	関連付けられた連絡先のタイムシートポリシーを含むレコードのSys_id。データタイプ：文字列テーブル:タイムシートポリシー [time_sheet_policy]
time_zone	連絡先が居住するタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40
title	マネージャー、ソフトウェア開発者、請負業者などの連絡先のビジネスタイトル。データタイプ：文字列最大長：60
user_name	連絡先のユーザー ID。データタイプ：文字列最大長：40
vip	関連付けられた連絡先が VIP ステータスかどうかを示すフラグ。可能な値： true：VIP false：VIP ではないデータタイプ：ブールデフォルト値：false
web_service_access_only	連絡先が Web 経由でのみサービスにアクセスできるかどうかを示すフラグ。可能な値： true：Web アクセスのみ false：利用可能なすべての方法によるアクセスデータタイプ：ブールデフォルト値：false
zip	連絡先の郵便番号。データタイプ：文字列最大長：40

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
201	新しい連絡先レコードが正常に作成されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500	内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。

応答本文のパラメーター (JSON または XML)


要素	説明
result	新しく作成された連絡先レコードの sys_id。データタイプ：文字列

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"