一斉メール配信情報取得API

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

メソッド名

mailsender.get

リクエスト情報

アクセスURL

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

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
ReservationMailTypeId	○	○	送信者指定方法 1: 送信ユーザ指定 2: 検索条件指定
SearchConditionId	○	○	送信対象者の検索条件
MailTemplateId	○	○	メールテンプレート
MailTemplateMemo	○	○	メールテンプレートメモ
PermissionTypeId	○	○	DM許可 1：希望する 2：希望しない 3：希望する,希望しない
ResendFlagId	○	○	送信済の人も含めて送信する 1：する 0：しない
UseOpenrateId	○	○	開封率を使用する 1：使用する 0：使用しない
DeliveryTypeId	○	○	配信方法 1：即時配信 2：予約配信
NotificationEmail	○	○	完了連絡メール送信先アドレスリマインドメール送信先アドレス
SeminarId	○	○	キャンペーンID
ReservationDate	○	○	送信予約日(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
StartDate	○	○	送信開始日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
EndDate	○	○	送信完了日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
SenderName	○	○	送信者名
ReplyTo	○	○	返信先
ReturnPath	○	○	エラー時返信先

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：MailSender ★ データ型：MailSenderType

カラム名	データ型	内容
Id	nonNegativeInteger	配信ID
ReservationMailType	ReservationMailTypeType	送信者指定方法 ReservationMailTypeId：ReservationMailTypeName 1：送信ユーザ指定 2：検索条件指定
SearchCondition	SearchConditionRefType	送信対象者の検索条件 SearchConditionId：SearchConditionName ※ 検索条件指定の場合のみ出力
PermissionType	PermissionTypeType	DM許可 PermissionTypeId：PermissionTypeName 1：希望する 2：希望しない 3：希望する,希望しない
ResendFlag	ResendFlagType	送信済の人も含めて送信する ResendFlagId：ResendFlagName 1：する 0：しない
ClickCountFlag	ClickCountFlagType	クリックカウントを取得する ClickCountFlagId：ClickCountFlagName 1：使用する 0：使用しない
UseOpenrate	UseOpenrateType	開封率を使用する UseOpenrateId：UseOpenrateName 1：使用する 0：使用しない
DeliveryType	DeliveryTypeType	配信方法 DeliveryTypeId：DeliveryTypeName 1：即時配信 2：予約配信
NotificationEmail	string	完了連絡メール送信先アドレスリマインドメール送信先アドレス
Seminar	SeminarRefType	キャンペーン SeminarId : SeminarName
ReservationDate	dateTime	送信予約日(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
StartDate	dateTime	送信開始日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
EndDate	dateTime	送信完了日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
EstimatedEndDate	dateTime	送信完了予定日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
MailSenderStatus	MailSenderStatusType	送信状況 MailSenderStatusId：MailSenderStatusName 1：完了 2：実行中 3：送信予約 4：準備中
TotalCount	nonNegativeInteger	送信数
SuccessCount	nonNegativeInteger	到達数
ErrorCount	nonNegativeInteger	エラー数
MailTemplate	MailTemplateRefType	メールテンプレート MailTemplateId：メールテンプレートID MailTemplateName：タイトル MailTemplateMemo：メールテンプレートメモ
MailSenderId	nonNegativeInteger	配信ID
AttachmentFile	AttachmentFileType	添付ファイル AttachmentFileId：ファイルID AttachmentFileName：ファイル名 AttachmentFileExtension：ファイル拡張子

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<MailSenderList xmlns="http://smartseminar.jp/" version="1.23">
　<MailSender>
　　<Id>7</Id>
　　<ReservationMailType>
　　　<ReservationMailTypeId>1</ReservationMailTypeId>
　　　<ReservationMailTypeName>送信ユーザ指定</ReservationMailTypeName>
　　</ReservationMailType>
　　<MailTemplate>
　　　<MailTemplateId>246</MailTemplateId>
　　　<MailTemplateName>テスト用メール</MailTemplateName>
　　　<MailTemplateMemo>テスト用メールメモ</MailTemplateMemo>
　　</MailTemplate>
　　<PermissionType>
　　　<PermissionTypeId>3</PermissionTypeId>
　　　<PermissionTypeName>希望する,希望しない</PermissionTypeName>
　　</PermissionType>
　　<ResendFlag>
　　　<ResendFlagId>1</ResendFlagId>
　　　<ResendFlagName>する</ResendFlagName>
　　</ResendFlag>
　　<ClickCountFlag>
　　　<ClickCountFlagId>0</ClickCountFlagId>
　　　<ClickCountFlagName>使用しない</ClickCountFlagName>
　　</ClickCountFlag>
　　<UseOpenrate>
　　　<UseOpenrateId>2</UseOpenrateId>
　　　<UseOpenrateName>使用しない</UseOpenrateName>
　　</UseOpenrate>
　　<DeliveryType>
　　　<DeliveryTypeId>1</DeliveryTypeId>
　　　<DeliveryTypeName>即時配信</DeliveryTypeName>
　　</DeliveryType>
　　<DateRegist>2011-06-16T16:04:52+09:00</DateRegist>
　　<StartDate>2011-06-16T16:04:52+09:00</StartDate>
　　<EndDate>2011-06-16T16:04:56+09:00</EndDate>
　　<MailSenderStatus>
　　　<MailSenderStatusId>1</MailSenderStatusId>
　　　<MailSenderStatusName>完了</MailSenderStatusName>
　　</MailSenderStatus>
　　<TotalCount>1</TotalCount>
　　<SuccessCount>1</SuccessCount>
　　<ErrorCount>0</ErrorCount>
　</MailSender>
</MailSenderList>

制限事項

クリック者、クリック率、総クリック数、開封率、開封者、未開封者、停止数、停止率、登録者は取得できません。
クリック率、総クリック率については、クリックカウントURL情報取得APIのMailReservedId に本APIのIdを指定して検索してください。クリック者は、クリックカウント履歴情報取得API の ClickCountUrlId にクリックカウントURL情報取得APIのId を指定して検索してください。
開封者については、メール情報取得API の MailSenderId に本APIのIdを指定し、初回開封日時もしくは最新開封日時を検索してください。
使用方法に関しましては、「メール送信API」の「一斉メール配信状況の取得」をご参照ください。