ニフクラAPI (ESS: GetDeliveryLog)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>ESS> API> GetDeliveryLog

GetDeliveryLog

処理概要

配信ログを取得します。

条件を指定すると、その条件に一致するログだけを抽出することができます。
条件は配信期間と配信結果です。
取得するログの件数や混雑状況によって、応答に時間がかかることがあります。

指定するパラメーター

パラメーター	型	説明	必須
StartDate	timestamp	取得対象の期間の開始時間使用可能文字: 年月日時分指定(UTC) yyyy-MM-ddTHH:mm 例）2017-12-13T00:00 ※現在より過去90日まで指定可能	○
EndDate	timestamp	取得対象の期間の終了時間使用可能文字: 年月日時分指定(UTC) yyyy-MM-ddTHH:mm 例）2017-12-13T23:59 ※StartDateから24時間未満であること	○
Status	integer	取得したいログのステータスを指定。指定がない場合は全ステータスのログを取得。値: 1 (sent) 2 (retry) 3 (faild)
MaxItems	integer	1ページごとの最大ID数 Default: 10000 使用可能文字: 最大値は10000
NextToken	string	ページ分けに使用するトークン

応答フィールド

フィールド (項目)	型	説明
GetDeliveryLogResponse	structure	ルート
␣GetDeliveryLogResult	structure	結果
␣␣LogCount	string	取得したログの件数
␣␣Log	string	以下のスペース区切りで記録された情報を、1宛先ごとのログの内容として出力します。配信日 / 配信時間 / 送信結果 / ステータスコード / トランザクションID / 送信元メールアドレス / 宛先メールアドレス / 付加情報 ※ステータスコードは、3桁の数字となります。 ※2xxから5xxまでは、SMTPプロトコルにおける応答コードとなります。 ※6xx以降の番号は、独自の応答コードです。 ※応答コードの詳細につきましては、ニフクラ ESSの応答コード一覧をご確認ください。
␣␣NextToken	string	改ページに使用するトークン
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	タイプ	HTTPステータスコード	説明
ValidationError	Sender	400	パラメーターが不正です。
InvalidParameterValue	Sender	400	無効な値または範囲外の値を入力パラメーターに指定しています。
MalformedInput	Sender	400	クエリ文字列に構文エラーが含まれています。

リクエストサンプル

    POST / HTTP/1.1
Authorization: NIFTY4-HMAC-SHA256 Credential=<Credential>/east-1/email/nifty4_request, SignedHeaders=host;x-nifty-date, Signature=<Signature>
Host: ess.api.nifcloud.com
X-Nifty-Date: 20170801T014336Z
Content-Length: 116

MaxItems=1&Status=1&EndDate=2017-07-20T23%3A59&Action=GetDeliveryLog&StartDate=2017-07-20T00%3A00&Version=2010-12-01N2014-05-28"

応答サンプル

    HTTP/1.1 200 OK
Date: Tue, 01 Aug 2017 01:43:37 GMT
Content-Type: text/xml
Content-Length: 757
Connection: close

<GetDeliveryLogResponse>
  <GetDeliveryLogResult>
    <LogCount>1</LogCount>
    <Log>2017-07-20 05:01:59 sent 250 0.08985009239041256 fromaddr@example.com toaddr@example.com 250_Message_received</Log>
    <NextToken>rO0ABXNyADljb20ubmlmdHkuY2xvdWQuZXNzLmFwaS5hY3Rpb24ucGFyYW0uRGVsaXZlcnlMb2dOZXh0VG9rZW5y+2b9GqGp5wIABUoACWxhc3RDb3VudEwAB2VuZERhdGV0ABJMamF2YS9sYW5nL1N0cmluZztMAAhtYXhJdGVtc3EAfgABTAAJc3RhcnREYXRlcQB+AAFMAAZzdGF0dXNxAH4AAXhwAAAAAAAAAAF0ABAyMDE3LTA3LTIwVDIzOjU5dAABMXQAEDIwMTctMDctMjBUMDA6MDB0AAEx</NextToken>
  </GetDeliveryLogResult>
  <ResponseMetadata>
    <RequestId>2481803a-d4f6-4461-a3a9-887e6efe0ff2</RequestId>
  </ResponseMetadata>
</GetDeliveryLogResponse>