エラーフィルターリスト取得

エラーフィルターリスト取得API

管理画面のエラーリスト管理、配信除外リスト管理に登録されていメールアドレスを取得する API です。登録済みの全データを取得します。

基本機能

エラーフィルターリスト取得APIについて

接続方法

項目 データ 備考
URL https:// ***/errflt/getErrorFilterList.php
メソッド POST ※サイズ上限は１POST につき 10MB となります。
Content-Type application/x-www-form-urlencoded
文字コード UTF-8

リクエスト

クエスト時に指定するキー・バリュー情報は以下となります。

キー・バリュー情報
1 site_id 管理画面サイト ID 対象とする管理画面のサイト ID
2 user_name testuser サイトへのアクセス権限、データ入出力権限を有した管理画面 ユーザ名
3 user_passwd ********* 管理画面 パスワード
補足説明

リクエストは直列処理にてご対応をお願いいたします。

リクエスト例

例）サイト ID = 1, ユーザ名 = “aaaa”, パスワード = “bbbbbb”

POST /errflt/getErrorFilterList.php
HTTP/1.1
Host: hoge.example
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
site_id=1&user_name=aaaa&user_passwd=bbbbbb

レスポンス

レスポンスは以下となります。

項目 データ 備考
Content-Type text/xml
文字コード UTF-8

XML データ

・データが正常に取得できている場

要素
 親要素 データ(列) 備考
1 data
2 result data
3 result_code result 0 結果コード
データが正常に取得できている場合は、ここの値は必ず 0 になります。
4 counts data 100 エラーフィルタリストに登録されているエンドユーザーの数。
5 list data
6 user list
7 mail_addr user test@example.com エンドユーザーのメールアドレス。
CDATA で囲われます。
8 bounce_cnt user 1.00 エンドユーザーのエラー回数/配信除外リスト登録有無。
配信除外リストに登録されると、bounce_cnt が 100 プラスされます。
※配信除外リスト登録以前に配信エラーが発生した場合は、101 や 102 となります。
9 regist_date user 2021-11-12 12:00:00 登録された日時
10 update_date user 2021-11-12 12:00:00 更新された日時
11 exclude_flag user 0 配信除外対象のエンドユーザーである事を示します。
1:有効（配信除外対象）
0:無効

・データが正常に取得できていない場合

要素
 親要素 データ(列) 備考
1 data
2 result data
3 result_code result 5 各エラーコード
4 result_message result ユーザー名もしくはパスワ
ードが不正です		 エラーの内容が表示されます。

レスポンス例

  • データが正常に取得できている場合
<?xml version="1.0" encoding="UTF-8"?>
<data>
    <result>
        <result_code>0</result_code>
    </result>
    <list_cnt>2</list_cnt>
    <list>
        <user>
            <mail_addr>![CDATA[test1@example.com]]</mail_addr>
            <bounce_cnt>1.00</bounce_cnt>
            <regist_date>2018-04-01 12:00:00</regist_date>
            <update_date>2018-04-01 12:00:00</update_date>
            <exclude_flag>0</exclude_flag>
        </user>
        <user>
            <mail_addr>![CDATA[test2@example.com]]</mail_addr>
            <bounce_cnt>1.00</bounce_cnt>
            <regist_date>2018-04-01 12:00:00</regist_date>
            <update_date>2018-04-01 12:00:00</update_date>
            <exclude_flag>0</exclude_flag>
        </user>
    </list>
</data>
  • データが正常に取得できていない場合
<?xml version="1.0" encoding="UTF-8"?>
<data>
    <result>
    <result_code>5</result_code>
    <result_message>ユーザー名もしくはパスワードが不正です</result_message>
    </result>
</data>