メールテンプレート情報取得API

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

メソッド名

mailtemplate.get

リクエスト情報

アクセスURL

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

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
MailTypeId	○	○	メール種別 MailTypeId：MailTypeName 1：テキスト形式 2：HTML形式 3：マルチパート形式
MailKindId	○	○	キャンペーン種別 MailKindId：MailKindName 1：キャンペーン共通 2：システム共通 3：キャンペーン固有
MailCategoryId	○	○	カテゴリ MaiCategoryId：MailCategoryName 1：申込完了時（キャンペーン担当者宛） 2：申込完了時（リード宛） 3：パスワード再設定受付時（リード宛） 4：管理者登録時（アカウント発行者宛） 5：管理者登録時（登録対象管理者宛） 6：検閲OK時（リード宛） 7：検閲NG時（リード宛） 8：会員登録時（管理者宛） 9：会員登録時（リード宛） 10：マイページからのキャンセル時（キャンペーン担当者宛） 11：マイページからのキャンセル時（リード宛） 14：マイページからの個人情報変更時（管理者宛） 15：マイページからの個人情報変更時（リード宛） 17：メールテンプレート新規登録時のデフォルト文面 21：パスワードの有効期限切れ(管理者宛） 22：パスワードの有効期限切れ(リード宛) 23：パスワード再設定受付時（管理者宛） 24：管理画面ログイン情報の再設定用URL発行時（発行対象管理者宛） 25：ログイン情報再設定URL発行時（リード宛） 27：来場登録時自動送信（管理者宛） 28：申込完了時残席わずか通知（管理者宛) 29：申込完了時満席通知（管理者宛) 30：会員登録の仮登録(管理者宛) 31：会員登録の仮登録(リード宛) 32：キャンペーン申込の仮登録(キャンペーン担当者宛) 33：キャンペーン申込の仮登録(リード宛) 34：受講票URL再発行通知 35：簡易メール送信のデフォルト文面 36：申込期限終了通知（管理者宛) 37：アカウント有効化URL再発行時（リード宛） 50：その他
SenderAddress	○	○	送信者Emailアドレス
SenderName	○	○	送信者名
ReplyTo	○	○	返信先
ReturnPath	○	○	エラー時返信先
Title	○	○	タイトル
Body	○	○	本文
Body2	○	○	本文2 （マルチパート形式におけるHTML文面）
DestinationAddress	○	○	宛先EMailアドレス
Cc	○	○	CC
Bcc	○	○	BCC
Charset	○	○	文字コード 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)
SeminarId	○	○	キャンペーンID
StopAutoSendId	○	○	自動送信ONOFF 0：ON 1：OFF
Memo	○	○	メモ
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DkimKeyId	○	○	DKIM ID
MailUsageId	○	×	用途 1:送信ウィザード/ステップメール用 2:シナリオ用
SenderDomainAuthenticationId	○	○	送信ドメイン ID

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：MailTemplate ★ データ型：MailTemplateType

カラム名	データ型	内容
Id	nonNegativeInteger	メールテンプレートID
MailType	MailTypeType	メール種別 MailTypeId：MailTypeName 1：テキスト形式 2：HTML形式 3：マルチパート形式
MailKind	MailKindType	種別 MailKindId：MailKindName 1：キャンペーン共通 2：システム共通 3：キャンペーン固有
MailEditorType	MailEditorTypeType	エディタ種別 MailEditorTypeId：MailEditorTypeName 1：テキスト 2：旧エディタ 3：エディタ 4：HTMLソース
MailCategory	MailCategoryType	カテゴリ MaiCategoryId：MailCategoryName 1：申込完了時（キャンペーン担当者宛） 2：申込完了時（リード宛） 3：パスワード再設定受付時（リード宛） 4：管理者登録時（アカウント発行者宛） 5：管理者登録時（登録対象管理者宛） 6：検閲OK時（リード宛） 7：検閲NG時（リード宛） 8：会員登録時（管理者宛） 9：会員登録時（リード宛） 10：マイページからのキャンセル時（キャンペーン担当者宛） 11：マイページからのキャンセル時（リード宛） 14：マイページからの個人情報変更時（管理者宛） 15：マイページからの個人情報変更時（リード宛） 17：メールテンプレート新規登録時のデフォルト文面 21：パスワードの有効期限切れ(管理者宛） 22：パスワードの有効期限切れ(リード宛) 23：パスワード再設定受付時（管理者宛） 24：管理画面ログイン情報の再設定用URL発行時（発行対象管理者宛） 25：ログイン情報再設定URL発行時（リード宛） 27：来場登録時自動送信（管理者宛） 28：申込完了時残席わずか通知（管理者宛) 29：申込完了時満席通知（管理者宛) 30：会員登録の仮登録(管理者宛) 31：会員登録の仮登録(リード宛) 32：キャンペーン申込の仮登録(キャンペーン担当者宛) 33：キャンペーン申込の仮登録(リード宛) 34：受講票URL再発行通知 35：簡易メール送信のデフォルト文面 36：申込期限終了通知（管理者宛) 37：アカウント有効化URL再発行時（リード宛） 50：その他
SenderAddress	string	送信者Emailアドレス
SenderName	string	送信者名
ReplyTo	string	返信先
ReturnPath	string	エラー時返信先
Title	string	タイトル
Body	string	本文
Body2	string	本文2（マルチパート形式におけるHTML文面）
DestinationAddress	string	宛先EMailアドレス
Cc	string	CC
Bcc	string	BCC
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)
Seminar	SeminarRefType	キャンペーンID
StopAutoSend	StopAutoSendType	自動送信ONOFF StopAutoSendId：StopAutoSendName 0：ON 1：OFF
Memo	string	メモ
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
MailFile	MailFileType	添付ファイル MailFileId：ファイルID MailFileName：ファイル名 MailFileExtension：ファイル拡張子
DkimKey	DkimKeyType	DKIM DkimKeyId:DkimKeyName DKIM ID：FQDN
MailUsageList	MailUsageListType	用途のリスト MailUsageの内容は MailUsageId:MailUsageName 1:送信ウィザード/ステップメール用 2:シナリオ
SenderDomainAuthentication	SenderDomainAuthenticationType	送信ドメイン SenderDomainAuthenticationId:SenderDomainAuthenticationName 送信ドメイン ID：設定名

