getAddressBook
- 印刷する
- PDF
getAddressBook
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
アドレス帳の現状照会(アドレスの合計および受信者グループによるアドレスの数を照会)
GET https://{endpoint}/address-book
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | 認証失敗、間違ったリクエスト |
| 500 | サーバエラー |
例示
リクエスト
GET https://mail.apigw.ntruss.com/api/v1/address-book
レスポンス
{
"totalAddressCount": 4300,
"groups": [
{
"sid": 155,
"groupName": "10代",
"addressCount": 3900
},
{
"sid": 159,
"groupName": "男子",
"addressCount": 1000
}
}
属性
| 項目 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| totalAddressCount | Yes | Integer | メールアドレスの合計 | |
| groups | No | List<AddressBookResponse> | 受信者グループのリスト |
エラーコード
| HTTP Status Code | リターンコード | レスポンスメッセージ |
|---|---|---|
| 400 | 77101 | ログイン情報のエラー |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | リソースが存在しない |
| 403 | 77201 | 権限なし |
| 403 | 77202 | Email商品の利用申込をしていない |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 基本プロジェクトが存在しない |
| 500 | 77302 | 外部システムAPIの連動エラー |
| 500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?