メール情報取得API

マーケティングプラットフォームのメール情報を参照するためのAPIです。

メソッド名

visitor.getMail

リクエスト情報

アクセスURL

メソッド	URL
GET	https://{domainname}/services/rest/visitor/mail

URL部パラメータ

パラメータ名	必須	内容
search_key{cid}	オプション	検索条件のキー項目指定可能なキー項目は下記「検索条件に指定可能なカラム」参照
search_operator{cid}	オプション	“検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like”
search_value{cid}	オプション	検索値 Nullを指定する場合は、何も指定しません。例： search_value1=
order	オプション	並び順の項目指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照
direction	オプション	並び順を指定する「asc」（昇順）または「desc」（降順）
limit	オプション	1回のリクエストで取得するレコード数（最大1000）
offset	オプション	レコードのオフセット

検索条件・並び順に指定可能なカラム

カラム名	検索条件	並び順	内容
Id	○	○	メール情報ID
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	○	×	宛先リードID
SenderAddress	○	○	送信者E-mailアドレス
DestinationAddress	○	○	宛先E-mailアドレス
Title	○	○	タイトル
SendError	○	○	送信結果
ErrorCode	○	○	エラーコード
OpendateFirst	○	○	初回開封日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
OpendateLastest	○	○	最新開封日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
MailTemplateId	○	○	メールテンプレートID
MailSenderId	○	○	配信ID
Cc	○	○	Cc
Bcc	○	○	Bcc
SenderName	○	○	送信者名
ReplyTo	○	○	返信先
ReturnPath	○	○	エラー時返信先
DkimKeyFqdn	○	○	DKIMのFQDN

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Mail ★ データ型：MailType

カラム名	データ型	内容
Id	string	メール情報ID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	string	宛先リードID
SenderAddress	string	送信者E-mailアドレス
SenderName	string	送信者名
DestinationAddress	string	宛先E-mailアドレス
Title	string	タイトル
Body	string	本文
Body2	string	本文2(マルチパート形式におけるHTML文面)
SendError	nonNegativeInteger	送信結果
ErrorCode	nonNegativeInteger	エラーコード
Cc	string	CC
Bcc	string	BCC
ReplyTo	string	返信先
ReturnPath	string	エラー時返信先
MailType	MailTypeType	MailTypeId：MailTypeName 1：テキスト形式 2：HTML形式 3：マルチパート形式
OpendateFirst	dateTime	初回開封日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
OpendateLastest	dateTime	最新開封日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
Charset	CharsetType	文字コード CharsetId：CharsetName 1：西欧 (ISO-8859-1) 2：Unicode (UTF-8) 3：日本語 (EUC-JP) 4：日本語 (ISO-2022-JP) 5：日本語 (Shift_JIS) 6：簡体字中国語 (GB2312) 7：繁体字中国語 (BIG5) 8：韓国語 (EUC-KR) 9：キリル文字 (ISO-8859-5) 10：キリル文字 (KOI8-R) 11：キリル文字 (Windows-1251)
MailTemplate	MailTemplateRefType	メールテンプレート MailTemplateId：メールテンプレートID MailTemplateName：タイトル MailTemplateMemo：メールテンプレートメモ
MailSenderId	nonNegativeInteger	配信ID
AttachmentFile	AttachmentFileType	添付ファイル AttachmentFileId：ファイルID AttachmentFileName：ファイル名 AttachmentFileExtension：ファイル拡張子
DkimKeyFqdn	string	DKIMのFQDN

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<MailList xmlns="http://smartseminar.jp/" version="1.5">
　<Mail>
　　<DestinationAddress>failure039@shanon.co.jp</DestinationAddress>
　　<Body2>&lt;div&gt;テストリード１様&lt;br /&gt;&lt;imgheight=&quot;1&quot;
　　src=&quot;https://192.168.1.199:4000/cc/?w=840&amp;u=373&amp;d=1xVOOZPBkbZJu&amp;quot;
　　style=&quot;display:none;&quot;width=&quot;1&quot;/&gt;&lt;/div&gt;</Body2>
　　<Id>16</Id>
    <MailSenderId>9</MailSenderId>
　　<Title>【株式会社○○○】テストキャンペーン型その６アンケート　事前登録完了のお知らせ</Title>
　　<SenderAddress>system@smartseminar.jp</SenderAddress>
　　<ErrorCode>40000</ErrorCode>
　　<DateRegist>2009-01-14T13:15:17+09:00</DateRegist>
　　<DateUpdate>2009-01-14T13:15:17+09:00</DateUpdate>
　　<SendError>0</SendError>
　　<DkimKeyFqdn>id=2(a01._domiankey.shanon.co.jp)</DkimKeyFqdn>
　　<VisitorId>39</VisitorId>
　　<Body>--------------------------------------------------------------------
　　このメールは、システムより自動的に送信されています。
　　お心当たりのない方は、お手数ではございますが、本メールの内容とともに
　　ご返信いただきますようお願い申し上げます。
　　━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
　　テストキャンペーンキャンペーン型その６アンケート　事前登録完了のお知らせ
　　━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
　　このたびは、テストキャンペーンキャンペーン型その６アンケートに事前登録いただき、
　　誠にありがとうございます。
　　お申込内容は以下の通りです。
　　※マイページへのログインに必要となりますログイン情報の登録が未済のお客様は
　　下記URLより24時間以内にアクセス頂き、ご登録を完了されますようお願い申し上げます。
　　ID　　　　：test_user039
　　ログイン情報登録用URL：
　　http://192.168.1.199:4000/public/accountsetting?code=b8a851b38020ea888e05cc37daa29c2f
　　登録日時：2009-01-14 13:15
　　本メールに関するお問合せはこちら
　　株式会社○○○
　　○○○○キャンペーン運営事務局
　　TEL: 03-XXXX-XXXX FAX: 03-XXXX-XXXX
　　E-mail:xxxx@xxxxx.co.jp
　　==========================================</Body>
　　<AttachmentFile>
　　　<AttachmentFileName>sankousiryou</AttachmentFileName>
　　　<AttachmentFileExtension>png</AttachmentFileExtension>
　　　<AttachmentFileId>3490</AttachmentFileId>
　　</AttachmentFile>
    <Chrset>
      <CharsetName>日本語 (ISO-2022-JP)</CharsetName>
      <CharsetId>4</CharsetId>
    </Charset>
    <MailType>
      <MailTypeName>テキスト形式</MailTypeName>
      <MailTypeId>1</MailTypeId>
    </MailType>
　　<MailTemplate>
　　　<MailTemplateId>246</MailTemplateId>
　　　<MailTemplateName>【株式会社○○○】テストキャンペーン型その６アンケート　事前登録完了のお知らせ</MailTemplateName>
　　　<MailTemplateMemo>テスト用メールメモ</MailTemplateMemo>
　　</MailTemplate>
　</Mail>
</MailList>

制限事項

更新日時は、2015/03/01以降に送信したメールのみ値が格納されており、2015/03/01以前に更新されたメール情報は更新日時が取得できませんのでご注意ください。
更新日時を検索条件に使用する場合は、2015/03/01以降に送信したメール情報のみが日付で検索できる対象となりますのでご注意ください。