顧客/取引先の連絡先の照会

顧客/取引先の連絡先を照会します。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API ID}/contact/v3/domains/{domainId}/shared/contacts/{resourceId}

HTTP Method

GET

Path Parameters

パラメーター	タイプ	上限	必須	説明
domainId	Integer		Y	ドメイン ID
resourceId	String		Y	連絡先のリソース ID

Request Example

GET https://apis.worksmobile.com/r/apiid/contact/v3/domains/123/shared/contacts/550e8400-e29b-41d4-a716-446655440000

Response

API の呼び出しに成功すると HTTP 200 コードと次の値を返します。

プロパティ	タイプ	説明
resourceId	String	連絡先のリソース ID
open	Boolean	公開範囲 ● true：すべてのメンバー ● false：メンバー指定
isCoEditing	Boolean	共同編集可否 ● true: 共有メンバーによる編集可能 ● false: 管理者ユーザーのみ編集可能
masterUserId	String	連絡先の管理者ユーザー ID
sharedMembers[]	List	公開範囲がfalseの場合の共有メンバーリスト
sharedMembers[].id	String	アドバンスト/ベーシック/プレミアムプランの場合、メンバーのメールアドレス、組織のメーリングリスト。他のプランの場合の場合は、共有するメンバー ID、組織 ID。
sharedMembers[].type	String	sharedMembers[].id のタイプ ● USER：メンバー ● ORGUNIT：組織
tagResourceIds[]	List<String>	タグのリソース ID リスト
name	Object	名前情報
name.lastName	String	姓
name.firstName	String	名
name.phoneticLastName	String	姓 (フリガナ)
name.phoneticFirstName	String	名 (フリガナ)
name.prefix	String	敬称 (Honor)
name.suffix	String	呼称 (Suffix)
name.middleName	String	ミドルネーム (Middle)
name.nickName	String	ニックネーム
emails[]	List	メールリスト
emails[].address	String	メールアドレス
emails[].represent	Boolean	代表メールアドレスフラグ
phones[]	List	電話番号リスト
phones[].value	String	電話番号
phones[].type	String	電話番号タイプ ● MOBILE：携帯 ● WORK：勤務先 ● HOME：自宅 ● WORK_FAX：勤務先のFAX ● HOME_FAX：自宅のFAX ● OTHER：その他 ● CUSTOM：直接入力
phones[].customType	String	直接入力 (CUSTOM) した電話番号タイプ
phones[].represent	Boolean	代表電話番号フラグ
organizations[]	List	会社の所属リスト
organizations[].name	String	会社名
organizations[].department	String	部署名
organizations[].title	String	役職名
organizations[].represent	Boolean	代表会社フラグ
locations[]	List	住所リスト
locations[].value	String	住所
locations[].zipcode	String	郵便番号
locations[].type	String	住所タイプ ● WORK：勤務先 ● HOME：自宅 ● OTHER：その他 ● CUSTOM：直接入力
locations[].customType	String	直接入力 (CUSTOM) した住所タイプ
locations[].represent	Boolean	代表住所フラグ
events[]	List	イベント (誕生日・記念日) リスト
events[].value	String	日付 (yyyyMMdd)
events[].dayType	String	日付形式 ● S：西暦 ● L：旧暦
events[].type	String	イベントタイプ ● BIRTHDAY：誕生日 ● ANNIVERSARY：記念日 ● OTHER：その他 ● CUSTOM：直接入力
events[].customType	String	直接入力 (CUSTOM) したイベントタイプ
events[].represent	Boolean	代表イベントフラグ
messengers[]	List	SNS リスト
messengers[].id	String	SNS ID
messengers[].type	String	SNS タイプ ● LINE ● FACEBOOK ● TWITTER ● CUSTOM：直接入力
messengers[].customType	String	直接入力 (CUSTOM) した SNS タイプ
messengers[].represent	Boolean	代表 SNS フラグ
websites[]	List	Web サイトリスト
websites[].value	String	Web サイト URL
websites[].represent	Boolean	代表 Web サイトフラグ
photos[]	List	写真リスト
photos[].path	String	アップロードされた写真のパス
photos[].represent	Boolean	代表写真フラグ
memo	String	メモ
worksAt	Object	外部ユーザー情報 (外部ユーザーの連絡先である場合のみ)
worksAt.type	String	外部ユーザータイプ ● line： LINE ユーザー ● worksat：他のドメインの WORKS ユーザー
worksAt.resourceId	String	外部ユーザーのリソース ID
worksAt.buddyUserIds	String	外部ユーザーをアドレス帳に追加したメンバー ID リスト
creationTime	String	作成日時 ● ISO 8601 日付および時間、分、秒形式(YYYY-MM-DDThh:mm:ssTZD) ● 例) 2020-04-05T19:30:04+09:00
modificationTime	String	修正時間 ● ISO 8601 日付および時間、分、秒形式(YYYY-MM-DDThh:mm:ssTZD) ● 例) 2020-04-05T19:30:04+09:00

