連絡先の詳細情報の照会

    指定したメンバーのマイアドレス帳にある連絡先の詳細情報を照会します。

    ★ 注意:この API は他システムからの移行時のみ使用することを推奨します。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/migration/{API ID}/contact/getPrivateContact/v1

    HTTP Method

    POST(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)

    Request

    パラメータ タイプ 必須 説明
    targetMemberEmail String Y 対象メンバー
    contactNo Long Y 照会する連絡先の UUID

    Request Example

    "targetMemberEmail": "test@email.com""contactNo": 10008341052
    

    Response

    呼び出しに成功したら、data値に連絡先の詳細情報がJSON形式で返されます。

    プロパティ タイプ 説明
    contactNo Long 連絡先の UUID
    name Map 名前
         firstName String 名前(名)
         lastName String 苗字(姓)
    telephones List 電話番号リスト
         defaultYn String 代表であるかどうか(Y/N)
         content String 電話番号
         typeCode String データ分類
    ● MOBILE: 携帯
    ● WORK: 会社
    ● WORK_FAX: 会社のFAX
    emails List メールリスト
         defaultYn String 代表であるかどうか(Y/N)
         content String メールアドレス
    nickNames List ニックネーム
         defaultYn String 代表であるかどうか(Y/N)
         content String ニックネーム
    organizations List 会社の所属リスト
         defaultYn String 代表であるかどうか(Y/N)
         content String 会社名
         department String 部署名
         jobTitle String 役職名
    locations List 住所リスト
         defaultYn String 代表であるかどうか(Y/N)
         street String 番地
         city String
         state String 県、州
         country String
         zipcode String 郵便番号
         typeCode String データ分類
    ● WORK: 会社
    ● HOME: 自宅
    ● OTHER: その他
    webSites List ホームページリスト
         defaultYn String 代表であるかどうか(Y/N)
         content String ホームページのアドレス
         typeCode String データ分類
    ● WORK: 会社
    ● HOMEPAGE: 個人
    ● OTHER: その他
    events List 記念日、イベントリスト
         defaultYn String 代表であるかどうか(Y/N)
         content String 日付(yyyyMMdd)
         dayTypeCode String 日付形式
    ● S: 西暦
    ● L: 旧暦
         typeCode String データ分類
    ● BIRTHDAY: 誕生日
    ● ANNIVERSARY: 記念日
    ● OTHER: その他
    ● CUSTOM: 直接入力
         eventName String 直接入力したイベント名
    messengers List SNSリスト
         defaultYn String 代表であるかどうか(Y/N)
         content String SNS の ID
         protocol String SNS のタイプ
    ● LINE
    ● FACEBOOK
    ● OTHER: その他
    ● CUSTOM: 直接入力
         protocolLabel String 直接入力した SNS 名
    memos List メモ
         defaultYn String 代表であるかどうか(Y/N)
         content String メモ内容
    photos List 写真リスト。
    既存の写真を削除するには、このリストを編集してください。
         defaultYn String 代表であるかどうか(Y/N)
         content String アップロードした写真のパス
         typeCode String 写真のタイプ
    ● UPLOAD: アップロードした写真
    importantContactYn String 重要な連絡先であるかどうか
    ● Y: 重要な連絡先
    ● N: 一般の連絡先