顧客/取引先の連絡先リストの照会

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

    • 開始/終了日時フィルターで指定できる期間は最大 7 日間です。
    • 開始/終了日時フィルターのどちらかのみ指定した場合、指定日から 7 日以内に作成/修正された連絡先情報を照会します。
    • データは 最大 5 万件まで照会できます。
    • page * maxResults 値が 5 万件以内になるようにフィルターを設定してください。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    GET

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID

    Request Parameter

    パラメーター タイプ 上限 必須 説明
    page Integer N ページ
    ● 既定値:1
    maxResults Integer N 1 ページで取得するデータサイズ。
    ● 1~500 まで設定可。
    ● 既定値: 500
    searchDateType String N 照会日タイプ
    ● CREATION_TIME: 作成日時
    ● MODIFICATION_TIME: 修正日時
    これ以外の値は CREATION_TIME で設定されます。
    startDateTime String N 開始日時フィルター
    ISO 8601 日付および時間、分、秒形式(YYYY-MM-DDThh:mm:ssTZD)。
    ● 例) 2020-04-05T00:00:00+09:00
    ● :は%3A、+は%2BでURLエンコードが必要です。
    endDateTime String N 終了日時フィルター
    ISO 8601 日付および時間、分、秒形式(YYYY-MM-DDThh:mm:ssTZD)。
    ● 例) 2020-04-06T00:00:00+09:00
    ● :は%3A、+は%2BでURLエンコードが必要です。
    tagResourceId String N タグのリソース ID フィルター
    open Boolean N 公開範囲フィルター
    ● true: すべてのメンバー
    ● false: メンバー指定
    filterWorksAt Boolean N 外部ユーザーの連絡先のみフィルター
    userId String N メンバー ID フィルター
    orderBy String N ソートタイプ
    ● NAME: 名前
    ● CREATION_TIME: 作成日時
    ● MODIFICATION_TIME: 修正日時
    sortOrder String N ソートの昇順 / 降順
    ● ASC: 昇順(既定値)
    ● DESC: 降順

    Request Example

    GET https://apis.worksmobile.com/r/apiid/contact/v3/domains/123/shared/contacts?page=1&maxResults=500&searchDateType=CREATION_TIME&startDateTime=2020-04-05T00%3A00%3A00%2B09%3A00&endDateTime=2020-04-06T00%3A00%3A00%2B09%3A00
    

    Response

    API の呼び出しに成功すると HTTP 200 コードと Response Body の「contacts」に顧客/取引先の連絡先情報をリストで返します。

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

    Response Example

    {
       "contacts":[
          {
             "resourceId":"230e2625-x31b-41d4-a916-689055440000",
             "open":true,
             "isCoEditing": true,
             "masterUserId": "account1@example.com",
             "name":{
                "firstName":"April",
                "lastName":"Jackson",
                "nickName":"Bella"
             },
             "emails":[
                {
                   "address":"april.jackson@email.com",
                   "represent":true
                }
             ],
             "creationTime":"2020-04-01T08:10:18+09:00",
             "modificationTime":"2020-04-03T07:30:04+09:00"
          },
          {
             "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":"Nickname"
             },
             "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"
          }
       ],
       "nextPage":2
    }
    

    Error Code

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