DM個別送信履歴取得API

マーケティングプラットフォームのDM個別送信履歴を参照するためのAPIです。

メソッド名

visitor.getDirectmail

リクエスト情報

アクセスURL

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

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	○	○	DM個別送信履歴ID
DateRegist	○	○	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	○	○	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	○	○	宛先リードID
Name1	○	○	宛名：姓
Name2	○	○	宛名：名
OrderId	○	○	オーダーID
OrderName	○	○	オーダー名
OrderedDate	○	○	注文日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
PostedDate	○	○	発送日(JST) YYYY-mm-ddTHH:MM:SS+09:00
OrderRuleId	○	○	定期オーダーID
OrderRuleName	○	○	定期オーダー名
DmTemplateId	○	○	DMテンプレートID
DmTemplateName	○	○	DMテンプレート名
SeminarId	○	○	キャンペーンID
CompanyName	○	○	宛名：会社名
Division	○	○	宛名：部署
Position	○	○	宛名：役職
Zip1	○	○	宛名：郵便番号(3桁)
Zip2	○	○	宛名：郵便番号(4桁)
Prefecture	○	×	都道府県
Address1	○	○	宛名：住所項目1
Address2	○	○	宛名：住所項目2
Address3	○	○	宛名：住所項目3
Address4	○	○	宛名：住所項目4
Address5	○	○	宛名：住所項目5

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

なし

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Mail
★ データ型：MailType

カラム名	データ型	内容
Id	string	DM個別送信履歴ID
DateRegist	dateTime	登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
DateUpdate	dateTime	更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
VisitorId	string	宛先リードID
Name1	string	宛名：姓
Name2	string	宛名：名
OrderId	string	オーダーID
OrderName	string	オーダー名
DirectMailStatus	DirectMailStatusType	DirectMailStatusId:DirectMailStatusName 200:注文済み 300:発送済み 400:エラー 500:キャンセル済み
OrderedDate	dateTime	注文日時(JST) YYYY-mm-ddTHH:MM:SS+09:00
PostedDate	dateTime	発送日(JST) YYYY-mm-ddTHH:MM:SS+09:00
OrderRuleId	string	定期オーダーID
OrderRuleName	string	定期オーダー名
DmTemplateId	string	DMテンプレートID
DmTemplateName	string	DMテンプレート名
Seminar	SeminarRefType	キャンペーン SeminarId：SeminarName
CompanyName	string	宛名：会社名
Division	string	宛名：部署
Position	string	宛名：役職
Zip1	string	宛名：郵便番号(3桁)
Zip2	string	宛名：郵便番号(4桁)
Prefecture	PrefectureType	都道府県IDと都道府県名の対応表参照
Address1	string	宛名：住所項目1
Address2	string	宛名：住所項目2
Address3	string	宛名：住所項目3
Address4	string	宛名：住所項目4
Address5	string	宛名：住所項目5
QrValue1	string	宛名面QRコード値1
QrValue2	string	宛名面QRコード値2
QrValue3	string	宛名面QRコード値3
TextValue1	string	宛名面テキスト値1
TextValue2	string	宛名面テキスト値2
TextValue3	string	宛名面テキスト値3
TextValue4	string	宛名面テキスト値4
TextValue5	string	宛名面テキスト値5
TextValue6	string	宛名面テキスト値6
TextValue7	string	宛名面テキスト値7
TextValue8	string	宛名面テキスト値8
TextValue9	string	宛名面テキスト値9
TextValue10	string	宛名面テキスト値10
DesignQrValue1	string	デザイン面QRコード値1
DesignQrValue2	string	デザイン面QRコード値2
DesignQrValue3	string	デザイン面QRコード値3
DesignQrValue4	string	デザイン面QRコード値4
DesignQrValue5	string	デザイン面QRコード値5
DesignTextValue1	string	デザイン面テキスト値1
DesignTextValue2	string	デザイン面テキスト値2
DesignTextValue3	string	デザイン面テキスト値3
DesignTextValue4	string	デザイン面テキスト値4
DesignTextValue5	string	デザイン面テキスト値5
DesignTextValue6	string	デザイン面テキスト値6
DesignTextValue7	string	デザイン面テキスト値7
DesignTextValue8	string	デザイン面テキスト値8
DesignTextValue9	string	デザイン面テキスト値9
DesignTextValue10	string	デザイン面テキスト値10
DesignTextValue11	string	デザイン面テキスト値11
DesignTextValue12	string	デザイン面テキスト値12
DesignTextValue13	string	デザイン面テキスト値13
DesignTextValue14	string	デザイン面テキスト値14
DesignTextValue15	string	デザイン面テキスト値15
DesignTextValue16	string	デザイン面テキスト値16
DesignTextValue17	string	デザイン面テキスト値17
DesignTextValue18	string	デザイン面テキスト値18
DesignTextValue19	string	デザイン面テキスト値19
DesignTextValue20	string	デザイン面テキスト値20

XMLサンプル

リクエストXMLサンプル

なし

レスポンスXMLサンプル

<?xml version="1.0" encoding="UTF-8"?>
<VisitorDirectMailList xmlns="http://smartseminar.jp/" version="1.63">
    <VisitorDirectMail>
        <Division>ITソリューション事業部</Division>
        <DesignTextValue10>1357</DesignTextValue10>
        <DesignQrValue3>111</DesignQrValue3>
        <DesignQrValue5>111</DesignQrValue5>
        <DateRegist>2021-02-26T06:58:18+00:00</DateRegist>
        <VisitorId>349963</VisitorId>
        <OrderId>24</OrderId>
        <Position>部長</Position>
        <Prefecture>
            <PrefectureName>東京都</PrefectureName>
            <PrefectureId>10</PrefectureId>
        </Prefecture>
        <QrValue3>4567</QrValue3>
        <Address1>港区三田</Address1>
        <OrderName>テストオーダー</OrderName>
        <DateUpdate>2021-02-26T06:58:18+00:00</DateUpdate>
        <Name1>山田</Name1>
        <Zip1>123</Zip1>
        <DmTemplateName>テストテンプレート</DmTemplateName>
        <CompanyName>株式会社テスト</CompanyName>
        <Address3>三田43MTビル4F</Address3>
        <Address5>4番地</Address5>
        <Address2>1-2-3</Address2>
        <QrValue1>00007</QrValue1>
        <DesignQrValue2>111</DesignQrValue2>
        <QrValue2>123</QrValue2>
        <DesignTextValue20>123</DesignTextValue20>
        <Name2>太郎</Name2>
        <DesignQrValue1>111</DesignQrValue1>
        <OrderedDate>2021-02-26T06:58:23+00:00</OrderedDate>
        <Id>13979</Id>
        <Zip2>4567</Zip2>
        <Address4>北デスク</Address4>
        <DesignQrValue4>111</DesignQrValue4>
        <DmTemplateId>17</DmTemplateId>
    </VisitorDirectMail>
</VisitorDirectMailList>

制限事項

本APIはDM配信機能を有効化されている場合のみ、ご利用いただけます。