共有連絡先リストの照会

    指定されたドメイン内の全共有アドレス帳の連絡先リストを100件ずつ照会します。

    APIの種類

    サーバーAPI

    Request URL

    https://apis.worksmobile.com/{API ID}/contact/listSharedContact/v2

    HTTP Method

    GET

    Request

    パラメータ タイプ 必須 説明
    domainId Integer Y ドメインID
    page Integer Y 照会するページ番号
    groupNo Long N 照会する共有アドレス帳グループUUID
    ● -1 : 「グループなし」連絡先の照会

    Response

    プロパティ タイプ 説明
    code String 呼び出し結果
    ● 200 : 成功
    ● その他: エラーコード参考
    message String 結果メッセージ
    data String 呼び出しに成功した場合、共有アドレス帳の連絡先リストのデータ

    API呼び出しに成功すると、以下のデータをdata値で渡します。
    (1ページ当たり100件の連絡先を照会)

    プロパティ タイプ 説明
    totalPage Integer 全ページ数
    contacts List 照会ページの連絡先リスト
      contactNo Long 共有アドレス帳連絡先UUID
      name String 名前
      telephone String 代表電話番号
      email String 代表メール
      organization String 代表会社名

    Response Example

    {
        "code": "200",
        "message": "success",
        "data": {
            "totalPage": 5,
            "contacts": [
                {
                    "contactNo": 100000000000001,
                    "name": "Shared Contact1",
                    "telephone": "1234-1234",
                    "email": "example1@email.com",
                    "organization": "Org Name"
                },
                {
                    "contactNo": 100000000000002,
                    "name": "Shared Contact2",
                    "telephone": "1234-1234",
                    "email": "example2@email.com",
                    "organization": "Org Name"
                }
            ]
        }
    }
    

    Error Code

    API 呼び出しに失敗するとエラーコードとエラーメッセージを返します。

    Error Code 説明
    400 リクエストの値が不適切
    500 内部サーバーエラー
    Error Code Example
    {
        "code": "400",
        "message": "invalid domainId"
    }