XMLサンプル

リクエストXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<Requestxmlns="http://smartseminar.jp/">
<SearchValue1>204</SearchValue1>
<SearchOperator1>eq</SearchOperator1>
<SearchKey1>Id</SearchKey1>
</Request>

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<MailTemplateList xmlns="http://smartseminar.jp/" version="1.24">
　<MailTemplate>
　　<Id>204</Id>
　　<DestinationAddress>[% VisitorData.email %]</DestinationAddress>
　　<Cc>info@smartseminar.jp</Cc>
　　<MailKind>
　　　<MailKindName>キャンペーン固有</MailKindName>
　　　<MailKindId>3</MailKindId>
　　</MailKind>
　　<MailType>
　　　<MailTypeName>HTML形式</MailTypeName>
　　　<MailTypeId>2</MailTypeId>
　　</MailType>
　　<MailEditorType>
　　　<MailEditorTypeId>3</MailEditorTypeId>
　　　<MailEditorTypeName>エディタ</MailEditorTypeName>
　　</MailEditorType>
　　<DkimKey>
　　　<DkimKeyId>1</DkimKeyId>
　　　<DkimKeyName>a01._domiankey.shanon.co.jp</DkimKeyName>
　　</DkimKey>
　　<Title>テストメール（HTML)</Title>
　　<ReplyTo>system@smartseminar.jp</ReplyTo>
　　<SenderAddress>system@smartseminar.jp</SenderAddress>
　　<MailCategory>
　　　<MailCategoryId>50</MailCategoryId>
　　　<MailCategoryName>その他</MailCategoryName>
　　</MailCategory>
　　<Seminar/>
　　<Memo>テストメモ</Memo>
　　<DateUpdate>2013-02-20T10:40:44+09:00</DateUpdate>
　　<DateRegist>2013-02-19T20:40:39+09:00</DateRegist>
　　<Body>テストメールです。&lt;br&gt;
　　テストメールです。&lt;br&gt;
　　&lt;ul&gt;
　　&lt;li&gt;テスト１&lt;/li&gt;
　　&lt;li&gt;テスト２&lt;/li&gt;
　　&lt;/ul&gt;</Body>
　　<MailFile>
　　　<MailFileName>pikachu</MailFileName>
　　　<MailFileExtension>jpg</MailFileExtension>
　　　<MailFileId>6411</MailFileId>
　　</MailFile>
　　<MailUsageList>
　　　<MailUsage>
　　　　<MailUsageId>1</MailUsageId>
　　　　<MailUsageName>送信ウィザード/ステップメール用</MailUsageName>
　　　</MailUsage>
　　</MailUsageList>
　　<SenderDomainAuthentication>
　　　<SenderDomainAuthenticationId>2</SenderDomainAuthenticationId>
　　　<SenderDomainAuthenticationName>smartseminar.jpの設定</SenderDomainAuthenticationName>
　　</SenderDomainAuthentication>
　</MailTemplate>
</MailTemplateList>

制限事項

なし