共有アドレス帳グループリスト照会

    指定されたドメインのすべての共有アドレス帳グループを照会します。

    APIの種類

    サーバーAPI

    Request URL

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

    HTTP Method

    GET

    Request

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

    Response

    プロパティ タイプ 説明
    code String 呼び出し結果
    ● 200 : 成功
    ● その他: エラーコード参考
    message String 結果メッセージ
    data String 呼び出し成功の場合、以下のグループリスト情報

    API呼び出しに成功すると、以下のデータをdata値で渡します。

    プロパティ タイプ 説明
    groupNo Long グループUUID
    name String グループ名
    open Boolean グループの公開状況
    ● true: 公開グループ
    ● false: セキュアグループ

    Response Example

    {
        "code": "200",
        "message": "success",
        "data": [
            {
                "groupNo": 100000000000001,
                "name": "Open Group1",
                "open": true
            },
            {
                "groupNo": 100000000000002,
                "name": "Open Group2",
                "open": true
            },
            {
                "groupNo": 100000000000003,
                "name": "Secure Group1",
                "open": false
            }
        ]
    }
    

    Error Code

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

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