メール送信API
一斉メール配信APIの利用方法
マーケティングプラットフォームAPIは、メールテンプレートAPI、検索条件API と組み合わせて一斉メール配信を行うことができます。
メールテンプレートの登録、取得、削除
- メールテンプレートを新たに登録して使用する場合は、mailtemplate.post を使用します。
- 登録が完了するとHTTPレスポンスヘッダの Location にリソースURLが返ります。
- 末尾のIDをメールテンプレートIDとして一斉メール配信で使用します。
- 既に登録されているメールテンプレートを使用する場合には、mailtemplate.get を使用して取得します。
- 取得したデータのIDをメールテンプレートIDとして使用します。
- メールテンプレートを削除するにはメールテンプレートIDを使用します。
検索条件の取得
検索条件を使用した一斉メール配信を行うためには、検索条件のIDが必要です。検索条件を使用せずにリードIDを指定する場合には、検索条件IDは必要ありません。
検索条件はあらかじめマーケティングプラットフォームの管理画面で作成しておく必要があります。
以下、手順です。
1.マーケティングプラットフォームの管理画面にログインします。
2.特定のキャンペーンのリードに対してメールを送信したい場合は、[キャンペーン]タブをクリックし、該3.当キャンペーンを探し、キャンペーンIDを控えておいてください。[管理開始]をクリックします
4.[リード]タブをクリックします。
5.[検索]欄もしくは[複合検索]リンクより対象のリードを絞り込み、[検索条件を保存(全ユーザ使用可)]を選択してください。
上記手順で作成された検索条件を取得するには、searchcondition.getを使用します。
取得したデータのIDを検索条件IDとして使用します。
一斉メール配信の登録
- 一斉メール配信を行うには、mailsender.post を使用します。
- MailTemplate の MailTemplateId にメールテンプレートIDを指定します。
- ReservationMailTypeで[送信ユーザ指定]を選択する場合は、VisitorDataList にリードIDを指定します。
- [検索条件指定]を選択する場合は、SearchCondition の SearchConditionId に検索条件IDを指定します。
- どちらを選んだ場合も最大送信可能数は、マーケティングプラットフォームにおけるシステム設定「メール最大送信可能数」に設定されている値ですので、対象者数が超えないように気を付けてください。
- mailsender.post の登録が完了するとHTTPレスポンスヘッダの Location にリソースURLが返ります。末尾のID(配信ID)を使用して、配信状況を確認することができます。
一斉メール配信状況の取得
1.一斉メール配信の配信状況を取得するには、mailsender.getを使用します。
2.対象の配信IDを検索し、配信状況を取得してください。
3.TotalCount が送信対象者の全体数で、SuccessCount が到達数、ErrorCount がエラー数です。
- 配信後にエラーメールとして返送されてきた場合は、到達数が減少し、エラー数が増加します。(TotalCount = SuccessCount + ErrorCount の関係です)
- クリック者、クリック率、総クリック数、開封率、開封者、未開封者、停止数、停止率は取得できません。
- クリック率、総クリック率については、clickcounturl.getIのMailReservedId にmailsender.get の Idを指定して検索してください。
- クリック者は、visitor.getClickcount の ClickCountUrlId に clickcounturl.get のId を指定して検索してください。
- 開封者については、visitor.getMail の MailSenderId に mailsender.get のIdを指定し、初回開封日時もしくは最新開封日で検索してください。
- 同じ時間帯に対して送信予約を複数回行うと、その時間帯の送信予約はできなくなります。
一斉メール配信の削除
1.一斉メール配信の削除を行うには、mailsender.deleteを使用します。
2.一斉メール配信を削除するには対象の配信IDを指定します。