連絡先の追加

    指定したメンバーのマイアドレス帳に連絡先を追加します。

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

    追加する連絡先のパラメータは JSON 形式で指定します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Request

    パラメータ タイプ 必須 説明
    targetMemberEmail String Y 対象メンバー
    contact Map Y 連絡先情報
        name Map Y 名前
             firstName String Y 名前(名)
             lastName String Y 苗字(姓)
        telephones List N 電話番号リスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y 電話番号
             typeCode String Y データ分類
    ● MOBILE: 携帯
    ● WORK: 会社
    ● WORK_FAX: 会社のFAX
         emails List N メールリスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y メールアドレス
        nickNames List N ニックネーム(1個のみ登録可)
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y ニックネーム
        organizations List N 会社の所属リスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y 会社名
             department String Y 部署名
             jobTitle String Y 役職名
         locations List N 住所リスト
             defaultYn String Y 代表であるかどうか(Y/N)
             street String Y 番地
             city String N
             state String N 県、州
             country String N
             zipcode String N 郵便番号
             typeCode String Y データ分類
    ● WORK: 会社
    ● HOME: 自宅
    ● OTHER: その他
         webSites List N ホームページリスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y ホームページアドレス
             typeCode String Y データ分類
    ● WORK: 会社
    ● HOMEPAGE: 個人
    ● OTHER: その他
         events List N 記念日、イベントリスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y 日付(yyyyMMdd)
             dayTypeCode String Y 日付形式
    ● S: 西暦
    ● L: 旧暦
             typeCode String Y データ分類
    ● BIRTHDAY: 誕生日
    ● ANNIVERSARY: 記念日
    ● OTHER: その他
    ● CUSTOM: 直接入力
             eventName String N 直接入力したイベント名
         messengers List N SNSリスト
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y SNSのID
             protocol String Y SNSのタイプ
    ● LINE
    ● FACEBOOK
    ● OTHER: その他
    ● CUSTOM: 直接入力
             protocolLabel String N 直接入力したSNS名
         memos List N メモ(1 個のみ登録可)
             defaultYn String Y 代表であるかどうか(Y/N)
             content String Y メモ内容
        importantContactYn String Y 重要な連絡先であるかどうか
    ● Y: 重要な連絡先
    ● N: 一般の連絡先
    photoBase64 String N URLエンコードされているBase64 写真データ

    Request Example

    "targetMemberEmail": "test@example.com"
    "contact": {
        "name": {
            "firstName": "テスト11",
            "lastName": ""
        },
        "nickNames": [
            {
                "defaultYn": "Y",
                "content": "ニックネーム"
            }
        ],
        "telephones": [
            {
                "defaultYn": "Y",
                "content": "000-0000-0000",
                "typeCode": "MOBILE"
            }
        ],
        "emails": [
            {
                "defaultYn": "Y",
                "content": "test@exmaple.org"
            }
        ],
        "organizations": [
            {
                "defaultYn": "Y",
                "content": "Companyname",
                "department": "Development",
                "jobTitle": ""
            }
        ],
        "importantContactYn": "N"
    }
    "photoBase64": ""
    

    Response

    呼び出しに成功したら、data 値に連絡先の UUID が返されます。

    {"code": "SUCCESS", "data": 10008341051, "message": "","failType": null}