マーケティングプラットフォームの一斉メール配信を新規登録するためのAPIです。
mailsender.post
| メソッド | URL |
|---|---|
| POST | https://{domainname}/services/rest/mailsender |
なし
なし
★ エレメント名：MailSender ★ データ型：MailSenderType
| カラム名 | 必須 | データ型 | 内容 |
|---|---|---|---|
| ReservationMailType | 必須 | ReservationMailTypeType | 送信者指定方法 ReservationMailTypeId：ReservationMailTypeName 1：送信ユーザ指定 2：検索条件指定 ※ 送信ユーザ指定の場合は VisitorDataListで指定したリードに対してメールが送信されます。検索条件指定の場合は、SearchCondition に指定した検索条件に合致したリードに対してメールが送信されます。 |
| SearchCondition | 必須 (検索条件指定の場合) |
SearchConditionRefType | 送信対象者の検索条件 SearchConditionId：SearchConditionName |
| VisitorDataList | 必須 (送信ユーザ指定の場合) |
VisitorDataListRefType | 送信対象者のリードID VisitorData：VisitorDataId ※ リードIDのリストで指定します。 |
| MailTemplate | 必須 | MailTemplateRefType | メールテンプレート MailTemplateId：MailTemplateName ※ 自動送信用のメールテンプレートを指定することはできません。また、キャンペーンを指定した場合は、そのキャンペーンのメールテンプレートのみ使用することができます。 |
| PermissionType | 必須 | PermissionTypeType | DM許可 PermissionTypeId：PermissionTypeName 1：希望する 2：希望しない 3：希望する,希望しない |
| ResendFlag | 必須 | ResendFlagType | 送信済の人も含めて送信する ResendFlagId：ResendFlagName 1：する 0：しない |
| ClickCountFlag | オプション | ClickCountFlagType | クリックカウントを取得する ClickCountFlagId：ClickCountFlagName 1：使用する 0：使用しない ※ 1:使用する の場合は、メールテンプレートに含まれる全てのURLのクリックカウントを取得します。取得したくないURL はClickCountExcludeUrlList で指定してください。 |
| ClickCountExcludeUrlList | オプション | ClickCountExcludeUrlListType | クリックカウント除外URL ClickCountExcludeUrl (string) のリストで指定します。完全一致したURLを、クリックカウントの対象から除外します。（正規表現での指定はできません) |
| UseOpenrate | オプション | UseOpenrateType | 開封率を使用する UseOpenrateId：UseOpenrateName 1：使用する（デフォルト） 0：使用しない ※ 指定したメールテンプレートがHTML形 式, マルチパート形式（HTML文面）の場合のみ使用できます。 |
| DeliveryType | 必須 | DeliveryTypeType | 配信方法 DeliveryTypeId：DeliveryTypeName 1：即時配信 2：予約配信 |
| NotificationEmail | オプション (リマインドメール送信時刻を使用する場合は必須) |
string | 完了連絡メール送信先アドレス |
| ReservationDate | 必須 (予約配信の場合) |
dateTime | 送信予約日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| RemindHour | オプション | RemindHourType | リマインドメール送信時刻 RemindHourId：RemindHourName 1：15分前 2：30分前 3：1時間前 4：3時間前 5：6時間前 6：12時間前 7：1日前 8：2日前 9：3日前 |
| Seminar | オプション | SeminarRefType | キャンペーン SeminarId：SeminarName ※ 指定しない場合は全キャンペーン |
| コード | 内容 |
|---|---|
| 201 | 正常終了 |
| パラメータ名 | データ型 | 内容 |
|---|---|---|
| Location | string | 登録されたリソースへのURL https://{domainname}/services/rest/mailsender/{id} |
なし
<?xml version='1.0' encoding='UTF-8'?>
<MailSender xmlns="http://smartseminar.jp/">
<ReservationMailType>
<ReservationMailTypeId>2</ReservationMailTypeId>
<ReservationMailTypeName>検索条件指定</ReservationMailTypeName>
</ReservationMailType>
<SearchCondition>
<SearchConditionId>1</SearchConditionId>
<SearchConditionName>全リード</SearchConditionName>
</SearchCondition>
<MailTemplate>
<MailTemplateId>8136</MailTemplateId>
<MailTemplateName>メールテンプレートのタイトル</MailTemplateName>
</MailTemplate>
<PermissionType>
<PermissionTypeId>3</PermissionTypeId>
<PermissionTypeName>希望する,希望しない</PermissionTypeName>
</PermissionType>
<ResendFlag>
<ResendFlagId>1</ResendFlagId>
<ResendFlagName>する</ResendFlagName>
</ResendFlag>
<ClickCountFlag>
<ClickCountFlagId>1</ClickCountFlagId>
<ClickCountFlagName>使用する</ClickCountFlagName>
</ClickCountFlag>
<ClickCountExcludeUrlList>
<ClickCountExcludeUrl>https://www.shanon.co.jp</ClickCountExcludeUrl>
<ClickCountExcludeUrl>https://www.shanon.co.jp/index.html</ClickCountExcludeUrl>
</ClickCountExcludeUrlList>
<UseOpenrate>
<UseOpenrateId>1</UseOpenrateId>
<UseOpenrateName>使用する</UseOpenrateName>
</UseOpenrate>
<NotificationEmail>failure+test@shanon.co.jp</NotificationEmail>
<DeliveryType>
<DeliveryTypeId>1</DeliveryTypeId>
<DeliveryTypeName>即時配信</DeliveryTypeName>
</DeliveryType>
<Seminar>
<SeminarId>10</SeminarId>
<SeminarName>キャンペーンNo.10</SeminarName>
</Seminar>
</MailSender>
<?xml version='1.0' encoding='UTF-8'?>
<MailSender xmlns="http://smartseminar.jp/">
<ReservationMailType>
<ReservationMailTypeId>1</ReservationMailTypeId>
<ReservationMailTypeName>送信ユーザ指定</ReservationMailTypeName>
</ReservationMailType>
<VisitorDataList>
<VisitorData>
<VisitorDataId>10001</VisitorDataId>
</VisitorData>
<VisitorData>
<VisitorDataId>10002</VisitorDataId>
</VisitorData>
</VisitorDataList>
<MailTemplate>
<MailTemplateId>8136</MailTemplateId>
<MailTemplateName>メールテンプレートのタイトル</MailTemplateName>
</MailTemplate>
<PermissionType>
<PermissionTypeId>1</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>2</DeliveryTypeId>
<DeliveryTypeName>予約配信</DeliveryTypeName>
</DeliveryType>
<ReservationDate>2013-01-11T12:50:00+09:00</ReservationDate>
<RemindHour>
<RemindHourId>2</RemindHourId>
<RemindHourName>30分前</RemindHourName>
</RemindHour>
</MailSender>
なし