---
title: "getAddressBook"
slug: "ai-application-service-cloudoutboundmailer-getaddressbook"
updated: 2026-09-17T09:57:24Z
published: 2026-09-17T09:57:24Z
canonical: "api.ncloud-docs.com/ai-application-service-cloudoutboundmailer-getaddressbook"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getAddressBook

Classic/VPC環境で利用できます。

アカウントが保有する受信者アドレス帳の状況を照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /address-book |

### リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、[Cloud Outbound Mailerのリクエストヘッダ](/docs/ja/ai-application-service-cloudoutboundmailer#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/address-book' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `totalAddressCount` | Integer | - | 総メールアドレス数 |
| `groups` | List | - | 受信者グループ情報 - [AddressBookResponse](/docs/ja/common-vapidatatype-nesaddressbookresponse)を参照 |

### レスポンスステータスコード

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud Outbound Mailerのレスポンスステータスコード](/docs/ja/ai-application-service-cloudoutboundmailer#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
  "totalAddressCount": 4300,
  "groups": [
    {
      "sid": 155,
      "groupName": "10代",
      "addressCount": 3900
    },
    {
      "sid": 159,
      "groupName": "男性",
      "addressCount": 1000
    }
}
```