# メールのステータスを取得する

キャンペーンで送付したメールが、開封されたかクリックされたかなどのステータスを取得します。

### HTTP種類 : GET

### URL : \[BASE URL]/SpringRest/campaign/status/get

### HTTP戻り値 : JSON

指定したステータスに合致したリードの一覧の取得、または指定したリードのステータスを取得します。

### JSON戻り値 例：

```javascript
{
    "code": 200,
    "message": "Success",
    "status": "OK",
    "generatedId": null,
    "generatedIds": null,
    "statusObject": "OK",
    "pagination": {
        "offset": 0,
        "nextOffset": 0,
        "prevOffset": 0,
        "limit": 1,
        "total": 1,
        "nextUrl": null,
        "prevUrl": null,
        "accountId": null,
        "message": "Data available",
        "sort": null
    },
    "data": [
        {
            "campaign": {
                "campaignId": ,
                "type": {
                    "id": 1,
                    "text": "Mail Magazine"
                },
                "title": "",
                "description": null
            },
            "customer": {
                "customerId": ,
                "firstName": null,
                "lastName": null,
                "name": "",
                "email": "",
                "gender": {
                    "id": 0,
                    "text": "Male"
                },
                "birthday": null,
                "company": null,
                "statusNew": null,
                "statusActive": null,
                "statusHot": null,
                "statusRankup": null,
                "statusRankdown": null,
                "statusWatch": null,
                "statusCWatch": null
    "primaryStatus": {}
            },
            "status": {
                "id": 1,
                "text": "開封"
            },
            "responseStatus": null,
            "creationDate": null
        }
    ]
}
```

## 1. キャンペーンIDとステータスを指定してリードリストのステータスを取得する

### パラメータ :

|      名 前      |      型     |  必 須 |
| :-----------: | :--------: | :--: |
| access\_token |   String   | True |
|   campaignId  |   Integer  | True |
|     status    | Integer\[] | True |

status：

```
Mail Send – 0
Mail Open – 1
Mail Link Click – 5
Mail Bounce – 2
Mail Fail – 8
```

このメソッドは、指定したキャンペーンでstatusパラメータに合致しているリードを取得します。\
キャンペーンID、ステータス（ステータス値は上記のとおり）、およびアクセストークンを渡す必要があります。 APIからJSONレスポンスを返します。

### サンプルコード

```java
private String MailStatusGet(String accessToken , String campaignId, String status) {
        try {
            HttpClient client = new DefaultHttpClient();
            HttpGet httpGet = new HttpGet("<API_BASE_URL>/SpringRest/campaign/status/get?access_token="
                    + accessToken + "&campaignId=" + campaignId + "&status=" + status);

            HTTP戻り値 response = client.execute(httpGet);

            if (response.getStatusLine().getStatusCode() == 200) {
                BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));
                String line = "";
                while ((line = rd.readLine()) != null) {

                    return line;
                }
            }
        } catch (ClientProtocolException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return null;
    }
```

### 呼び出し方法

```java
String response = MailStatusGet(“98d9a7ea-8669-45e6-b141-f663c8cb35b8”, "525", "0");
```

## 2. キャンペーンIDとリードIDを指定してリードのステータスを取得する

### パラメータ :

|      名 前      |      型     |  必 須 |
| :-----------: | :--------: | :--: |
| access\_token |   String   | True |
|   campaignId  |   Integer  | True |
|   customerId  | Integer\[] | True |

このメソッドは、キャンペーンにおけるリードのステータスを取得します。APIからJSONレスポンスを返します。

### サンプルコード

```java
private String MailStatusGet(String accessToken , String campaignId, Int customerId) {
        try {
            HttpClient client = new DefaultHttpClient();
            HttpGet httpGet = new HttpGet("<API_BASE_URL>/SpringRest/campaign/status/get?access_token="
                    + accessToken + "&campaignId=" + campaignId + "&customerId=" + customerId);

            HTTP戻り値 response = client.execute(httpGet);

            if (response.getStatusLine().getStatusCode() == 200) {
                BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));
                String line = "";
                while ((line = rd.readLine()) != null) {

                    return line;
                }
            }
        } catch (ClientProtocolException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return null;
    }
```

### 呼び出し方法

```java
String response = MailStatusGet(“98d9a7ea-8669-45e6-b141-f663c8cb35b8”, "525", 25);
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://markefan.gitbook.io/documents/index/campaignstatusget.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.