SHANON MARKETING PLATFORM API GUIDE
  • APIの利用方法
    • APIの利用方法
    • 認証
    • APIコールとメソッドリファレンス
    • 検索
    • 登録・更新
  • クライアントアプリケーション認証
    • authentication.get
  • 画面ユーザ認証
    • authapi.login
    • authinfo.getToken
    • authinfo.getCheck
    • authinfo.logout
    • authapi.agencynavigation
    • authapi.agencynavigation.back
  • 管理者
    • admin.get
    • admin.post
    • admin.put
    • admin.delete
  • キャンペーン
    • seminar.get
    • seminar.post
    • seminar.put
    • seminar.delete
    • seminaritemsetting.get
    • seminar.getSession
    • seminar.postSession
    • seminar.putSession
    • seminar.deleteSession
    • sessionitemsetting.get
  • 担当者割当
    • admin.getAssinmentSeminar
    • admin.postAssinmentSeminar
    • admin.deleteAssinmentSeminar
  • アンケート
    • enquetetemplate.get
    • enquetetemplate.getQuestion
  • 講演者
    • speaker.get
    • speakersetting.get
  • 資料
    • document.get
  • リスト
    • staticlist.get
    • staticlist.post
    • staticlist.put
    • staticlist.delete
  • リスト・リード管理
    • staticlist.getVisitor
    • staticlist.postVisitor
    • staticlist.deleteVisitor
  • 企業
    • company.get
    • company.post
    • company.put
    • company.delete
  • 企業・リード管理
    • company.getVisitor
    • company.postVisitor
    • company.deleteVisitor
  • リード
    • visitor.get
    • visitor.post
    • visitor.put
    • visitor.delete
    • visitor.getFile
    • visitor.postFile
    • visitor.putFile
    • visitor.deleteFile
    • visitorsetting.get
  • 申込
    • application.post
    • application.delete
    • seminar.getDiscount
    • visitor.getDiscounthistory
    • visitor.getBilling
    • visitor.getApplication
    • visitor.putApplication
    • counting.getApplication
  • キャンペーン申込情報
    • visitor.getApplicationSeminar
    • visitor.getApplicationSession
  • 申込フロー
    • seminar.getFlow
  • 来場
    • visitor.getAttendance
    • visitor.getAttendanceSeminar
    • visitor.postAttendanceSeminar
    • visitor.deleteAttendanceSeminar
    • visitor.getAttendanceSession
    • visitor.postAttendanceSession
    • visitor.deleteAttendanceSession
    • counting.getAttendance
  • メール送信
    • visitor.postMail
    • 一斉メール送信APIの利用方法
    • mailtemplate.get
    • mailtemplate.post
    • mailtemplate.put
    • mailtemplate.delete
    • mailsender.get
    • mailsender.post
    • mailsender.delete
  • クリックカウント
    • clickcounturl.get
  • トラッキング
    • trackingurl.get
  • メール履歴情報
    • visitor.getMail
  • アンケート履歴情報
    • visitor.getEnquete
    • enquetehistory.get
  • クリックカウント履歴情報
    • visitor.getClickcount
  • トラッキング履歴情報
    • visitor.getTrackingaccesslog
    • visitor.getTrackingsession
  • 資料履歴情報
    • visitor.getDocumentdownload
  • 活動履歴情報
    • visitor.getActivity
    • visitor.postActivity
    • visitor.putActivity
    • visitor.deleteActivity
    • activitysetting.get
  • リード変更履歴情報
    • visitor.getChangelog
    • visitor.getAddlog
    • visitor.getDeletelog
    • visitor.getMergelog
  • DM個別送信履歴情報
    • visitor.getDirectMail
  • キャンペーン設定
    • seminarsettingdata.get
    • seminarsettingdata.put
  • メッセージ
    • messagestr.get
    • messagestr.put
  • ファイル情報
    • file.get
    • file.post
  • 検索条件
    • searchcondition.get
  • バルクAPI
    • 概要
    • bulkapi.get
    • bulkapi.post
  • APPENDIX
    • APIメソッドリファレンス
    • 用語について
    • 共通エラーコード一覧
    • 都道府県IDと都道府県名の対応表
    • タイムゾーンIDとタイムゾーン名の対応表
    • 非推奨API
    • 改訂履歴
Home >> メール送信API概要

メール送信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として使用します。

一斉メール配信の登録

  1. 一斉メール配信を行うには、mailsender.post を使用します。
  2. MailTemplate の MailTemplateId にメールテンプレートIDを指定します。
  3. ReservationMailTypeで[送信ユーザ指定]を選択する場合は、VisitorDataList にリードIDを指定します。
  4. [検索条件指定]を選択する場合は、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を指定します。