Response Example

{
   "resourceId":"550e8400-e29b-41d4-a716-446655440000",
   "open":false,
   "isCoEditing": true,
   "masterUserId": "account1@example.com",
   "sharedMembers":[
      {
         "id":"account1@example.com",
         "type":"USER"
      },
      {
         "id":"account2@example.com",
         "type":"USER"
      },
      {
         "id":"account3@example.com",
         "type":"USER"
      },
      {
         "id":"orgunit1@example.com",
         "type":"ORGUNIT"
      }
   ],
   "tagResourceIds":[
      "efse4567-e89b-12d3-a456-426614174000",
      "774117c8-7a68-4c67-62a8-0312dd90b9b3"
   ],
   "name":{
      "firstName":"First Name",
      "lastName":"Last Name",
      "nickName":"Nick Name"
   },
   "emails":[
      {
         "address":"example@email.com",
         "represent":true
      }
   ],
   "phones":[
      {
         "value":"0000-0001",
         "type":"WORK",
         "represent":true
      },
      {
         "value":"0000-0002",
         "type":"CUSTOM",
         "customType":"Custom Type",
         "represent":false
      }
   ],
   "organizations":[
      {
         "name":"Organization",
         "department":"Department",
         "title":"Job Title",
         "represent":true
      }
   ],
   "locations":[
      {
         "value":"Home Address",
         "zipcode":"000-111",
         "type":"HOME",
         "represent":true
      },
      {
         "value":"Custom Address",
         "zipcode":"000-111",
         "type":"CUSTOM",
         "customType":"Custom type",
         "represent":false
      }
   ],
   "events":[
      {
         "value":"20170313",
         "dayType":"S",
         "type":"BIRTHDAY",
         "represent":true
      }
   ],
   "messengers":[
      {
         "id":"lineid",
         "type":"LINE",
         "represent":true
      },
      {
         "id":"customid",
         "type":"CUSTOM",
         "customType":"customlabel",
         "represent":false
      }
   ],
   "websites":[
      {
         "value":"homepage.com",
         "represent":true
      }
   ],
   "photos":[
      {
         "path":"/upload/photo/1234.jpg",
         "represent":true
      }
   ],
   "memo":"Memo content",
   "worksAt":[
      {
         "type":"LINE",
         "resourceId":"741ec794-9bf8-4759-1eef-03ffa18ca759",
         "buddyUserIds":[
            "account1@example.com"
         ]
      }
   ],
   "creationTime":"2020-04-05T19:30:04+09:00",
   "modificationTime":"2020-04-06T21:30:04+09:00"
}

Error Code

API の呼び出しに失敗するとエラーコードとエラーメッセージを返します。
詳細はアドレス帳APIのエラーコードを参照してください。

LINE WORKS Developers